Modding:PVEMissions:mission.php:MissionContextEvents - Revision history

LInsoDeTeh: /* OnBuildingKilling() */

2016-10-26T13:46:42Z

OnBuildingKilling()

LInsoDeTeh: /* OnBuildingKilled() */

2016-10-26T13:46:31Z

OnBuildingKilled()

LInsoDeTeh: /* OnButtonClicked() */

2016-09-10T08:23:17Z

OnButtonClicked()

LInsoDeTeh: /* OnButtonClicked() */

2016-08-26T17:03:42Z

OnButtonClicked()

LInsoDeTeh: /* OnBuildingKilling() */

2016-08-26T17:03:26Z

OnBuildingKilling()

LInsoDeTeh: /* OnMissionInitialize() */

2016-03-23T17:46:19Z

OnMissionInitialize()

LInsoDeTeh: /* OnTrigger() */

2016-03-21T17:47:02Z

OnTrigger()

LInsoDeTeh at 17:44, 15 March 2016

2016-03-15T17:44:38Z

LInsoDeTeh: Created page with "{{DISPLAYTITLE:$MissionContext Events}} Category:Modding:PVEMissions:mission.php"

2016-03-11T12:23:23Z

Created page with "{{DISPLAYTITLE:$MissionContext Events}} Category:Modding:PVEMissions:mission.php"

New page

{{DISPLAYTITLE:$MissionContext Events}}

[[Category:Modding:PVEMissions:mission.php]]

@@ Line 47: / Line 47: @@
 This event is triggered when a building has been destroyed, '''before''' it gets removed from the ''$MissionContext->EnemiesBuildingList'' or ''$MissionContext->AlliedBuildingsList''. That way you can check wether a friendly or hostile building has been destroyed.
 <source lang="php">
-function OnBuildingDamaged($coordinates, $type) {
+function OnBuildingKilling($coordinates, $type) {
    global $MissionContext;

@@ Line 26: / Line 26: @@
 This event is triggered when a building has been destroyed, '''after''' it has been removed from the ''$MissionContext->EnemiesBuildingList'' or ''$MissionContext->AlliedBuildingsList''. That way you can evalueate the new state/count of buildings on the map.
 <source lang="php">
-function OnBuildingDamaged($coordinates, $type) {
+function OnBuildingKilled($coordinates, $type) {
    global $MissionContext;

@@ Line 65: / Line 65: @@
 |}
-==OnButtonClicked()==
+==OnButtonClicked() / OnButtonRightClicked()==
-This event is triggered when a player clicks on a button, which has been created with the ''$MissionContext->AddButton'' command.
+These events are triggered when a player clicks on a button, which has been created with the ''$MissionContext->AddButton'' command.
 <source lang="php">
 function OnButtonClicked($buttonId, $playerId) {
    global $MissionContext;
@@ Line 84: / Line 89: @@
 |-
 | $playerId|| string || The player who clicked the button
 |}

@@ Line 66: / Line 66: @@
 ==OnButtonClicked()==
-This event is triggered when a player clicks on a button, which has been created with the ''$MissionContext->Add'' or ''$MissionContext->AddButton'' command.
+This event is triggered when a player clicks on a button, which has been created with the ''$MissionContext->AddButton'' command.
 <source lang="php">
 function OnButtonClicked($buttonId, $playerId) {

← Older revision		Revision as of 17:03, 26 August 2016
Line 65:		Line 65:
	\|}		\|}

		+	==OnButtonClicked()==
		+	This event is triggered when a player clicks on a button, which has been created with the ''$MissionContext->Add'' or ''$MissionContext->AddButton'' command.
		+	<source lang="php">
		+	function OnButtonClicked($buttonId, $playerId) {
		+	global $MissionContext;

		+	}
		+	</source>

		+	{\| class="wikitable"
		+	\|+ Parameters
		+	\|-
		+	! Parameter
		+	! Type
		+	! Description
		+	\|-
		+	\| $buttonId \|\| string\|\| The id of the button which has been clicked
		+	\|-
		+	\| $playerId\|\| string \|\| The player who clicked the button
		+	\|}

	==OnMissionInitialize()==		==OnMissionInitialize()==

@@ Line 1: / Line 1: @@
 {{DISPLAYTITLE:$MissionContext Events}}
 ==OnMissionInitialize()==
@@ Line 9: / Line 76: @@
+}
 </source>
 ==OnMissionStarted()==

@@ Line 114: / Line 114: @@
 This event is when a trigger has been triggered.
 <source lang="php">
-function OnTimerExpired($triggerId, $shipId) {
+function OnTrigger($triggerId, $shipId) {
    global $MissionContext;

← Older revision		Revision as of 17:44, 15 March 2016
Line 1:		Line 1:
	{{DISPLAYTITLE:$MissionContext Events}}		{{DISPLAYTITLE:$MissionContext Events}}
		+
		+	==OnMissionInitialize()==
		+	This event is triggered during initialization of the mission. It is used to setup mission objectives, timers, counters, and everything else you need during the mission.
		+	<source lang="php">
		+	function OnMissionInitialize() {
		+	global $MissionContext;
		+
		+	}
		+	</source>
		+
		+
		+	==OnMissionStarted()==
		+	This event is triggered when all players finished loading the mission. Can be used to e.g. display story-telling messages.
		+	<source lang="php">
		+	function OnMissionStarted() {
		+	global $MissionContext;
		+
		+	}
		+	</source>
		+
		+
		+	==OnMissionUpdateTick()==
		+	This event is triggered once every second. It can be used to check for conditions which are not covered by any other event. Should not contain too CPU-intense code.
		+	<source lang="php">
		+	function OnMissionUpdateTick() {
		+	global $MissionContext;
		+
		+	}
		+	</source>
		+
		+
		+	==OnShipDamaged()==
		+	This event is when a ship is under attack and receiving damage.
		+	<source lang="php">
		+	function OnShipDamaged($shipId) {
		+	global $MissionContext;
		+
		+	}
		+	</source>
		+
		+	{\| class="wikitable"
		+	\|+ Parameters
		+	\|-
		+	! Parameter
		+	! Type
		+	! Description
		+	\|-
		+	\| $shipId \|\| integer \|\| The Id of the ship returned from the ''AddShip'' command.
		+	\|}
		+
		+
		+	==OnShipKilled()==
		+	This event is when a ship has been killed, '''after''' it has been removed from the ''$MissionContext->EnemiesShipList'' resp. ''$MissionContext->PlayersShipList''. That way you can evaluate the new state/count of all ships on the map.
		+	<source lang="php">
		+	function OnShipKilled($shipId) {
		+	global $MissionContext;
		+
		+	}
		+	</source>
		+
		+	{\| class="wikitable"
		+	\|+ Parameters
		+	\|-
		+	! Parameter
		+	! Type
		+	! Description
		+	\|-
		+	\| $shipId \|\| integer \|\| The Id of the ship returned from the ''AddShip'' command.
		+	\|}
		+
		+
		+	==OnShipKilling()==
		+	This event is when a ship has been killed, '''before''' it gets removed from the ''$MissionContext->EnemiesShipList'' resp. ''$MissionContext->PlayersShipList''. That way you can check wether a friendly or a hostile ship has been killed.
		+	<source lang="php">
		+	function OnShipKilling($shipId) {
		+	global $MissionContext;
		+
		+	}
		+	</source>
		+
		+	{\| class="wikitable"
		+	\|+ Parameters
		+	\|-
		+	! Parameter
		+	! Type
		+	! Description
		+	\|-
		+	\| $shipId \|\| integer \|\| The Id of the ship returned from the ''AddShip'' command.
		+	\|}
		+
		+
		+	==OnTimerExpired()==
		+	This event is when a timer has expired.
		+	<source lang="php">
		+	function OnTimerExpired($timerId) {
		+	global $MissionContext;
		+
		+	}
		+	</source>
		+
		+	{\| class="wikitable"
		+	\|+ Parameters
		+	\|-
		+	! Parameter
		+	! Type
		+	! Description
		+	\|-
		+	\| $timerId \|\| string \|\| The Id of the timer used during creation of the timer with the ''SetTimer'' command.
		+	\|}
		+
		+
		+	==OnTrigger()==
		+	This event is when a trigger has been triggered.
		+	<source lang="php">
		+	function OnTimerExpired($triggerId, $shipId) {
		+	global $MissionContext;
		+
		+	}
		+	</source>
		+
		+	{\| class="wikitable"
		+	\|+ Parameters
		+	\|-
		+	! Parameter
		+	! Type
		+	! Description
		+	\|-
		+	\| $triggerId \|\| string \|\| The Id of the trigger used during creation of the trigger with the ''SetTrigger'' command.
		+	\|-
		+	\| $ship \|\| string \|\| If the trigger involved a ship (e.g. the ''AddInRegionTrigger'' or ''AddOutsideRegionTrigger''), the ship Id returned from the ''AddShip'' command is passed.
		+	\|}
		+


	[[Category:Modding:PVEMissions:mission.php]]		[[Category:Modding:PVEMissions:mission.php]]