Difference between revisions of "SetLocalPlayer"
From Dragon Age Toolset Wiki
BryanDerksen (Talk | contribs) m (1 revision: Importing auto-generated function articles) |
m (note on predefining) |
||
| Line 1: | Line 1: | ||
| − | |||
{{dafunction | {{dafunction | ||
|name=SetLocalPlayer | |name=SetLocalPlayer | ||
| Line 20: | Line 19: | ||
== Description == | == Description == | ||
<!-- This section contains the full description from the functions comments. Do not change unless you are confident these are incomplete or incorrect. --> | <!-- This section contains the full description from the functions comments. Do not change unless you are confident these are incomplete or incorrect. --> | ||
| − | Sets a local player variable sVarName on the specified | + | Sets a local player variable sVarName on the specified object. |
| − | object. | + | |
== Remarks == | == Remarks == | ||
<!-- This section contains additional comments, observations and known issues. --> | <!-- This section contains additional comments, observations and known issues. --> | ||
| + | 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. | 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. | ||
<!-- == Examples == --> | <!-- == Examples == --> | ||
<!-- This section contains examples transcluded from the snippet library. --> | <!-- This section contains examples transcluded from the snippet library. --> | ||
| − | |||
== See also == | == See also == | ||
<!-- This section contains links to articles, functions or constant groups. --> | <!-- This section contains links to articles, functions or constant groups. --> | ||
[[GetLocalPlayer]] | [[GetLocalPlayer]] | ||
[[Category: Variable functions]] | [[Category: Variable functions]] | ||
Revision as of 06:03, 1 August 2009
Sets a local player variable on an object.
- 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.
