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

LInsoDeTeh: /* File Defition */

2016-03-15T14:36:38Z

File Defition

LInsoDeTeh at 14:34, 15 March 2016

2016-03-15T14:34:32Z

LInsoDeTeh at 14:32, 15 March 2016

2016-03-15T14:32:56Z

LInsoDeTeh: /* File Defition */

2016-03-15T11:08:53Z

File Defition

LInsoDeTeh: /* File Defition */

2016-03-15T11:07:46Z

File Defition

LInsoDeTeh: /* File Defition */

2016-03-15T11:07:25Z

File Defition

LInsoDeTeh at 11:06, 15 March 2016

2016-03-15T11:06:58Z

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

2016-03-11T12:21:05Z

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

New page

{{DISPLAYTITLE:mission.php}}

[[Category:Modding:PVEMissions]]

@@ Line 2: / Line 2: @@
 The mission.php file contains the main mission script of the mission. It can define event handlers and use commands and properties to control the mission process.
-==File Defition==
+==File Definition==
 The basic mission.php file contents look like this:
 <source lang="php">

@@ Line 75: / Line 75: @@
 </source>
-The mission challenges the players with a 10 minutes time limit to defeat all enemy ships. The ''OnMissionInitialize'' event handler is used to setup the mission objectives, timers, a counter of the remaining enemies and adds the enemy ships to the map. The ship for the Id ''PiratesProbe'' is defined in the [[Modding:PVEMissions:shipdefinitions.xml|shipdefinitions.xml]]. There are two events to happen, which change the state of the mission:
+The mission challenges the players with a 10 minutes time limit to defeat all enemy ships. The ''OnMissionInitialize'' event handler is used to setup the mission objectives, timers, a counter of the remaining enemies and adds the enemy ships to the map. The ship for the Id ''PiratesProbe'' is defined in the [[Modding:PVEMissions:shipdefinitions.xml|shipdefinitions.xml]]. The owner 'X' represents the enemy faction.
 * When the timer runs out, players lose the mission, so we handle the ''OnTimerExpired'' event.
 * When either the players or the enemies have no remaining ships, the mission ends with either a loss or a win. We can check that condition whenever the amount of remaining ships changes, so we use the ''On ShipKilled'' event.

@@ Line 74: / Line 74: @@
 ?>
 </source>
 [[Category:Modding:PVEMissions]]

@@ Line 20: / Line 20: @@
 It must contain a class called ''Mission''. The mission instance will create one instance of your ''Mission'' class and call its event handler functions at certain events. The ''Mission'' class may have event handler functions according to the [[Modding:PVEMissions:mission.php:MissionContextEvents|$MissionContext events reference]].
 Via the global variable '''$MissionContext''', you can access properties of the current mission state. All available properties can be found here: [[Modding:PVEMissions:mission.php:MissionContextProperties|$MissionContext properties reference]].
-The '''$MissionContext''' also provides the commands to control the mission process. All available commands can be found here: [[Modding:PVEMissions:mission.php:MissionContextCommands|$MissionContext commands reference]]
+The '''$MissionContext''' also provides the commands to control the mission process. All available commands can be found here: [[Modding:PVEMissions:mission.php:MissionContextCommands|$MissionContext commands reference]]. You can define any sort of variable at function scope, or even at class scope.
 ==Example==

@@ Line 19: / Line 19: @@
 It must contain a class called ''Mission''. The mission instance will create one instance of your ''Mission'' class and call its event handler functions at certain events. The ''Mission'' class may have event handler functions according to the [[Modding:PVEMissions:mission.php:MissionContextEvents|$MissionContext events reference]].
-Via the global variable $MissionContext, you can access properties of the current mission state. All available properties can be found here: [[Modding:PVEMissions:mission.php:MissionContextProperties|$MissionContext properties reference]].
+Via the global variable '''$MissionContext''', you can access properties of the current mission state. All available properties can be found here: [[Modding:PVEMissions:mission.php:MissionContextProperties|$MissionContext properties reference]].
-The $MissionContext also provides the commands to control the mission process. All available commands can be found here: [[Modding:PVEMissions:mission.php:MissionContextCommands|$MissionContext commands reference]]
+The '''$MissionContext''' also provides the commands to control the mission process. All available commands can be found here: [[Modding:PVEMissions:mission.php:MissionContextCommands|$MissionContext commands reference]]
 ==Example==

← Older revision		Revision as of 11:06, 15 March 2016
Line 1:		Line 1:
	{{DISPLAYTITLE:mission.php}}		{{DISPLAYTITLE:mission.php}}
		+	The mission.php file contains the main mission script of the mission. It can define event handlers and use commands and properties to control the mission process.
		+
		+	==File Defition==
		+	The basic mission.php file contents look like this:
		+	<source lang="php">
		+	<?php
		+	class Mission {
		+	public function OnMissionInitialize() {
		+	global $MissionContext;
		+
		+	/* implementation of the MissionInitialize event handler */
		+	}
		+
		+	/* other event handlers */
		+	}
		+	?>
		+	</source>
		+
		+	It must contain a class called ''Mission''. The mission instance will create one instance of your ''Mission'' class and call its event handler functions at certain events. The ''Mission' class may have event handler functions according to the [[Modding:PVEMissions:mission.php:MissionContextEvents\|$MissionContext events reference]].
		+	Via the global variable $MissionContext, you can access properties of the current mission state. All available properties can be found here: [[Modding:PVEMissions:mission.php:MissionContextProperties\|$MissionContext properties reference]].
		+	The $MissionContext also provides the commands to control the mission process. All available commands can be found here: [[Modding:PVEMissions:mission.php:MissionContextCommands\|$MissionContext commands reference]]
		+
		+	==Example==
		+	The following is a (shortened) version of the ''First Blood'' mission script:
		+	<source lang="php">
		+	<?php
		+	class Mission {
		+
		+	public function OnMissionInitialize() {
		+	global $MissionContext;
		+
		+	$MissionContext->AddShip('PirateProbe', array(12, -10), 0, 'X');
		+	$MissionContext->AddShip('PirateProbe', array(5, 7), 0, 'X');
		+
		+	$MissionContext->SetMissionObjective('killEnemies',array('EN' => 'Defeat all enemies.',
		+	'DE' => 'Besiegen Sie alle Feinde.'));
		+	$MissionContext->SetTimer('missionTimer', 600, true, array('EN' => 'Time remaining',
		+	'DE' => 'Verbleibende Zeit'));
		+	$MissionContext->SetTimer('5minTimer', 300, false, null);
		+	$MissionContext->SetCounter('enemyCounter', $MissionContext->EnemiesShipList->Count, array('EN' => 'Remaining enemies',
		+	'DE' => 'Verbleibende Feinde'));
		+	}
		+
		+	public function OnTimerExpired($timerId) {
		+	global $MissionContext;
		+
		+	if ($timerId == 'missionTimer') {
		+	$MissionContext->SetMissionFailed(array('EN' => 'Time is up',
		+	'DE' => 'Die Zeit ist abgelaufen'));
		+	} else if ($timerId == '5minTimer') {
		+	$MissionContext->SendSystemMessage(array('EN' => '5:00 minutes left...',
		+	'DE' => 'Noch 5:00 Minuten verbleiben...'));
		+	}
		+	}
		+
		+	public function OnShipKilled($shipId) {
		+	global $MissionContext;
		+
		+	if ($MissionContext->PlayersShipList->Count == 0) {
		+	$MissionContext->SetMissionFailed(array('EN' => 'All your ships have been defeated',
		+	'DE' => 'Alle eure Schiffe wurden besiegt'));
		+	} else {
		+	if ($MissionContext->EnemiesShipList->Count == 0) {
		+	$MissionContext->SetMissionSuccessful(array('EN' => 'All enemy ships have been defeated',
		+	'DE' => 'Alle feindlichen Schiffe wurden besiegt'));
		+	} else {
		+	$MissionContext->SetCounter('enemyCounter', $MissionContext->EnemiesShipList->Count, array('EN' => 'Remaining enemies',
		+	'DE' => 'Verbleibende Feinde'));
		+	}
		+	}
		+	}
		+	}
		+	?>
		+	</source>

	[[Category:Modding:PVEMissions]]		[[Category:Modding:PVEMissions]]