Difference between revisions of "Modding:PVEMissions:mission.php:MissionContextCommands"
LInsoDeTeh (talk | contribs) |
LInsoDeTeh (talk | contribs) |
||
Line 93: | Line 93: | ||
==RemoveCounter()== | ==RemoveCounter()== | ||
− | Removes an existing counter | + | Removes an existing counter from the UI of the players. |
{| class="wikitable" | {| class="wikitable" | ||
|+ Parameters | |+ Parameters | ||
Line 106: | Line 106: | ||
===Example=== | ===Example=== | ||
<source lang="php"> | <source lang="php"> | ||
− | $MissionContext->SetCounter('myCounter', 12, array('EN' => 'This counter | + | $MissionContext->SetCounter('myCounter', 12, array('EN' => 'This counter has the value 12.)); |
$MissionContext->RemoveCounter('myCounter'); | $MissionContext->RemoveCounter('myCounter'); | ||
</source> | </source> | ||
Line 128: | Line 128: | ||
$MissionContext->RemoveMissionObjective('myObjective'); | $MissionContext->RemoveMissionObjective('myObjective'); | ||
</source> | </source> | ||
+ | |||
+ | |||
+ | ==RemoveTimer()== | ||
+ | Removes an existing timer, and prevents its expiration. | ||
+ | {| class="wikitable" | ||
+ | |+ Parameters | ||
+ | |- | ||
+ | ! Parameter | ||
+ | ! Type | ||
+ | ! Description | ||
+ | |- | ||
+ | | $timerId || string || The Id of the timer used when creating the timer with the ''SetTimer'' command. | ||
+ | |} | ||
+ | |||
+ | ===Example=== | ||
+ | <source lang="php"> | ||
+ | $MissionContext->SetTimer('myTimer', 12, true, array('EN' => 'This is a visible timer.')); | ||
+ | $MissionContext->RemoveTimer('myTimer'); | ||
+ | </source> | ||
+ | |||
+ | |||
+ | ==RemoveTrigger()== | ||
+ | Removes an existing trigger and prevents it from being triggered. | ||
+ | {| class="wikitable" | ||
+ | |+ Parameters | ||
+ | |- | ||
+ | ! Parameter | ||
+ | ! Type | ||
+ | ! Description | ||
+ | |- | ||
+ | | $trigger || string || The Id of the trigger used when creating the trigger with the ''AddInRegionTrigger'' or ''AddOutsideRegionTrigger command. | ||
+ | |} | ||
+ | |||
+ | ===Example=== | ||
+ | <source lang="php"> | ||
+ | $MissionContext->AddInRegionTrigger('myTrigger', 'myCircle', 18)); | ||
+ | $MissionContext->RemoveTrigger('myTrigger'); | ||
+ | </source> | ||
+ | |||
+ | |||
[[Category:Modding:PVEMissions:mission.php]] | [[Category:Modding:PVEMissions:mission.php]] |
Revision as of 19:02, 15 March 2016
Contents
AddInRegionTrigger()
This command adds a trigger for when a ship is inside a certain region. The function call like this:
$MissionContext->AddInRegionTrigger($triggerId, $regionId, $shipId)
Parameter | Type | Description |
---|---|---|
$triggerId | string | The Id which is passed in the OnTrigger event handler and can be used in the RemoveTrigger command. |
$regionId | string | The Id of a region that has been defined with the SetRegion command before. |
$shipId | integer | The Id of a ship |
Example
$MissionContext->SetRegion('myCircle', array(10, 12), 7);
$MissionContext->AddInRegionTrigger('myTrigger', 'myCircle', 17);
AddOutsideRegionTrigger()
This command adds a trigger for when a ship is not inside a certain region. The function signature and parameters are identical to the AddInRegionTrigger command.
AddShip()
This command adds a new ship to the map. The function call looks like this:
$shipId = $MissionContext->AddShip($definitionId, $coordinates, $rotation, $owner)
Parameter | Type | Description |
---|---|---|
$definitionId | string | The Id of the <ShipDefinition> from the shipdefinitions.xml. |
$coordinates | array | The x and z coordinates where to spawn the ship. |
$rotation | integer | The rotation (in degrees) of the ship. |
$owner | string | The PlayerId of the ship owner. 'X' for enemies, 'Y' for allies, the playerId from the $MissionContext->PlayerList property for a player. |
Type | Description |
---|---|
int | The Id of the ship on the map for use in MoveShip command or OnShipKilled trigger for example. |
Examples
$shipId = $MissionContext->AddShip('PirateProbe', array(10, 12), 0, 'X');
$playerId = $MissionContext->PlayersList[0];
$shipId2 = $MissionContext->AddShip('Rosinante', array(6, -7), 45, $playerId);
MoveShip()
This command moves an existing ship to the target coordinates.
| class="wikitable" |+ Parameters |- ! Parameter ! Type ! Description |- | $shipId || integer || The Id of the ship received from the AddShip command or from the $MissionContext->PlayerShipList or $MissionContext->EnemyShipList properties. |- | $coordinates || array || The x and z coordinates where to move the ship. |}
Example
$rosinante = $MissionContext->AddShip('Rosinante', array(6, -7), 45, '4711');
$MissionContext->MoveShip($rosinante);
RemoveCounter()
Removes an existing counter from the UI of the players.
Parameter | Type | Description |
---|---|---|
$counterId | string | The Id of the counter used when creating the counter with the SetCounter command. |
Example
$MissionContext->SetCounter('myCounter', 12, array('EN' => 'This counter has the value 12.));
$MissionContext->RemoveCounter('myCounter');
RemoveMissionObjective()
Removes an existing mission objective from the UI of the players.
Parameter | Type | Description |
---|---|---|
$objectiveId | string | The Id of the objective used when creating the objective with the SetMissionObjective command. |
Example
$MissionContext->SetMissionObjective('myObjective', array('EN' => 'This is an objective'));
$MissionContext->RemoveMissionObjective('myObjective');
RemoveTimer()
Removes an existing timer, and prevents its expiration.
Parameter | Type | Description |
---|---|---|
$timerId | string | The Id of the timer used when creating the timer with the SetTimer command. |
Example
$MissionContext->SetTimer('myTimer', 12, true, array('EN' => 'This is a visible timer.'));
$MissionContext->RemoveTimer('myTimer');
RemoveTrigger()
Removes an existing trigger and prevents it from being triggered.
Parameter | Type | Description |
---|---|---|
$trigger | string | The Id of the trigger used when creating the trigger with the AddInRegionTrigger or AddOutsideRegionTrigger command. |
Example
$MissionContext->AddInRegionTrigger('myTrigger', 'myCircle', 18));
$MissionContext->RemoveTrigger('myTrigger');