Difference between revisions of "GetPlayerMapPatch"

From Dragon Age Toolset Wiki
Jump to: navigation, search
m (1 revision: re-import with default parameter value parameters set)
(remove tag)
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Generated with errors}}
 
 
{{dafunction
 
{{dafunction
 
|name=GetPlayerMapPatch
 
|name=GetPlayerMapPatch
Line 16: Line 15:
 
|param3default=0
 
|param3default=0
 
|returntype=object
 
|returntype=object
|returndesc=
+
|returndesc=the Nth player map patch
 
|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 patches and states for each area.
+
Each player has a list of map patches and states for each area. This function looks up the Nth object ID of a map patch tag for a particular player. Note that the patch could be from any of the currently loaded areas.
This function looks up the Nth object ID of a map patch tag for a
+
particular player. Note that the patch could be from any of the
+
currently loaded areas.
+
  
 
<!-- == Remarks == -->
 
<!-- == Remarks == -->

Latest revision as of 22:20, 26 February 2010

Gets the object ID of the Nth player map patch

object GetPlayerMapPatch(
object pPlayer,
string sTag,
int nNth = 0
);
Parameters:
pPlayer
Object ID of player
sTag
Tag string to search for
nNth
Integer ordinal of object
Returns:

the Nth player map patch

Source:

script.ldf

Description

Each player has a list of map patches and states for each area. This function looks up the Nth object ID of a map patch tag for a particular player. Note that the patch could be from any of the currently loaded areas.


See also

GetMapPatchState, SetMapPatchState