SetLocalPlayer

Sets a local player variable on an object.

void SetLocalPlayer(
object oObject,
string sVarName,
player pPlayer
);

Parameters:

oObject

Object to set the variable on

sVarName

The name of the variable to set

pPlayer

The value of the player variable

Returns:

Nothing.

Source:

script.ldf

Description

Sets 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.

NOTE! This type of local variable is not saved/loaded via the save system. So, if a community member or designer wants to save information like this for use later, and someone saves/loads the game, that information is lost forever. Thus, using them outside of situations where you can guarantee no save/load occurs (i.e. during combat) is pretty much guaranteed to fail for some enduser. Furthermore, if you use these variable types in the var_ 2DAs, it will fail gloriously.

Don’t use this function. It will in all likelihood be removed in a future patch.

See also

GetLocalPlayer