GetLocalString(object, string)

Get the value of a string of characters stored on an object.

string GetLocalString(
    object oObject,
    string sVarName
);

Parameters

oObject

The object that stores the string of characters.

sVarName

The variable name of the data.


Description

Returns data contained inside the variable sVarName stored on the object oObject. oObject can be any object in the game world. The string describing the variable can also be any string in theory but it is suggested that you avoid using the NW_* tags as they tend to be used within the game already. This function must be used in conjunction with its counterpart function SetLocalString, as this is the main way to adjust the values held in the variable sVarName. On error the function will return .



Version

1.22

Example

// Will return the string stored in "Data"
void main()
{
    string a = GetLocalString(OBJECT_SELF,"Data");
    SendMessageToPC(GetFirstPC(),a);
}

See Also

functions: GetLocalArrayString | SetLocalString
categories: Get Data Functions | Get Data from Creature Functions | Get Data from Object Functions | Local Variables Functions


 author: GoLeM, editor: Kristian Markon
 Send comments on this topic.