View source for Script/LevelReference

==class LevelReference==
The main interface for interacting with the level the player is currently in.
  
=== Class Methods ===
{| 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;' | '''RegisterCreatureEventByDescription''' (const [[../LogicEnums#ECreatureEvent|ECreatureEvent]] ''_EventType'', [[../LogicCallbacks|TOnCreatureEvent@]] ''_pFunction'', const [[../BasicDataTypes|string]]&in ''_sDescriptionName'', const [[../BasicDataTypes|uint8]] ''_Faction'')
|-
|
| 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)''
|-
| 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;' | '''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;' | [[../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;' | [[../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;' | [[../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;' | [[../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;' | '''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;' | [[../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;' | '''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;' | [[../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;' | [[../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.''
|-
| 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;' | '''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;' | '''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;' | '''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.''
|-
| 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;' | '''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|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.''
|}