View source for Script/LevelReference

==class LevelReference==
The main interface for interacting with the level the player is currently in.
  
=== Class Methods ===
==== Getters ====
Functions allowing access to basic objects.<br/>
'''ATTENTION''': In general, all functions prefixed with ''Find'' are computationally expensive and should be used sparingly.
{| 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|uint]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''GetCurrentTick''' () const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''get the current tick''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|uint]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''GetMapId''' () const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''get the map index of the current level''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../World|World@]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''GetWorld''' ()
|-
|
| style = 'color: #505050; line-height: 0.5;' |''get world''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../Random|Random@]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''GetRandom''' ()
|-
|
| style = 'color: #505050; line-height: 0.5;' |''get the random number generator''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../HeroParty|HeroParty@]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''GetHeroParty''' (const [[../BasicDataTypes|uint8]] ''_uFaction'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''get the hero party for the given faction''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../QuestJournal|QuestJournal@]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''GetJournal''' (const [[../BasicDataTypes|uint8]] ''_uFaction'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''get the player's quest journal''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|uint]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''GetNumberOfSectors''' () const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''get number of sectors in the level''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../Sector|Sector@]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''GetSectorByName''' (const [[../BasicDataTypes|string]]&in ''_sName'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''get sector script class by name''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../Sector|Sector@]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''GetSectorByIndex''' (const [[../BasicDataTypes|uint]] ''_uIndex'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''get sector script class by index''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../Sector|Sector@[]@]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''GetSectorsByOwner''' (const [[../BasicDataTypes|uint8]] ''_uFaction'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''get all sectors owned by the given faction''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../Building|Building]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''GetFactionCapitol''' (const [[../BasicDataTypes|uint8]] ''_uFaction'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''get the capitol building of the given faction (may return an invalid building if they don't currently have a capitol)''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../Building|Building]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''GetBuildingByName''' (const [[../BasicDataTypes|string]]&in ''_sName'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''get building by name''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../Building|Building]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''GetBuildingById''' (const [[../BasicDataTypes|uint]] ''_uId'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''get building by id''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../Creature|Creature]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''GetCreatureByName''' (const [[../BasicDataTypes|string]]&in ''_sName'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''get creature by name''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../Creature|Creature]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''GetCreatureById''' (const [[../BasicDataTypes|uint]] ''_uId'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''get creature by id''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../LogicObject|LogicObject]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''GetLogicObjectByName''' (const [[../BasicDataTypes|string]]&in ''_sName'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''get logic object by name''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../LogicObject|LogicObject]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''GetLogicObjectById''' (const [[../BasicDataTypes|uint]] ''_uId'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''get logic object by id''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../ResourceDeposit|ResourceDeposit]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''GetResourceDepositByName''' (const [[../BasicDataTypes|string]]&in ''_sName'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''get resource deposit by name''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../ResourceDeposit|ResourceDeposit]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''GetResourceDepositById''' (const [[../BasicDataTypes|uint]] ''_uId'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''get resource deposit by id''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../Entity|Entity]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''GetEntityById''' (const [[../BasicDataTypes|uint]] ''_uId'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''get any entity (creature, building, etc.) by its id''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../Entity|Entity[]@]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''GetEntitiesByName''' (const [[../BasicDataTypes|string]]&in ''_sName'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''get any entities with the given name. will return at most one entity of each type, as names must be unique within each entity type.''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|string]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''FindEntityName''' (const [[../Entity|Entity]]&in ''_Entity'') const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''find the script name for the given entity. returns an empty string if the entity has not been registered for script access.''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../Building|Building[]@]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''FindBuildingsByDescription''' (const [[../BasicDataTypes|uint8]] ''_uFaction'', const [[../BasicDataTypes|string]]&in ''_sDescriptionName'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''find all buildings with the given description currently owned by the given faction.''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../Building|Building[]@]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''FindBuildingsByType''' (const [[../BasicDataTypes|uint8]] ''_uFaction'', const [[../BasicDataTypes|EBuildingType]] ''_Type'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''find all buildings of the given type currently owned by the given faction.''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../Creature|Creature[]@]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''FindCreaturesByDescription''' (const [[../BasicDataTypes|uint8]] ''_uFaction'', const [[../BasicDataTypes|string]]&in ''_sDescriptionName'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''find all creatures with the given description currently owned by the given faction.''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../Creature|Creature[]@]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''FindCreaturesByType''' (const [[../BasicDataTypes|uint8]] ''_uFaction'', const [[../BasicDataTypes|ECreatureType]] ''_Type'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''find all creatures of the given type currently owned by the given faction.''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../Creature|Creature[]@]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''FindCreaturesByFaction''' (const [[../BasicDataTypes|uint8]] ''_Faction'', const [[../BasicDataTypes|bool]] ''_bControllableOnly'' = true)
|-
|
| style = 'color: #505050; line-height: 0.5;' |''get all creatures controlled by the given faction (if _bControllableOnly is false, non controllable creatures like workers and dead creatures will be excluded)''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../Creature|Creature[]@]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''GetCreaturesFromSpawn''' (const [[../BasicDataTypes|string]]&in ''_sSpawnName'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''get all creatures spawned by the given spawn (does not include dead creatures!)''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../Entity|Entity[]@]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''GetEntitiesInGroup''' (const [[../BasicDataTypes|string]]&in ''_sName'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''get all logic entities (creatures, buildings, logic objects, etc.) in the given group''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|bool]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''CheckItemProperty''' (const [[../BasicDataTypes|string]]&in ''_sItemName'', const [[../LogicEnums#EItemProperty|EItemProperty]] ''_Property'') const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''check whether the given item property applies to the given item''
|-
|}

==== Event Registration ====
Functions for registering event listener callbacks.
{| 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;' | '''RegisterHeroPartyEvent''' (const [[../LogicEnums#EHeroPartyEvent|EHeroPartyEvent]] ''_EventType'', [[../LogicCallbacks|TOnHeroPartyEvent@]] ''_pFunction'', const [[../BasicDataTypes|string]]&in ''_sTargetName'', const [[../BasicDataTypes|uint8]] ''_Faction'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''register an event concerning the hero party''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''RegisterInventoryEvent''' (const [[../LogicEnums#EInventoryEvent|EInventoryEvent]] ''_EventType'', [[../LogicCallbacks|TOnInventoryEvent@]] ''_pFunction'', const [[../BasicDataTypes|string]]&in ''_sTargetName'', const [[../BasicDataTypes|uint8]] ''_Faction'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''register an event concerning the hero party's inventory''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''RegisterCreatureInventoryEvent''' (const [[../LogicEnums#ECreatureInventoryEvent|ECreatureInventoryEvent]] ''_EventType'', [[../LogicCallbacks|TOnCreatureInventoryEvent@]] ''_pFunction'', const [[../BasicDataTypes|string]]&in ''_sTargetName'', const [[../BasicDataTypes|uint8]] ''_Faction'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''register an event concerning the hero party's inventory specific to a creature''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''RegisterCreatureEventByDescription''' (const [[../LogicEnums#ECreatureEvent|ECreatureEvent]] ''_EventType'', [[../LogicCallbacks|TOnCreatureEvent@]] ''_pFunction'', const [[../BasicDataTypes|string]]&in ''_sDescriptionName'', const [[../BasicDataTypes|uint8]] ''_Faction'', const [[../BasicDataTypes|string]]&in ''_sParam'' = "")
|-
|
| style = 'color: #505050; line-height: 0.5;' |''register creature event by 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;' | '''RegisterCreatureEventByIndividual''' (const [[../LogicEnums#ECreatureEvent|ECreatureEvent]] ''_EventType'', [[../LogicCallbacks|TOnCreatureEvent@]] ''_pFunction'', const [[../BasicDataTypes|string]]&in ''_sCreatureName'', const [[../BasicDataTypes|string]]&in ''_sParam'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''register creature event by individual creature name (e.g. name of the creature placed in the level editor OR unique hero name). 
Please note, that this event can't be used, when the individual doesn't exist at the beginning of the map (for example when the creature spawns later). ''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''RegisterCreatureEventByIndividuals''' (const [[../LogicEnums#ECreatureEvent|ECreatureEvent]] ''_EventType'', [[../LogicCallbacks|TOnCreatureEvent@]] ''_pFunction'', const [[../Creature|Creature[]]]&in ''_Creatures'', const [[../BasicDataTypes|bool]] ''_bAnyCreature'' = false, const [[../BasicDataTypes|string]]&in ''_sParam'' = "")
|-
|
| style = 'color: #505050; line-height: 0.5;' |''register creature event by individual creature(s)''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''RegisterBuildingEventByDescription''' (const [[../LogicEnums#EBuildingEvent|EBuildingEvent]] ''_EventType'', [[../LogicCallbacks|TOnBuildingEvent@]] ''_pFunction'', const [[../BasicDataTypes|string]]&in ''_sDescriptionName'', const [[../BasicDataTypes|uint8]] ''_Faction'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''register building event by 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;' | '''RegisterBuildingEventByIndividual''' (const [[../LogicEnums#EBuildingEvent|EBuildingEvent]] ''_EventType'', [[../LogicCallbacks|TOnBuildingEvent@]] ''_pFunction'', const [[../BasicDataTypes|string]]&in ''_sBuildingName'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''register building event by individual building name (i.e. name of the building in the level editor)''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''RegisterBuildingEventByIndividual''' (const [[../LogicEnums#EBuildingEvent|EBuildingEvent]] ''_EventType'', [[../LogicCallbacks|TOnBuildingEvent@]] ''_pFunction'', const [[../Building|Building]]&in ''_Building'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''register building event by individual building instance''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''RegisterBuildingEventByDescription''' (const [[../LogicEnums#EBuildingEvent|EBuildingEvent]] ''_EventType'', [[../LogicCallbacks|TOnBuildingExtendedEvent@]] ''_pFunction'', const [[../BasicDataTypes|string]]&in ''_sDescriptionName'', const [[../BasicDataTypes|uint8]] ''_Faction'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''same as above, but receives extra information for certain event types''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''RegisterBuildingEventByIndividual''' (const [[../LogicEnums#EBuildingEvent|EBuildingEvent]] ''_EventType'', [[../LogicCallbacks|TOnBuildingExtendedEvent@]] ''_pFunction'', const [[../BasicDataTypes|string]]&in ''_sBuildingName'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''same as above, but receives extra information for certain event types''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''RegisterBuildingEventByIndividual''' (const [[../LogicEnums#EBuildingEvent|EBuildingEvent]] ''_EventType'', [[../LogicCallbacks|TOnBuildingExtendedEvent@]] ''_pFunction'', const [[../Building|Building]]&in ''_Building'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''same as above, but receives extra information for certain event types''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''RegisterBuildingCreatureEventByDescription''' (const [[../LogicEnums#EBuildingCreatureEvent|EBuildingCreatureEvent]] ''_EventType'', [[../LogicCallbacks|TOnBuildingCreatureEvent@]] ''_pFunction'', const [[../BasicDataTypes|string]]&in ''_sDescriptionName'', const [[../BasicDataTypes|uint8]] ''_Faction'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''register building event involving creatures by 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;' | '''RegisterBuildingCreatureEventByIndividual''' (const [[../LogicEnums#EBuildingCreatureEvent|EBuildingCreatureEvent]] ''_EventType'', [[../LogicCallbacks|TOnBuildingCreatureEvent@]] ''_pFunction'', const [[../BasicDataTypes|string]]&in ''_sBuildingName'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''register building event involving creatures by individual building name (i.e. name of the building in the level editor)''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''RegisterBuildingCreatureEventByIndividual''' (const [[../LogicEnums#EBuildingCreatureEvent|EBuildingCreatureEvent]] ''_EventType'', [[../LogicCallbacks|TOnBuildingCreatureEvent@]] ''_pFunction'', const [[../Building|Building]]&in ''_Building'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''register building event involving creatures by individual building instance''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''RegisterLogicObjectEvent''' (const [[../LogicEnums#ELogicObjectEvent|ELogicObjectEvent]] ''_EventType'', [[../LogicCallbacks|TOnLogicObjectEvent@]] ''_pFunction'', const [[../BasicDataTypes|string]]&in ''_sObjectName'', const [[../BasicDataTypes|uint8]] ''_Faction'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''register logic object event by individual object name (i.e. name of the logic object in the level editor). _Faction is the faction of the player causing the event.
If _Faction is >= kMaxFactions, the event will trigger independently of the causing faction.''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''RegisterSectorEvent''' (const [[../LogicEnums#ESectorEvent|ESectorEvent]] ''_EventType'', [[../LogicCallbacks#TOnSectorEvent|TOnSectorEvent@]] ''_pFunction'', const [[../BasicDataTypes|string]]&in ''_sSectorName'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''register a sector event. if _sSectorName is specified and not empty, the event will be fired only for the given sector, otherwise it will be fired for all sectors.''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''RegisterUIEvent''' (const [[../LogicEnums#EUIEvent|EUIEvent]] ''_EventType'', [[../LogicCallbacks|TOnUIEvent@]] ''_pFunction'', const [[../BasicDataTypes|uint8]] ''_Faction'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''register an event to be called when a certain event happens in the ui of the given faction's player''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''RegisterUIEventByDescription''' (const [[../LogicEnums#EUIEvent|EUIEvent]] ''_EventType'', [[../LogicCallbacks|TOnUIEntityEvent@]] ''_pFunction'', const [[../BasicDataTypes|string]]&in ''_sDescriptionName'', const [[../BasicDataTypes|uint8]] ''_Faction'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''register an event to be called when a certain event happens in the ui of the given faction's player''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''RegisterUIEventByIndividual''' (const [[../LogicEnums#EUIEvent|EUIEvent]] ''_EventType'', [[../LogicCallbacks|TOnUIEntityEvent@]] ''_pFunction'', const [[../BasicDataTypes|string]]&in ''_sTargetName'', const [[../BasicDataTypes|uint8]] ''_Faction'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''register an event to be called when a certain event happens in the ui of the given faction's player''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''SetTimer''' ([[../LogicCallbacks#TOnTimerEvent|TOnTimerEvent@]] ''_pFunction'', const [[../BasicDataTypes|uint]] ''_uInterval'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''register a timer event to be called after _uInterval seconds.''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''SetTimer''' ([[../LogicCallbacks#TOnTimerUserDataEvent|TOnTimerUserDataEvent@]] ''_pFunction'', const [[../BasicDataTypes|uint]] ''_uInterval'', const [[../BasicDataTypes|string]]&in ''_sUserData'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''register a timer event to be called after _uInterval seconds.''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''SetTimerMS''' ([[../LogicCallbacks#TOnTimerEvent|TOnTimerEvent@]] ''_pFunction'', const [[../BasicDataTypes|uint]] ''_uIntervalMS'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''register a timer event to be called after _uInterval MILLIseconds.

NOTE: this timer is not 100% precise, it may be off by up to +/- 50 ms.''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''SetTimerMS''' ([[../LogicCallbacks#TOnTimerUserDataEvent|TOnTimerUserDataEvent@]] ''_pFunction'', const [[../BasicDataTypes|uint]] ''_uIntervalMS'', const [[../BasicDataTypes|string]]&in ''_sUserData'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''register a timer event to be called after _uInterval MILLIseconds.

NOTE: this timer is not 100% precise, it may be off by up to +/- 50 ms.''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''CancelTimer''' ([[../LogicCallbacks#TOnTimerEvent|TOnTimerEvent@]] ''_pFunction'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''cancel all currently registered timer events calling the given script function (does NOT include timers created using CreateCountdownTimer or CreateStopwatchTimer!)''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''CancelTimer''' ([[../LogicCallbacks#TOnTimerUserDataEvent|TOnTimerUserDataEvent@]] ''_pFunction'', const [[../BasicDataTypes|string]]&in ''_sUserData'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''cancel all currently registered timer events calling the given script function (does NOT include timers created using CreateCountdownTimer or CreateStopwatchTimer!)''
|}

==== Victory Conditions ====
Functions for controlling win/lose conditions.
{| 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;' | '''HasWonGame''' (const [[../BasicDataTypes|uint8]] ''_Faction'') const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''has the given faction won the game?''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|bool]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''HasLostGame''' (const [[../BasicDataTypes|uint8]] ''_Faction'') const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''has the given faction lost the game?''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''WinGame''' (const [[../BasicDataTypes|uint8]] ''_Faction'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''show the victory screen to the given faction''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''LoseGame''' (const [[../BasicDataTypes|uint8]] ''_Faction'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''show the defeat screen to the given faction''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''ResetSuccessState''' (const [[../BasicDataTypes|uint8]] ''_Faction'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''reset success state (needed to fix faulty savegames)''
|}

==== Factions ====
Functions for controlling faction relations and assets.
{| 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|uint8[]@]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''GetPlayerFactions''' () const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''get a list of player controlled factions currently in the game (also counts AIs in player slots in a multiplayer game)''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|bool]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''IsCampaignFactionInCombat''' () const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''is the singleplayer default faction for this campaign map currently in combat? WARNING: only call this on campaign maps, never on a skirmish map!''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../LogicEnums#ERace|ERace]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''GetFactionRace''' (const [[../BasicDataTypes|uint8]] ''_Faction'') const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''get the race of the given faction''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''SetFactionRace''' (const [[../BasicDataTypes|uint8]] ''_Faction'', const [[../BasicDataTypes|ERace]] ''_Race'')
|-
|
| style = 'color: #505050; line-height: 1.0;' |''set the race of the given faction. WARNING: DO NOT set the race to any race not yet present in the level. Otherwise you may cause considerable loading stutters when the faction produces buildings or units.''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|uint8]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''GetFactionColorId''' (const [[../BasicDataTypes|uint8]] ''_Faction'') const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''get the color index used by the given faction''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''SetFactionColorId''' (const [[../BasicDataTypes|uint8]] ''_Faction'', const [[../BasicDataTypes|uint8]] ''_uColorId'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''set the color index to be used by the given faciton''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|bool]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''CanFactionUseGodstones''' (const [[../BasicDataTypes|uint8]] ''_Faction'') const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''check whether the given faction can use godstones''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''AllowGodstoneUse''' (const [[../BasicDataTypes|uint8]] ''_Faction'', const [[../BasicDataTypes|bool]] ''_bAllow'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''allow a faction to use godstones (or don't)''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''TransferFactionAssets''' (const [[../BasicDataTypes|uint8]] ''_SourceFaction'', const [[../BasicDataTypes|uint8]] ''_DestinationFaction'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''transfer ownership of all buildings and units of _uSourceFaction to _uDestFaction''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''DestroyFactionAssets''' (const [[../BasicDataTypes|uint8]] ''_Faction'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''destroy or kill all buildings and creatures belonging to the given faction''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''DamageFactionAssets''' (const [[../BasicDataTypes|uint8]] ''_Faction'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''apply damage to all buildings and creatures belonging to the given faction''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../LogicEnums#EFactionRelation|EFactionRelation]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''GetFactionRelation''' (const [[../BasicDataTypes|uint8]] ''_FactionA'', const [[../BasicDataTypes|uint8]] ''_FactionB'') const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''get relation between the two given factions''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''SetFactionRelation''' (const [[../BasicDataTypes|uint8]] ''_FactionA'', const [[../BasicDataTypes|uint8]] ''_FactionB'', const [[../LogicEnums#EFactionRelation|EFactionRelation]] ''_Relation'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''set the relation between the two given factions.''
|}

==== Visibility ====
{| 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;' | '''AddVisibleSector''' (const [[../BasicDataTypes|uint8]] ''_Faction'', const [[../BasicDataTypes|uint]] ''_uSectorId'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''Make a sector permanently visible for a specific faction.''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''RemoveVisibleSector''' (const [[../BasicDataTypes|uint8]] ''_Faction'', const [[../BasicDataTypes|uint]] ''_uSectorId'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''remove permanent visibility from sector''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''AddVisiblePath''' (const [[../BasicDataTypes|uint8]] ''_Faction'', const [[../BasicDataTypes|string]]&in ''_sPathName'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''make the shape described by a logic path permanently visible to the given faction''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''RemoveVisiblePath''' (const [[../BasicDataTypes|uint8]] ''_Faction'', const [[../BasicDataTypes|string]]&in ''_sPathName'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''remove permanent visibility of the given logic path shape''
|-
|}
==== Notifications ====
Functions for displaying notifications to the player.
{| 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;' | '''ShowNotification''' (const [[../BasicDataTypes|uint8]] ''_Faction'', const [[../BasicDataTypes|string]]&in ''_sNotificationName'', const [[../Entity|Entity]]&in ''_Location'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''show a one-off notification at the given location for the given faction.''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''BeginNotification''' (const [[../BasicDataTypes|uint8]] ''_Faction'', const [[../BasicDataTypes|string]]&in ''_sNotificationName'', const [[../Entity|Entity]]&in ''_Location'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''begin an ongoing notification at the given location for the given faction.''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''EndNotification''' (const [[../BasicDataTypes|uint8]] ''_Faction'', const [[../BasicDataTypes|string]]&in ''_sNotificationName'', const [[../Entity|Entity]]&in ''_Location'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''end an ongoing notification at the given location for the given faction.''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''ShowQuestNotification''' (const [[../BasicDataTypes|uint8]] ''_Faction'', const [[../BasicDataTypes|string]]&in ''_sNotificationName'', const [[../BasicDataTypes|string]]&in ''_sQuestName'', const [[../BasicDataTypes|string]]&in ''_sTaskName'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''show quest-related notification''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''ShowExplorationBanner''' (const [[../BasicDataTypes|uint8]] ''_Faction'', const [[../BasicDataTypes|uint]] ''_uTextId'', const [[../BasicDataTypes|string]]&in ''_sTextureName'', const [[../BasicDataTypes|uint]] ''_uFadeInTime'', const [[../BasicDataTypes|uint]] ''_uDisplayTime'', const [[../BasicDataTypes|uint]] ''_uFadeOutTime'', const [[../BasicDataTypes|string]]&in ''_sSoundName'' = "")
|-
|
| style = 'color: #505050; line-height: 0.5;' |''show exploration banner (times are in ms)''
|}

==== Onscreen Timers ====
Functions to display timers for certain events on the player's screen
{| 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|uint]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''CreateCountdownTimer''' (const [[../BasicDataTypes|uint]] ''_uDisplayTextId'', const [[../BasicDataTypes|uint]] ''_uSeconds'', [[../LogicCallbacks|TOnTimerEvent@]] ''_pFunction'' = null, const [[../BasicDataTypes|uint8]] ''_uFaction'' = kMaxFactions, const [[../BasicDataTypes|string]]&in ''_sName'' = "")
|-
|
| style = 'color: #505050; line-height: 1.0;' |''create a timer visible in the UI along with the text specified by Timer[_uDisplayTextId] (see names.xml).
the timer will count down from _uSeconds to 0 and optionally call _pFunction upon reaching 0.
if _Faction is specified, the timer will only be displayed for the given faction.
returns a unique id you can store in order to access the timer later on.''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|uint]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''CreateCountdownTimerMS''' (const [[../BasicDataTypes|uint]] ''_uDisplayTextId'', const [[../BasicDataTypes|uint]] ''_uMilliSeconds'', [[../LogicCallbacks|TOnTimerEvent@]] ''_pFunction'' = null, const [[../BasicDataTypes|uint8]] ''_uFaction'' = kMaxFactions, const [[../BasicDataTypes|string]]&in ''_sName'' = "")
|-
|
| style = 'color: #505050; line-height: 0.5;' |''same as CreateCountdownTimer, but allows more precise time specification. 

NOTE: The actual time the timer takes to finish may be off by up to +/- 50 ms.''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|uint]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''CreateStopwatchTimer''' (const [[../BasicDataTypes|uint]] ''_uDisplayTextId'', const [[../BasicDataTypes|uint8]] ''_uFaction'' = kMaxFactions, const [[../BasicDataTypes|string]]&in ''_sName'' = "")
|-
|
| style = 'color: #505050; line-height: 1.0;' |''create a timer visible in the UI along with the text specified by Timer[_uDisplayTextId] (see names.xml).
the timer will steadily count up from 0 until it is removed.
if _Faction is specified, the timer will only be displayed for the given faction.
returns a unique id you can store in order to access the timer later on.''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''PauseTimer''' (const [[../BasicDataTypes|uint]] ''_uTimerId'', const [[../BasicDataTypes|bool]] ''_bPause'' = true)
|-
|
| style = 'color: #505050; line-height: 0.5;' |''pause or unpause the given timer''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|bool]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''ModifyTimer''' (const [[../BasicDataTypes|uint]] ''_uTimerId'', const [[../BasicDataTypes|int]] ''_iSeconds'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''modify the current tick count of _uTimerId by _iSeconds. returns true if the timer is still valid, false if it has been removed''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|bool]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''ModifyTimerMS''' (const [[../BasicDataTypes|uint]] ''_uTimerId'', const [[../BasicDataTypes|int]] ''_iMilliSeconds'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''modify the current tick count of _uTimerId by _iMilliSeconds. returns true if the timer is still valid, false if it has been removed''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''RemoveTimer''' (const [[../BasicDataTypes|uint]] ''_uTimerId'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''remove the timer with the given id''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|uint]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''GetTimerTime''' (const [[../BasicDataTypes|uint]] ''_uTimerId'') const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''get the current time on the timer with the given id in seconds''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|uint]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''GetTimerTimeMS''' (const [[../BasicDataTypes|uint]] ''_uTimerId'') const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''get the current time on the timer with the given id in MILLIseconds''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|bool]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''IsTimerPaused''' (const [[../BasicDataTypes|uint]] ''_uTimerId'') const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''is the timer with the given id currently paused?''
|-
|}

==== Tutorials ====
Functions for controlling tutorials.
{| 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;' | '''ShowTutorial''' (const [[../BasicDataTypes|uint8]] ''_Faction'', const [[../BasicDataTypes|string]]&in ''_sTutorialName'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''show the given tutorial, provided that it has not already been shown.''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''ShowTutorial''' (const [[../BasicDataTypes|uint8]] ''_Faction'', const [[../BasicDataTypes|string]]&in ''_sTutorialName'', const [[../Entity|Entity]]&in ''_Target'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''show the given tutorial, provided that it has not already been shown.''
|}

==== Camera Manipulation ====
Functions for manipulating the player's point of view.
{| 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;' | '''SetMaxCameraDistance''' (const [[../BasicDataTypes|uint8]] ''_Faction'', const [[../BasicDataTypes|uint]] ''_uDistance'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''set how far the given player's camera is allowed to zoom out''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''ResetMaxCameraDistance''' (const [[../BasicDataTypes|uint8]] ''_Faction'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''reset the maximum camera distance to the level's default value''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''SetCameraZoomPercent''' (const [[../BasicDataTypes|uint8]] ''_Faction'', const [[../BasicDataTypes|uint8]] ''_uPercent'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''set the given player's camera zoom to the given level (0 = fully zoomed in, 100 = fully zoomed out)''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''FocusCamera''' (const [[../BasicDataTypes|uint8]] ''_Faction'', const [[../Entity|Entity]]&in ''_Target'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''focus the given player's camera on the given target''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|bool]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''IsCutScenePlaying''' () const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''is a cutscene currently playing?''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''PlayCutScene''' (const [[../BasicDataTypes|string]]&in ''_sCutSceneName'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''play the given cutscene''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''FadeToBlack''' (const [[../BasicDataTypes|uint8]] ''_Faction'', const [[../BasicDataTypes|uint8]] ''_uControlIndex'', const [[../BasicDataTypes|uint]] ''_uTimeMS'' = 1000)
|-
|
| style = 'color: #505050; line-height: 0.5;' |''fade camera to black over the course of _uTimeMS milliseconds for the given player''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''FadeFromBlack''' (const [[../BasicDataTypes|uint8]] ''_Faction'', const [[../BasicDataTypes|uint8]] ''_uControlIndex'', const [[../BasicDataTypes|uint]] ''_uTimeMS'' = 1000)
|-
|
| style = 'color: #505050; line-height: 0.5;' |''fade camera from black to regular view over the course of _uTimeMS milliseconds for the given player''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''FadeToBlackAndBack''' (const [[../BasicDataTypes|uint8]] ''_Faction'', const [[../BasicDataTypes|uint8]] ''_uControlIndex'', const [[../BasicDataTypes|uint]] ''_uFadeTimeMS'' = 1000, const [[../BasicDataTypes|uint]] ''_uStayTimeMS'' = 1000)
|-
|
| style = 'color: #505050; line-height: 1.0;' |''fade camera to black over _uFadeTimeMS milliseconds, stay at full black for _uStayTimeMS milliseconds, then fade back into view over _uFadeTimeMS milliseconds again.''
|}

==== Miscellaneous ====
Everything else.
{| 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;' | '''RemoveEntity''' (const [[../Entity|Entity]]&in ''_Entity'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''remove the given entity from the level permanently''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''CastSpell''' (const [[../BasicDataTypes|string]]&in ''_sSpellName'', const [[../BasicDataTypes|uint8]] ''_Faction'', const [[../Entity|Entity]]&in ''_Target'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''cast spell on entity''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''ShowWindow''' (const [[../BasicDataTypes|uint8]] ''_Faction'', const [[../BasicDataTypes|uint8]] ''_uControlIndex'', const [[../LogicEnums#EUIWindow|EUIWindow]] ''_Window'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''open up the specified window for the given player''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''PlaySound''' (const [[../BasicDataTypes|uint8]] ''_Faction'', const [[../BasicDataTypes|uint8]] ''_uControlIndex'', const [[../BasicDataTypes|string]]&in ''_sSoundName'', const [[../Entity|Entity]]&in ''_Location'' = Entity ( ))
|-
|
| style = 'color: #505050; line-height: 1.0;' |''play a sound for the given player (_Faction and _uControlIndex may be -1 if the sound should be played for all players). _Location must only be specified for 3D sounds.''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''StopSound''' (const [[../BasicDataTypes|uint8]] ''_Faction'', const [[../BasicDataTypes|uint8]] ''_uControlIndex'', const [[../BasicDataTypes|string]]&in ''_sSoundName'', const [[../Entity|Entity]]&in ''_Location'' = Entity ( ))
|-
|
| style = 'color: #505050; line-height: 1.0;' |''stop a sound for the given player (_Faction and _uControlIndex may be -1 if the sound should be played for all players). _Location must be the same one specified when starting the sound.''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''SetGlobalSoundTrack''' (const [[../BasicDataTypes|uint8]] ''_Faction'', const [[../BasicDataTypes|uint8]] ''_uControlIndex'', const [[../LogicEnums#ESoundTrack|ESoundTrack]] ''_Track'', const [[../BasicDataTypes|string]]&in ''_sSoundName'')
|-
|
| style = 'color: #505050; line-height: 1.0;' |''override the sound event played in the given global event track (_Faction and _uControlIndex may be -1 if the track should be changed for all players). if _sSoundEventName is empty, the default track will be played again.''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''SetGlobalSoundParameter''' (const [[../BasicDataTypes|uint8]] ''_Faction'', const [[../BasicDataTypes|uint8]] ''_uControlIndex'', const [[../BasicDataTypes|string]]&in ''_sParameterName'', const [[../BasicDataTypes|int]] ''_iValue'')
|-
|
| style = 'color: #505050; line-height: 1.0;' |''set the value of the given parameter for global sound events (_Faction and _uControlIndex may be -1 if the parameter should be changed for all players).''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''SuspendAutomaticCombatMusic''' (const [[../BasicDataTypes|uint8]] ''_Faction'', const [[../BasicDataTypes|uint8]] ''_uControlIndex'', const [[../BasicDataTypes|bool]] ''_bSuspend'')
|-
|
| style = 'color: #505050; line-height: 1.0;' |''suspend or allow the automatic playing of combat music (e.g. during cutscenes, _Faction and _uControlIndex may be -1 if the music should be suspended for all players).''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''SuspendAmbientSounds''' (const [[../BasicDataTypes|uint8]] ''_Faction'', const [[../BasicDataTypes|uint8]] ''_uControlIndex'', const [[../BasicDataTypes|bool]] ''_bSuspend'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''suspend or allow ambient sounds (_Faction and _uControlIndex may be -1 if the ambient sounds should be suspended for all players).''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''PlayVideo''' (const [[../BasicDataTypes|uint8]] ''_Faction'', const [[../BasicDataTypes|uint8]] ''_uControlIndex'', const [[../BasicDataTypes|string]]&in ''_sVideoName'', const [[../BasicDataTypes|bool]] ''_bShowCredits'' = false)
|-
|
| style = 'color: #505050; line-height: 1.0;' |''play a video for the given player (_Faction and _uControlIndex may be -1 if the video should be played for all players). if _bShowCredits is true - well you can guess what happens''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''CallWeatherScript''' (const [[../BasicDataTypes|string]]&in ''_sFunction'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''call the given function in the level's weather script''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''BlockNavMesh''' (const [[../BasicDataTypes|string]]&in ''_sName'', const [[../BasicDataTypes|bool]] ''_bBlocked'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''activate or deactivate the nav blocker with the given name''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''ActivateSpawn''' (const [[../BasicDataTypes|string]]&in ''_sName'', const [[../BasicDataTypes|bool]] ''_bActive'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''activate the spawn of the given name''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''ResetSpawn''' (const [[../BasicDataTypes|string]]&in ''_sName'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''reset spawn to initial default state (including inactive if it is inactive by default)''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''ActivateAI''' (const [[../BasicDataTypes|uint8]] ''_Faction'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''activate an existing AI for the given faction''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''SetAIFlag''' (const [[../BasicDataTypes|uint8]] ''_Faction'', const [[../LogicEnums#EAIFlag|EAIFlag]] ''_Flag'', const [[../BasicDataTypes|bool]] ''_bValue'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''set the given flag for the given AI''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|bool]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''IsTechnologyUnlocked''' (const [[../BasicDataTypes|uint8]] ''_Faction'', const [[../BasicDataTypes|string]]&in ''_sTechnologyName'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''check whether the given RTS technology is currently unlocked for the given faction''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''UnlockTechnology''' (const [[../BasicDataTypes|uint8]] ''_Faction'', const [[../BasicDataTypes|string]]&in ''_sTechnologyName'', const [[../BasicDataTypes|bool]] ''_bUnlock'' = true)
|-
|
| style = 'color: #505050; line-height: 0.5;' |''lock or unlock the given RTS technology for the given faction''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|uint]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''GetBaseSupply''' (const [[../BasicDataTypes|uint8]] ''_Faction'') const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''get baseline supply limit for the given faction (this will be provided to the faction in addition to any supply limit bonuses from sectors or buildings)''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''SetBaseSupply''' (const [[../BasicDataTypes|uint8]] ''_Faction'', const [[../BasicDataTypes|uint]] ''_uSupply'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''set baseline supply limit for the given faction''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''EnableLight''' (const [[../BasicDataTypes|string]]&in ''_sName'', const [[../BasicDataTypes|bool]] ''_bEnable'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''enable or disable the given light''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''EnableGroup''' (const [[../BasicDataTypes|string]]&in ''_sName'', const [[../BasicDataTypes|bool]] ''_bEnable'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''enable/disable everything in the given group (including purely visual entities and light sources)''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''ExecuteConsoleCommand''' (const [[../BasicDataTypes|string]]&in ''_sCommand'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''execute the given console command (logic level prefix is included implicitly)''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''DebugTrackActions''' () const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''for debugging only! add action history of this creature to debug output. only works until DebugTrackActions is called on another creature.''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''AutoSave''' ()
|-
|
| style = 'color: #505050; line-height: 0.5;' |''trigger a manual autosave. NOTE: the autosave will not happen immediately but only at the start of the next tick!''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''UnlockAchievement''' (const [[../BasicDataTypes|uint8]] ''_uFaction'', const [[../BasicDataTypes|uint8]] ''_uControlIndex'', const [[../BasicDataTypes|string]]&in ''_sAchievementName'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''unlock the given achievement''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''IncrementAchievementStat''' (const [[../BasicDataTypes|uint8]] ''_uFaction'', const [[../BasicDataTypes|uint8]] ''_uControlIndex'', const [[../BasicDataTypes|string]]&in ''_sStatName'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''increment the given achievement-related stat''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''ResetAchievements''' (const [[../BasicDataTypes|uint8]] ''_uFaction'', const [[../BasicDataTypes|uint8]] ''_uControlIndex'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''reset all achievements for the given player (only works in non-final builds, for obvious reasons)''
|-
|}