Difference between revisions of "GetLocalPlayer"
(Generated by Sunjammer's Dragon Age Script Paser) |
(No difference)
|
Revision as of 02:40, 29 July 2009
This page was generated by Sunjammer's Dragon Age Script Parser.
The parser was able to extract and/or match all the information required, however it has flagged this page as containing one or more joins. A join occurs when the parser encounters a single line entry (such as parameter descriptions or remarks) which has been split over multiple lines. The parser joins these lines together to prevent the information being omitted, however any original formatting will have been lost.
This page must be reviewed by a knowledgeable scripter as it will probably require updating. If the join occurred in a parameter description it will probably be necessary to move the additional information to the Description section below. Once identified, the issue in the source file should be reported to BioWare.
Please remove the {{Generated with joins}} tag once the page has been corrected.
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
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.