Difference between revisions of "GetLocalPlayer"
From Dragon Age Toolset Wiki
(Generated by Sunjammer's Dragon Age Script Paser) |
m |
||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | |||
{{dafunction | {{dafunction | ||
|name=GetLocalPlayer | |name=GetLocalPlayer | ||
| Line 17: | Line 16: | ||
== 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. --> | ||
| − | Gets a local player variable sVarName on the specified | + | Gets 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. --> | ||
| − | 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) | + | 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. | ||
<!-- == 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. --> | ||
[[SetLocalPlayer]] | [[SetLocalPlayer]] | ||
[[Category: Variable functions]] | [[Category: Variable functions]] | ||
Latest revision as of 04:55, 1 August 2009
Gets a local player variable on an object.
- 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.
