Difference between revisions of "SetWorldMapGuiStatus"

From Dragon Age Toolset Wiki
Jump to: navigation, search
m (1 revision: Importing auto-generated function articles)
(tidy)
Line 5: Line 5:
 
|param1type=int
 
|param1type=int
 
|param1name=nStatus
 
|param1name=nStatus
|param1desc=WM_GUI_STATUS_NO_USE = 0 (unavailable from area map) - WM_GUI_STATUS_READ_ONLY = 1 (available from area map, cannot travel) - WM_GUI_STATUS_USE = 2 (available from area map, click pin to travel)
+
|param1desc= A [[WM_GUI_STATUS*]] constant
 
|returntype=void
 
|returntype=void
 
|returndesc=
 
|returndesc=
Line 12: Line 12:
 
}}
 
}}
  
<!-- == 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. -->
 +
 +
Status constants you can use:
 +
 +
*WM_GUI_STATUS_NO_USE = 0 (unavailable from area map)
 +
*WM_GUI_STATUS_READ_ONLY = 1 (available from area map, cannot travel)
 +
*WM_GUI_STATUS_USE = 2 (available from area map, click pin to travel)
  
 
<!-- == Remarks == -->
 
<!-- == Remarks == -->

Revision as of 22:19, 9 February 2010

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.

Enable / disable access to the world map.

void SetWorldMapGuiStatus(
int nStatus
);
Parameters:
nStatus
A WM_GUI_STATUS* constant
Returns:

Nothing.

Source:

script.ldf

Description

Status constants you can use:

  • WM_GUI_STATUS_NO_USE = 0 (unavailable from area map)
  • WM_GUI_STATUS_READ_ONLY = 1 (available from area map, cannot travel)
  • WM_GUI_STATUS_USE = 2 (available from area map, click pin to travel)