Difference between revisions of "GetPlayerMapPatch"

From Dragon Age Toolset Wiki
Jump to: navigation, search
(Generated by Sunjammer's Dragon Age Script Paser)
(remove tag)
Line 16: Line 16:
 
|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 23:
 
== 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 == -->

Revision as of 22:20, 26 February 2010

This page was generated by Sunjammer's Dragon Age Script Parser.

The parser was unable to extract and/or match all the information required and has flagged this page as containing one or more errors. The source file was not formatted correctly and the information presented is incomplete or incorrect.

This page must be reviewed by a knowledgeable scripter as it will need to be updated. Once identified, the issue in the source file should be reported to BioWare.

Please remove the {{Generated with errors}} tag once the page has been corrected.

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