View source for Script/World

==class World==
The main interface for interacting with the global game state, persistent across all levels.
  
=== Class Methods ===
==== World Map / Travel ====
{| 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;' | '''IsTravelAllowed''' () const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''is travelling (leaving the level/fast travelling) currently allowed?''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''AllowTravel''' (const [[../BasicDataTypes|bool]] ''_bAllow'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''set whether the player is allowed to leave the current level or fast travel within it.''
|-
| 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|bool]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''IsRaceSelectionAllowed''' (const [[../BasicDataTypes|uint]] ''_uMapId'') const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''is the player allowed to choose an RTS race to control upon entering this map?''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''SetRaceSelectionAllowed''' (const [[../BasicDataTypes|uint]] ''_uMapId'', const [[../BasicDataTypes|bool]] ''_bAllow'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''set whether the player is allowed to choose an RTS race to control upon entering the map.''
|-
| 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'' = uint8 ( - 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;' | '''SetMapEntryPoint''' (const [[../BasicDataTypes|uint]] ''_uMapId'', const [[../BasicDataTypes|string]]&in ''_sEntryPoint'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''set the entry point for _uMapId. will be used when the player travels to the map the next time.''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''TravelToMap''' (const [[../BasicDataTypes|uint]] ''_uMapId'', const [[../BasicDataTypes|uint8]] ''_uSetting'' = uint8 ( - 1 ), const [[../BasicDataTypes|string]]&in ''_sEntryPoint'' = "")
|-
|
| style = 'color: #505050; line-height: 0.5;' |''go to the given map in the given setting (or current setting, if not specified)''
|}

==== Blueprints ====
{| 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;' | '''IsBlueprintUnlocked''' (const [[../BasicDataTypes|string]]&in ''_sBlueprintName'') const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''is the given blueprint currently unlocked?''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''UnlockBlueprint''' (const [[../BasicDataTypes|string]]&in ''_sBlueprintName'', const [[../BasicDataTypes|bool]] ''_bTemporary'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''unlock the blueprint of this name for the player (if _bTemporary is true, the blueprint will be re-locked as soon as the player leaves the current level)''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|bool]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''IsBlueprintUpgradeUnlocked''' (const [[../BasicDataTypes|string]]&in ''_sBlueprintName'', const [[../BasicDataTypes|string]]&in ''_sUpgradeName'') const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''is the given upgrade for the given blueprint currently unlocked?''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''UnlockBlueprintUpgrade''' (const [[../BasicDataTypes|string]]&in ''_sBlueprintName'', const [[../BasicDataTypes|string]]&in ''_sUpgradeName'', const [[../BasicDataTypes|bool]] ''_bTemporary'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''unlock the given blueprint upgrade (if _bTemporary is true, the upgrade will be re-locked as soon as the player leaves the current level)''
|}

==== Glossary ====
{| 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|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''UnlockGlossaryEntry''' (const [[../BasicDataTypes|string]]&in ''_sTechnicalName'', const [[../BasicDataTypes|uint]] ''_uStage'' = 0)
|-
|
| style = 'color: #505050; line-height: 0.5;' |''unlock the given glossary entry (if the entry has multiple stages, 0 unlocks the basic entry with the first paragraph, 1 the second, and so on)''
|}

==== Dialogues ====
{| 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|string[]@]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''GetEnabledTopics''' (const [[../BasicDataTypes|string]]&in ''_sContainerName'') const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''get all currently enabled topics within the given container.''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|string[]@]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''GetValidTopics''' (const [[../BasicDataTypes|string]]&in ''_sContainerName'') const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''get all topics in the given container which are enabled and can be initiated at this very moment (checks script conditions, required participants, range, etc.).''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 0.8;' | '''EnableDialogueTopic''' (const [[../BasicDataTypes|string]]&in ''_sContainerName'', const [[../BasicDataTypes|string]]&in ''_sTopicName'', const [[../BasicDataTypes|bool]] ''_bEnabled'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''enable or disable the given dialogue topic''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|bool]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''IsDialogueTopicEnabled''' (const [[../BasicDataTypes|string]]&in ''_sContainerName'', const [[../BasicDataTypes|string]]&in ''_sTopicName'') const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''is the given dialogue topic currently enabled?''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 0.8;' | '''BlockDialogueTopicNode''' (const [[../BasicDataTypes|string]]&in ''_sContainerName'', const [[../BasicDataTypes|string]]&in ''_sNodeName'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''disable a dialogue topic node''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 0.8;' | '''UnblockDialogueTopicNode''' (const [[../BasicDataTypes|string]]&in ''_sContainerName'', const [[../BasicDataTypes|string]]&in ''_sNodeName'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''enable a dialogue topic node''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''SetDialogueTopicImportant''' (const [[../BasicDataTypes|string]]&in ''_sContainerName'', const [[../BasicDataTypes|string]]&in ''_sTopicName'', const [[../BasicDataTypes|bool]] ''_bImportant'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''set whether the given dialogue topic is considered important''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|bool]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''IsDialogueTopicImportant''' (const [[../BasicDataTypes|string]]&in ''_sContainerName'', const [[../BasicDataTypes|string]]&in ''_sTopicName'') const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''is the given dialogue topic important?''
|-
|}

==== Global Variables ====
{| 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;' | '''GetGlobalBool''' (const [[../BasicDataTypes|string]]&in ''_sVarName'', const [[../BasicDataTypes|bool]] ''_bDefault'' = false) const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''get global variable of type bool''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|int]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''GetGlobalInt''' (const [[../BasicDataTypes|string]]&in ''_sVarName'', const [[../BasicDataTypes|int]] ''_iDefault'' = - 1) const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''get global variable of type integer''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''SetGlobalBool''' (const [[../BasicDataTypes|string]]&in ''_sVarName'', const [[../BasicDataTypes|bool]] ''_bValue'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''set global variable of type bool''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''SetGlobalInt''' (const [[../BasicDataTypes|string]]&in ''_sVarName'', const [[../BasicDataTypes|int]] ''_iValue'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''set global variable of type integer''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''RemoveGlobalVar''' (const [[../BasicDataTypes|string]]&in ''_sVarName'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''remove the given global variable''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../string|string[]@]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''GetGlobalVarNamesInCategory''' (const [[../BasicDataTypes|string]]&in ''_sCategoryName'', const [[../BasicDataTypes|bool]] ''_bFullVarNames'' = true) const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''get a list of all variable names in the given category. if _bFullVarNames is false, the returned names will not contain the "_sCategoryName." prefix.''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../dictionary|dictionary@]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''GetGlobalVarsInCategory''' (const [[../BasicDataTypes|string]]&in ''_sCategoryName'', const [[../BasicDataTypes|bool]] ''_bFullVarNames'' = true) const
|-
|
| style = 'color: #505050; line-height: 1.0;' |''get a dictionary mapping all variable names in the given category to their respective values (all represented as integers).
if _bFullVarNames is false, the key names will not contain the "_sCategoryName." prefix.''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''ClearGlobalVarCategory''' (const [[../BasicDataTypes|string]]&in ''_sCategoryName'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''remove all global variables in the given category''
|}

==== Creature Drop Lists ====
{| 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|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''AddItemToCreatureDrops''' (const [[../BasicDataTypes|string]]&in ''_sCreatureDescriptionName'', const [[../BasicDataTypes|string]]&in ''_sItemName'', const [[../BasicDataTypes|uint]] ''_uAmount'', const [[../BasicDataTypes|uint8]] ''_uPercentChance'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''add a chance to drop the given item to any creature with the given description name''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''RemoveItemFromCreatureDrops''' (const [[../BasicDataTypes|string]]&in ''_sCreatureDescriptionName'', const [[../BasicDataTypes|string]]&in ''_sItemName'', const [[../BasicDataTypes|uint]] ''_uAmount'', const [[../BasicDataTypes|uint8]] ''_uPercentChance'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''remove a specific previously added entry from the given creature's list of drops''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''RemoveItemFromCreatureDrops''' (const [[../BasicDataTypes|string]]&in ''_sCreatureDescriptionName'', const [[../BasicDataTypes|string]]&in ''_sItemName'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''remove any previously added entry with the given item from the given creature's list of drops''
|}