GetLocalPlayer

Gets a local player variable on an object.

player GetLocalPlayer(
object oObject,
string sVarName
);

Parameters:

oObject

Object to get the variable from

sVarName

The name of the variable to retrieve

Returns:

Returns the player variable, returns an invalid player on error.

Source:

script.ldf

Description

Gets a local player variable sVarName on the specified object.

Remarks

All local variables must be predefined in the target object's variables 2da file before this function can be used successfully. If a local variable is not predefined this function will fail silently.

It is very important to note that a player is not a reference to a specific player, but rather is a reference to a player slot (player1, player2, player3... etc) so the values will not necessarily refer to the same players across a save/load.

See also

SetLocalPlayer