GameRules_GetPropString Function

Gets a gamerules property as a string.

int GameRules_GetPropString(const char[] prop, char[] buffer, int maxlen, int element)

Parameters

const char[] prop

Property to use.

char[] buffer

Destination string buffer.

int maxlen

Maximum length of output string buffer.

int element

Element # (starting from 0) if property is an array.

Return Value

Number of non-null bytes written.

Errors

Prop type is not a string, or lack of mod support.