Difference between revisions of "Script/World"

From SF3
Jump to: navigation, search
(class World)
Line 4: Line 4:
 
=== Class Methods ===
 
=== Class Methods ===
 
{| border='0' style ='border:solid 1px #eeeedd; color: black; width: 1200px;background-color: #ffffcc;' cellspacing='0' cellpadding='7'
 
{| border='0' style ='border:solid 1px #eeeedd; color: black; width: 1200px;background-color: #ffffcc;' cellspacing='0' cellpadding='7'
 +
|-
 +
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|bool]]
 +
| style='color: black; width: 90%; line-height: 1.0;' | '''IsMapAccessible''' (const [[../BasicDataTypes|uint]] ''_uMapId'') const
 +
|-
 +
|
 +
| style = 'color: #505050; line-height: 0.5;' |''is the given level currently accessible?''
 +
|-
 +
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]]
 +
| style='color: black; width: 90%; line-height: 1.0;' | '''SetMapAccessible''' (const [[../BasicDataTypes|uint]] ''_uMapId'', const [[../BasicDataTypes|bool]] ''_bAccessible'' = true, const [[../BasicDataTypes|uint8]] ''_uSetting'' = - 1)
 +
|-
 +
|
 +
| style = 'color: #505050; line-height: 0.5;' |''set whether the given map is accessible by the player from the world map.''
 +
|-
 +
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|uint8]]
 +
| style='color: black; width: 90%; line-height: 1.0;' | '''GetCurrentMapSetting''' (const [[../BasicDataTypes|uint]] ''_uMapId'') const
 +
|-
 +
|
 +
| style = 'color: #505050; line-height: 0.5;' |''get the current setting for the given map''
 +
|-
 +
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]]
 +
| style='color: black; width: 90%; line-height: 1.0;' | '''SetMapSetting''' (const [[../BasicDataTypes|uint]] ''_uMapId'', const [[../BasicDataTypes|uint8]] ''_uSetting'')
 +
|-
 +
|
 +
| style = 'color: #505050; line-height: 0.5;' |''set the active setting for the given map. the setting change will only take effect the next time the level is visited.''
 +
|-
 +
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]]
 +
| style='color: black; width: 90%; line-height: 1.0;' | '''GoToMap''' (const [[../BasicDataTypes|uint]] ''_uMapId'', const [[../BasicDataTypes|uint8]] ''_uSetting'' = - 1)
 +
|-
 +
|
 +
| style = 'color: #505050; line-height: 0.5;' |''go to the given map in the given setting (or current setting, if not specified)''
 
|-
 
|-
 
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]]  
 
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]]  

Revision as of 11:11, 7 November 2016

class World

The main interface for interacting with the global game state, persistent across all levels.

Class Methods

bool IsMapAccessible (const uint _uMapId) const
is the given level currently accessible?
void SetMapAccessible (const uint _uMapId, const bool _bAccessible = true, const uint8 _uSetting = - 1)
set whether the given map is accessible by the player from the world map.
uint8 GetCurrentMapSetting (const uint _uMapId) const
get the current setting for the given map
void SetMapSetting (const uint _uMapId, const uint8 _uSetting)
set the active setting for the given map. the setting change will only take effect the next time the level is visited.
void GoToMap (const uint _uMapId, const uint8 _uSetting = - 1)
go to the given map in the given setting (or current setting, if not specified)
void EnableDialogueTopic (const string&in _sContainerName, const string&in _sTopicName, const bool _bEnabled)
get the random number generator
void BlockDialogueTopicNode (const string&in _sContainerName, const string&in _sNodeName)
disable a dialogue topic node
void UnblockDialogueTopicNode (const string&in _sContainerName, const string&in _sNodeName)
enable a dialogue topic node
bool GetGlobalBool (const string&in _sVarName, const bool _bDefault = false) const
get global variable of type bool
int GetGlobalInt (const string&in _sVarName, const int _iDefault = - 1) const
get global variable of type integer
void SetGlobalBool (const string&in _sVarName, const bool _bValue)
set global variable of type bool
void SetGlobalInt (const string&in _sVarName, const int _iValue)
set global variable of type integer