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: 0.8;' | '''RegisterHeroPartyEvent''' (const [[../BasicDataTypes|string]]&in ''_sEventTypeName'', [[../TOnHeroPartyEvent|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: 0.8;' | '''RegisterInventoryEvent''' (const [[../BasicDataTypes|string]]&in ''_sEventTypeName'', [[../TOnInventoryEvent|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: 0.8;' | '''RegisterCreatureEventByDescription''' (const [[../BasicDataTypes|string]]&in ''_sEventTypeName'', [[../TOnCreatureEvent|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: 0.8;' | '''RegisterCreatureEventByIndividual''' (const [[../BasicDataTypes|string]]&in ''_sEventTypeName'', [[../TOnCreatureEvent|TOnCreatureEvent@]] ''_pFunction'', const [[../BasicDataTypes|string]]&in ''_sCreatureName'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''register creature event by individual creature name (e.g.''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 0.8;' | '''RegisterBuildingEventByDescription''' (const [[../BasicDataTypes|string]]&in ''_sEventTypeName'', [[../TOnBuildingEvent|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: 0.8;' | '''RegisterBuildingEventByIndividual''' (const [[../BasicDataTypes|string]]&in ''_sEventTypeName'', [[../TOnBuildingEvent|TOnBuildingEvent@]] ''_pFunction'', const [[../BasicDataTypes|string]]&in ''_sBuildingName'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''register building event by individual building name (i.e.''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 0.8;' | '''RegisterUIEvent''' (const [[../BasicDataTypes|string]]&in ''_sEventTypeName'', [[../TOnUIEvent|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: 0.8;' | '''RegisterUIEventByDescription''' (const [[../BasicDataTypes|string]]&in ''_sEventTypeName'', [[../TOnUIEntityEvent|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: 0.8;' | '''RegisterUIEventByIndividual''' (const [[../BasicDataTypes|string]]&in ''_sEventTypeName'', [[../TOnUIEntityEvent|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: 0.8;' | '''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: 0.8;' | '''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: 0.8;' | '''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: 0.8;' | '''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: 0.8;' | '''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: 0.8;' | '''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: 0.8;' | '''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: 0.8;' | '''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: 0.8;' | '''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: 0.8;' | '''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: 0.8;' | '''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: 0.8;' | '''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: 0.8;' | '''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: 0.8;' | '''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;' | [[../Building|Building]] 
| style='color: black; width: 90%; line-height: 0.8;' | '''FindBuildingByDescription''' (const [[../BasicDataTypes|uint8]] ''_uFaction'', const [[../BasicDataTypes|string]]&in ''_sDescriptionName'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''find building by description in the given faction. if more than one building using this description exists, returns the first one found.''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../Creature|Creature]] 
| style='color: black; width: 90%; line-height: 0.8;' | '''FindCreatureByDescription''' (const [[../BasicDataTypes|uint8]] ''_uFaction'', const [[../BasicDataTypes|string]]&in ''_sDescriptionName'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''find creature by description in the given faction. if more than one creature using this description exists, returns the first one found.''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 0.8;' | '''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: 0.8;' | '''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: 0.8;' | '''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: 0.8;' | '''SetFactionRelation''' (const [[../BasicDataTypes|uint8]] ''_FactionA'', const [[../BasicDataTypes|uint8]] ''_FactionB'', const [[../BasicDataTypes|string]]&in ''_sRelation'')
|-
|
| 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: 0.8;' | '''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: 0.8;' | '''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: 0.8;' | '''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: 0.8;' | '''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: 0.8;' | '''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: 0.8;' | '''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: 0.8;' | '''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: 0.8;' | '''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: 0.8;' | '''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: 0.8;' | '''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.''
|}