Difference between revisions of "GetMapPatchState"
From Dragon Age Toolset Wiki
BryanDerksen (Talk | contribs) m (1 revision: Importing auto-generated function articles) |
m (Changing category) |
||
| Line 1: | Line 1: | ||
| − | |||
{{dafunction | {{dafunction | ||
|name=GetMapPatchState | |name=GetMapPatchState | ||
| Line 7: | Line 6: | ||
|param1desc=Object ID of patch to control | |param1desc=Object ID of patch to control | ||
|returntype=int | |returntype=int | ||
| − | |returndesc= | + | |returndesc=The current state of a map patch |
|sourcefile=script.ldf | |sourcefile=script.ldf | ||
|sourcemodule= | |sourcemodule= | ||
| Line 14: | Line 13: | ||
== 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. --> | ||
| − | Map patches with a state of -1 are "invisible" to the client. Any | + | Map patches with a state of -1 are "invisible" to the client. Any other setting 0-N will make the patch appear on the client's map. |
| − | other setting 0-N will make the patch appear on the client's map. | + | If the action ID for the state is not -1, the patch is clickable, and the action ID will be sent to server whenever client clicks on the patch. |
| − | If the action ID for the state is not -1, the patch is clickable, | + | |
| − | and the action ID will be sent to server whenever client clicks | + | |
| − | on the patch. | + | |
| − | + | ||
<!-- == Remarks == --> | <!-- == Remarks == --> | ||
<!-- This section contains additional comments, observations and known issues. --> | <!-- This section contains additional comments, observations and known issues. --> | ||
| − | |||
<!-- == 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. --> | ||
[[SetMapPatchState]], [[GetPlayerMapPatch]] | [[SetMapPatchState]], [[GetPlayerMapPatch]] | ||
| − | [[Category: | + | [[Category:Broken functions]] |
Latest revision as of 23:45, 5 August 2014
Gets the current state of a map patch
- Parameters:
- oMapPatch
- Object ID of patch to control
- Returns:
- The current state of a map patch
- Source:
- script.ldf
Description
Map patches with a state of -1 are "invisible" to the client. Any other setting 0-N will make the patch appear on the client's map. If the action ID for the state is not -1, the patch is clickable, and the action ID will be sent to server whenever client clicks on the patch.
