GetLocalLocation(object, string)
Get the data describing a location stored on an object.
location GetLocalLocation( object oObject, string sVarName );
Parameters
oObject
The object that stores the location.
sVarName
The variable name of the data.
Description
Returns data contained in 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 world already. This function must be used in conjunction with its counterpart function SetLocalLocation, as this is the main way to adjust the values held in the variable sVarName. There is no error value for this function.
Remarks
Because the function has no error value, it is possible that it will crash the game under some conditions.
Version
1.22
Example
// This will send the PC to the location stored in "Data" void main() { location a = GetLocalLocation(OBJECT_SELF,"Data"); AssignCommand(GetFirstPC(),ActionMoveToLocation(a,TRUE)); }
See Also
functions: | SetLocalLocation |
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.