Event Documentation

Moose Test Missions/EVT - Event Handling/EVT-103 - OnEventLand Example/EVT-103 - OnEventLand Example.lua

@@ -0,0 +1,38 @@
+---
+-- Name: EVT-103 - OnEventLand Example
+-- Author: FlightControl
+-- Date Created: 7 February 2017
+--
+-- # Situation:
+--
+-- An AI plane is landing on an airfield.
+-- When the plane landed, a new plane is spawned.
+-- 
+-- # Test cases:
+-- 
+-- 1. Observe the plane landing.
+-- 2. When the AI plane lands, observe the new plane being spawned.
+-- 3. Check the contents of the fields of the S_EVENT_LAND entry in the dcs.log file.
+
+-- Create a variable PlaneAI that holds a reference to UNIT object (created by moose at the beginning of the mission) with the name "PlaneAI".
+local PlaneAI = UNIT:FindByName( "PlaneAI" )
+
+-- Create a SPAWN object to spawn a new plane once the hold one lands.
+local SpawnPlane = SPAWN:New( "SpawnPlaneAI" )
+
+-- Declare a new variable that will hold the new spawned SpawnPlaneAI
+local NewPlane
+
+
+-- Subscribe to the event Land. The Land event occurs when a plane lands at an airfield.
+PlaneAI:HandleEvent( EVENTS.Land )
+
+-- Because the PlaneAI object is subscribed to the Land event, the following method will be automatically
+-- called when the land event is happening FOR THE PlaneAI UNIT only!
+function PlaneAI:OnEventLand( EventData )
+
+  -- Okay, the PlaneAI has landed, now spawn the new plane ( a predator )
+  NewPlane = SpawnPlane:Spawn()
+end
+
+

Moose Test Missions/EVT - Event Handling/EVT-104 - OnEventCrash Example/EVT-104 - OnEventCrash Example.lua

@@ -0,0 +1,35 @@
+---
+-- Name: EVT-104 - OnEventCrash Example
+-- Author: FlightControl
+-- Date Created: 7 February 2017
+--
+-- # Situation:
+--
+-- A human plane is fyling in the air. Crash it into the ground.
+-- Once you are crashed into the ground, at the place where you crashed, a smoke should start burning ...
+-- 
+-- # Test cases:
+-- 
+-- 1. Fly the plane into the ground.
+-- 2. When your plane crashes, observe a smoke starting to burn right were you crashed.
+-- 3. Check the contents of the fields of the S_EVENT_CRASH entry in the dcs.log file.
+
+-- Create a variable PlaneHuman that holds a reference to UNIT object (created by moose at the beginning of the mission) with the name "PlaneHuman".
+local PlaneHuman = UNIT:FindByName( "PlaneHuman" )
+
+-- Subscribe to the event Crash. The Crash event occurs when a plane crashes into the ground (or into something else).
+PlaneHuman:HandleEvent( EVENTS.Crash )
+
+-- Because the PlaneHuman object is subscribed to the Crash event, the following method will be automatically
+-- called when the Crash event is happening FOR THE PlaneHuman UNIT only!
+
+--- @param self
+-- @param Core.Event#EVENTDATA EventData
+function PlaneHuman:OnEventCrash( EventData )
+
+  -- Okay, the PlaneHuman has crashed, now smoke at the x, z position.
+  self:E( "Smoking at the position" )
+  EventData.IniUnit:SmokeOrange()
+end
+
+