Difference between revisions of "GetPlayerMapPin"
From Dragon Age Toolset Wiki
(Generated by Sunjammer's Dragon Age Script Paser) |
BryanDerksen (Talk | contribs) m (add returndesc, remove tag) |
||
Line 1: | Line 1: | ||
− | |||
{{dafunction | {{dafunction | ||
|name=GetPlayerMapPin | |name=GetPlayerMapPin | ||
Line 16: | Line 15: | ||
|param3default=0 | |param3default=0 | ||
|returntype=object | |returntype=object | ||
− | |returndesc= | + | |returndesc=the Nth player map Pin |
|sourcefile=script.ldf | |sourcefile=script.ldf | ||
|sourcemodule= | |sourcemodule= | ||
Line 23: | Line 22: | ||
== 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. --> | ||
− | Each player has a list of map pins and states for each area. | + | Each player has a list of map pins and states for each area. This function looks up the Nth object ID of a map pin tag for a particular player. Note that the pin could be from any of the currently loaded areas. |
− | This function looks up the Nth object ID of a map pin tag for a | + | |
− | particular player. Note that the pin could be from any of the | + | |
− | currently loaded areas. | + | |
<!-- == Remarks == --> | <!-- == Remarks == --> |
Latest revision as of 00:18, 20 February 2010
Gets the object ID of the Nth player map Pin
- Parameters:
- pPlayer
- Object ID of player
- sTag
- Tag string to search for
- nNth
- Integer ordinal of object
- Returns:
- the Nth player map Pin
- Source:
- script.ldf
Description
Each player has a list of map pins and states for each area. This function looks up the Nth object ID of a map pin tag for a particular player. Note that the pin could be from any of the currently loaded areas.