Module Core.Zone

The PointVec2 of the zone.

ZONE_BASE:GetPointVec3(Height)

Returns a Core.Point#POINT_VEC3 of the zone.

Defined in:

ZONE_BASE

Parameter:

DCS#Distance Height

The height to add to the land height where the center of the zone is located.

Return value:

The PointVec3 of the zone.

ZONE_BASE:GetProperty(PropertyName)

Returns the Value of the zone with the given PropertyName, or nil if no matching property exists.

Defined in:

ZONE_BASE

Parameter:

#string PropertyName

The name of a the TriggerZone Property to be retrieved.

Return value:

#string:

The Value of the TriggerZone Property with the given PropertyName, or nil if absent.

Usage:


local PropertiesZone = ZONE:FindByName("Properties Zone")
local Property = "ExampleProperty"
local PropertyValue = PropertiesZone:GetProperty(Property)

ZONE_BASE:GetRandomPointVec2()

Define a random Core.Point#POINT_VEC2 within the zone.

Note that this is actually a Core.Point#COORDINATE type object, and not a simple Vec2 table.

Defined in:

ZONE_BASE

Return value:

The PointVec2 coordinates.

ZONE_BASE:GetRandomPointVec3()

ZONE_BASE:GetVec2()

Returns the DCS#Vec2 coordinate of the zone.

Defined in:

ZONE_BASE

Return value:

#nil:

ZONE_BASE:GetVec3(Height)

Returns the DCS#Vec3 of the zone.

Defined in:

ZONE_BASE

Parameter:

DCS#Distance Height

The height to add to the land height where the center of the zone is located.

Return value:

The Vec3 of the zone.

ZONE_BASE:GetZoneMaybe()

Get the zone taking into account the randomization probability of a zone to be selected.

Defined in:

ZONE_BASE

Return values:

The zone is selected taking into account the randomization probability factor.

#nil:

The zone is not selected taking into account the randomization probability factor.

Usage:


local ZoneArray = { ZONE:New( "Zone1" ), ZONE:New( "Zone2" ) }

-- We set a zone probability of 70% to the first zone and 30% to the second zone.
ZoneArray[1]:SetZoneProbability( 0.5 )
ZoneArray[2]:SetZoneProbability( 0.5 )

local ZoneSelected = nil

while ZoneSelected == nil do
  for _, Zone in pairs( ZoneArray ) do
    ZoneSelected = Zone:GetZoneMaybe()
    if ZoneSelected ~= nil then
      break
    end
  end
end

-- The result should be that Zone1 would be more probable selected than Zone2.

ZONE_BASE:GetZoneProbability()

Get the randomization probability of a zone to be selected.

Defined in:

ZONE_BASE

Return value:

#number:

A value between 0 and 1. 0 = 0% and 1 = 100% probability.

ZONE_BASE:IsCoordinateInZone(Coordinate)

Returns if a Coordinate is within the zone.

Defined in:

ZONE_BASE

Parameter:

Core.Point#COORDINATE Coordinate

The coordinate to test.

Return value:

#boolean:

true if the coordinate is within the zone.

ZONE_BASE:IsPointVec2InZone(Coordinate)

ZONE_BASE:OnAfterEnteredZone(From, Event, To, Controllable)

On After "EnteredZone" event.

An observed object has entered the zone.

Defined in:

ZONE_BASE

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Wrapper.Controllable#CONTROLLABLE Controllable

The controllable entering the zone.

ZONE_BASE:OnAfterLeftZone(From, Event, To, Controllable)

On After "LeftZone" event.

An observed object has left the zone.

Defined in:

ZONE_BASE

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Wrapper.Controllable#CONTROLLABLE Controllable

The controllable leaving the zone.

ZONE_BASE:SetCheckTime(seconds)

Set the check time for ZONE:Trigger()

Defined in:

ZONE_BASE

Parameter:

#number seconds

Check every seconds for objects entering or leaving the zone. Defaults to 5 secs.

Return value:

self

ZONE_BASE:SetColor(RGBcolor, Alpha)

Set color of zone.

Defined in:

ZONE_BASE

Parameters:

#table RGBcolor

RGB color table. Default {1, 0, 0}.

#number Alpha

Transparency between 0 and 1. Default 0.15.

Return value:

self

ZONE_BASE:SetDrawCoalition(Coalition)

Set draw coalition of zone.

Defined in:

ZONE_BASE

Parameter:

#number Coalition

Coalition. Default -1.

Return value:

self

ZONE_BASE:SetFillColor(RGBcolor, Alpha)

Set fill color of zone.

Defined in:

ZONE_BASE

Parameters:

#table RGBcolor

RGB color table. Default {1, 0, 0}.

#number Alpha

Transparacy between 0 and 1. Default 0.15.

Return value:

self

ZONE_BASE:SetName(ZoneName)

Sets the name of the zone.

Defined in:

ZONE_BASE

Parameter:

#string ZoneName

The name of the zone.

Return value:

ZONE_BASE:SetZoneProbability(ZoneProbability)

Set the randomization probability of a zone to be selected.

Defined in:

ZONE_BASE

Parameter:

#number ZoneProbability

A value between 0 and 1. 0 = 0% and 1 = 100% probability.

Return value:

self

ZONE_BASE:SmokeZone(SmokeColor)

Smokes the zone boundaries in a color.

Defined in:

ZONE_BASE

Parameter:

Utilities.Utils#SMOKECOLOR SmokeColor

The smoke color.

ZONE_BASE:Trigger(Objects)

Start watching if the Object or Objects move into or out of a zone.

Defined in:

ZONE_BASE

Parameter:

Wrapper.Controllable#CONTROLLABLE Objects

Object or Objects to watch, can be of type UNIT, GROUP, CLIENT, or SET_UNIT, SET_GROUP, SET_CLIENT

Return value:

self

Usage:

           -- Create a new zone and start watching it every 5 secs for a defined GROUP entering or leaving
           local triggerzone = ZONE:New("ZonetoWatch"):Trigger(GROUP:FindByName("Aerial-1"))

           -- This FSM function will be called when the group enters the zone
           function triggerzone:OnAfterEnteredZone(From,Event,To,Group)
             MESSAGE:New("Group has entered zone!",15):ToAll()
           end

           -- This FSM function will be called when the group leaves the zone
           function triggerzone:OnAfterLeftZone(From,Event,To,Group)
             MESSAGE:New("Group has left zone!",15):ToAll()
           end

           -- Stop watching the zone after 1 hour
          triggerzone:__TriggerStop(3600)

ZONE_BASE:TriggerStop()

Triggers the FSM event "TriggerStop".

Stops the ZONE_BASE Trigger.

(Internal) Check the assigned objects for being in/out of the zone

Defined in:

ZONE_BASE

Parameters:

#string From

#string Event

#string to

Return value:

self

Field(s)

#number ZONE_BASE.Checktime

Check every Checktime seconds, used for ZONE:Trigger()

#table ZONE_BASE.Color

Table with four entries, e.g. {1, 0, 0, 0.15}. First three are RGB color code. Fourth is the transparency Alpha value.

ZONE_BASE.Coordinate

Create a new coordinate object.

#number ZONE_BASE.DrawID

Unique ID of the drawn zone on the F10 map.

#table ZONE_BASE.FillColor

Table with four entries, e.g. {1, 0, 0, 0.15}. First three are RGB color code. Fourth is the transparency Alpha value.

#number ZONE_BASE.Surface

Type of surface. Only determined at the center of the zone!

#table ZONE_BASE.Table

of any trigger zone properties from the ME. The key is the Name of the property, and the value is the property's Value.

#number ZONE_BASE.ZoneID

ID of zone. Only zones defined in the ME have an ID!

#string ZONE_BASE.ZoneName

Name of the zone.

#number ZONE_BASE.ZoneProbability

A value between 0 and 1. 0 = 0% and 1 = 100% probability.

ZONE_BASE.checkobjects

#number ZONE_BASE.drawCoalition

Draw coalition.

ZONE_BASE.objectset

Function(s)

ZONE_BASE:AddEndState(State)

Adds an End state.

Defined in:

Parameter:

#string State

The FSM state.

ZONE_BASE:AddProcess(From, Event, Process, ReturnEvents)

Set the default #FSM_PROCESS template with key ProcessName providing the ProcessClass and the process object when it is assigned to a Wrapper.Controllable by the task.

Defined in:

Parameters:

#table From

Can contain a string indicating the From state or a table of strings containing multiple From states.

#string Event

The Event name.

Core.Fsm#FSM_PROCESS Process

An sub-process FSM.

#table ReturnEvents

A table indicating for which returned events of the SubFSM which Event must be triggered in the FSM.

Return value:

Core.Fsm#FSM_PROCESS:

The SubFSM.

ZONE_BASE:AddScore(State, ScoreText, Score)

Adds a score for the FSM to be achieved.

Defined in:

Parameters:

#string State

is the state of the process when the score needs to be given. (See the relevant state descriptions of the process).

#string ScoreText

is a text describing the score that is given according the status.

#number Score

is a number providing the score of the status.

Return value:

self

ZONE_BASE:AddScoreProcess(From, Event, State, ScoreText, Score)

Adds a score for the FSM_PROCESS to be achieved.

Defined in:

Parameters:

#string From

is the From State of the main process.

#string Event

is the Event of the main process.

#string State

is the state of the process when the score needs to be given. (See the relevant state descriptions of the process).

#string ScoreText

is a text describing the score that is given according the status.

#number Score

is a number providing the score of the status.

Return value:

self

ZONE_BASE:AddTransition(From, Event, To)

Add a new transition rule to the FSM.

A transition rule defines when and if the FSM can transition from a state towards another state upon a triggered event.

Defined in:

Parameters:

#table From

Can contain a string indicating the From state or a table of strings containing multiple From states.

#string Event

The Event name.

#string To

The To state.

ZONE_BASE:GetCurrentState()

Get current state.

Defined in:

Return value:

#string:

Current FSM state.

ZONE_BASE:GetEndStates()

Returns the End states.

Defined in:

Return value:

#table:

End states.

#boolean:

If true, FSM is in this state.

ZONE_BASE:LoadCallBacks(CallBackTable)

Load call backs.

Defined in:

Parameter:

#table CallBackTable

Table of call backs.

ZONE_BASE:New()

Creates a new FSM object.

Defined in:

Return value:

ZONE_BASE:SetProcess(From, Event, Fsm)

Defined in:

Parameters:

From

Parameters:

#string step

Step "onafter", "onbefore", "onenter", "onleave".

#string trigger

Trigger.

#table params

Parameters.

#string EventName

Event name.

Return value:

ZONE_BASE:_gosub(ParentFrom, ParentEvent)

Go sub.

Defined in:

Parameters:

#string ParentFrom

Parent from state.

#string ParentEvent

Parent event name.

Return value:

#table:

Subs.

ZONE_BASE:_handler(EventName, ...)

Handler.

Defined in:

Parameters:

#string EventName

Event name.

...

Arguments.

ZONE_BASE:_isendstate(Current)

Is end state.

Defined in:

Parameter:

#string Current

Current state name.

Return values:

#table:

FSM parent.

#string:

Event name.

ZONE_BASE:_submap(subs, sub, name)

Sub maps.

Defined in:

Parameters:

#table subs

Subs.

#table sub

Sub.

#string name

Name.

ZONE_BASE:can(e)

Check if can do an event.

Defined in:

Parameter:

#string e

Event name.

Return values:

#boolean:

If true, FSM can do the event.

#string:

To state.

ZONE_BASE:cannot(e)

Check if cannot do an event.

Defined in:

Parameter:

#string e

Event name.

Return value:

#boolean:

If true, FSM cannot do the event.

ZONE_BASE:is(State, state)

Check if FSM is in state.

Defined in:

Parameters:

#string State

State name.

state

Return value:

#boolean:

If true, FSM is in this state.

Field(s)

#number ZONE_BASE.Checktime

Check every Checktime seconds, used for ZONE:Trigger()

#table ZONE_BASE.Color

Table with four entries, e.g. {1, 0, 0, 0.15}. First three are RGB color code. Fourth is the transparency Alpha value.

ZONE_BASE.Coordinate

Create a new coordinate object.

#number ZONE_BASE.DrawID

Unique ID of the drawn zone on the F10 map.

#table ZONE_BASE.FillColor

Table with four entries, e.g. {1, 0, 0, 0.15}. First three are RGB color code. Fourth is the transparency Alpha value.

#number ZONE_BASE.Surface

Type of surface. Only determined at the center of the zone!

#table ZONE_BASE.Table

of any trigger zone properties from the ME. The key is the Name of the property, and the value is the property's Value.

#number ZONE_BASE.ZoneID

ID of zone. Only zones defined in the ME have an ID!

#string ZONE_BASE.ZoneName

Name of the zone.

#number ZONE_BASE.ZoneProbability

A value between 0 and 1. 0 = 0% and 1 = 100% probability.

ZONE_BASE.checkobjects

#number ZONE_BASE.drawCoalition

Draw coalition.

ZONE_BASE.objectset

Function(s)

ZONE_BASE:ClearState(Object, StateName)

Clear the state of an object.

Defined in:

Parameters:

Object

The object that holds the Value set by the Key.

StateName

The key that is should be cleared.

ZONE_BASE:CreateEventBirth(EventTime, Initiator, IniUnitName, place, subplace)

Creation of a Birth Event.

Defined in:

Parameters:

DCS#Time EventTime

Defined in:

Parameter:

Arguments

A #table or any field.

ZONE_BASE:EventDispatcher()

Returns the event dispatcher

Defined in:

Return value:

Core.Event#EVENT:

ZONE_BASE:EventRemoveAll()

Remove all subscribed events

Defined in:

ZONE_BASE:GetClassNameAndID()

Get the ClassName + ClassID of the class instance.

The ClassName + ClassID is formatted as '%s#%09d'.

Defined in:

Return value:

#string:

The ClassName + ClassID of the class instance.

ZONE_BASE:GetEventPriority()

Get the Class Core.Event processing Priority.

The Event processing Priority is a number from 1 to 10, reflecting the order of the classes subscribed to the Event to be processed.

Defined in:

Return value:

#number:

The Core.Event processing Priority.

ZONE_BASE:GetParent(Child, FromClass)

This is the worker method to retrieve the Parent class.

Note that the Parent class must be passed to call the parent class method.

self:GetParent(self):ParentMethod()

Defined in:

Parameters:

#BASE Child

This is the Child class from which the Parent class needs to be retrieved.

#BASE FromClass

(Optional) The class from which to get the parent.

Return value:

ZONE_BASE:GetState(Object, Key)

Get a Value given a Key from the Object.

Note that if the Object is destroyed, set to nil, or garbage collected, then the Values and Keys will also be gone.

Defined in:

Parameters:

Object

The object that holds the Value set by the Key.

Key

The key that is used to retrieve the value. Note that the key can be a #string, but it can also be any other type!

Return value:

The Value retrieved or nil if the Key was not found and thus the Value could not be retrieved.

ZONE_BASE:HandleEvent(EventID, EventFunction)

Subscribe to a DCS Event.

Defined in:

Parameters:

Core.Event#EVENTS EventID

Event ID.

#function EventFunction

(optional) The function to be called when the event occurs for the unit.

Return value:

ZONE_BASE:I(Arguments)

Log an information which will be traced always.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

ZONE_BASE:Inherit(Child, Parent)

This is the worker method to inherit from a parent class.

Defined in:

Parameters:

Child

is the Child class that inherits.

#BASE Parent

is the Parent class that the Child inherits from.

Return value:

Child

ZONE_BASE:IsInstanceOf(ClassName)

This is the worker method to check if an object is an (sub)instance of a class.

Examples:

ZONE:New( 'some zone' ):IsInstanceOf( ZONE ) will return true
ZONE:New( 'some zone' ):IsInstanceOf( 'ZONE' ) will return true
ZONE:New( 'some zone' ):IsInstanceOf( 'zone' ) will return true
ZONE:New( 'some zone' ):IsInstanceOf( 'BASE' ) will return true
ZONE:New( 'some zone' ):IsInstanceOf( 'GROUP' ) will return false

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

ZONE_BASE:OnEventDetailedFailure(EventData)

Unknown precisely what creates this event, likely tied into newer damage model.

Will update this page when new information become available.

initiator: The unit that had the failure.

initiator: The unit that killed the target
target: Target Object
weapon: Weapon Object

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

ZONE_BASE:OnEventLand(EventData)

Occurs when an aircraft lands at an airbase, farp or ship Have a look at the class Core.Event#EVENT as these are just the prototypes.

initiator : The unit that has landed place: Object that the unit landed on. Can be an Airbase Object, FARP, or Ships

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

ZONE_BASE:OnEventLandingAfterEjection(EventData)

Occurs shortly after the landing animation of an ejected pilot touching the ground and standing up.

Event does not occur if the pilot lands in the water and sub combs to Davey Jones Locker. Have a look at the class Core.Event#EVENT as these are just the prototypes.

initiator: Static object representing the ejected pilot. Place : Aircraft that the pilot ejected from.
place: may not return as a valid object if the aircraft has crashed into the ground and no longer exists.
subplace: is always 0 for unknown reasons.

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

Occurs when the game thinks an object is destroyed.

Have a look at the class Core.Event#EVENT as these are just the prototypes.

initiator: The unit that is was destroyed.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

ZONE_BASE:ScheduleOnce(Start, SchedulerFunction, ...)

Schedule a new time event.

Note that the schedule will only take place if the scheduler is started. Even for a single schedule event, the scheduler needs to be started also.

Defined in:

Parameters:

#number Start

Specifies the amount of seconds that will be waited before the scheduling is started, and the event function is called.

#function SchedulerFunction

The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.

#table ...

Optional arguments that can be given as part of scheduler. The arguments need to be given as a table { param1, param 2, ... }.

Return value:

#string:

The Schedule ID of the planned schedule.

ZONE_BASE:ScheduleRepeat(Start, Repeat, RandomizeFactor, Stop, SchedulerFunction, ...)

Schedule a new time event.

Note that the schedule will only take place if the scheduler is started. Even for a single schedule event, the scheduler needs to be started also.

Defined in:

Parameters:

#number Start

Specifies the amount of seconds that will be waited before the scheduling is started, and the event function is called.

#number Repeat

Specifies the interval in seconds when the scheduler will call the event function.

#number RandomizeFactor

Specifies a randomization factor between 0 and 1 to randomize the Repeat.

#number Stop

Specifies the amount of seconds when the scheduler will be stopped.

#function SchedulerFunction

The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.

#table ...

Optional arguments that can be given as part of scheduler. The arguments need to be given as a table { param1, param 2, ... }.

Return value:

#string:

The Schedule ID of the planned schedule.

ZONE_BASE:ScheduleStop(SchedulerID)

Stops the Schedule.

Defined in:

Parameter:

#string SchedulerID

(Optional) Scheduler ID to be stopped. If nil, all pending schedules are stopped.

ZONE_BASE:SetEventPriority(EventPriority)

Set the Class Core.Event processing Priority.

The Event processing Priority is a number from 1 to 10, reflecting the order of the classes subscribed to the Event to be processed.

Defined in:

Parameter:

#number EventPriority

The Core.Event processing Priority.

Return value:

self

ZONE_BASE:SetState(Object, Key, Value)

Set a state or property of the Object given a Key and a Value.

Note that if the Object is destroyed, set to nil, or garbage collected, then the Values and Keys will also be gone.

Defined in:

Parameters:

Object

The object that will hold the Value set by the Key.

Key

The key that is used as a reference of the value. Note that the key can be a #string, but it can also be any other type!

Value

The value to is stored in the object.

#number Level

ZONE_BASE:TraceOff()

Set trace off.

Defined in:

Usage:

-- Switch the tracing Off
BASE:TraceOff()

ZONE_BASE:TraceOn()

Set trace on.

Defined in:

Usage:

-- Switch the tracing On
BASE:TraceOn()

ZONE_BASE:TraceOnOff(TraceOnOff)

Set trace on or off Note that when trace is off, no BASE.Debug statement is performed, increasing performance! When Moose is loaded statically, (as one file), tracing is switched off by default.

So tracing must be switched on manually in your mission if you are using Moose statically. When moose is loading dynamically (for moose class development), tracing is switched on by default.

Defined in:

Parameter:

#boolean TraceOnOff

Switch the tracing on or off.

Usage:


  -- Switch the tracing On
  BASE:TraceOnOff( true )

  -- Switch the tracing Off
  BASE:TraceOnOff( false )

ZONE_BASE:UnHandleEvent(EventID)

UnSubscribe to a DCS event.

Defined in:

Parameter:

Core.Event#EVENTS EventID

Event ID.

Return value:

ZONE_BASE:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function call.

The main event handling function...

This function captures all events generated for the class.

Defined in:

Parameter:

DCS#Event event

Type ZONE_BASE.BoundingSquare

The ZONE_BASE.BoundingSquare

Field(s)

DCS#Distance ZONE_BASE.BoundingSquare.x1

The lower x coordinate (left down)

DCS#Distance ZONE_BASE.BoundingSquare.x2

The higher x coordinate (right up)

DCS#Distance ZONE_BASE.BoundingSquare.y1

The lower y coordinate (left down)

DCS#Distance ZONE_BASE.BoundingSquare.y2

The higher y coordinate (right up)

Function(s)

Type ZONE_ELASTIC

Field(s)

#table ZONE_ELASTIC.points

Points in 2D.

#table ZONE_ELASTIC.setGroups

Set of GROUPs.

#table ZONE_ELASTIC.setOpsGroups

Set of OPSGROUPS.

#table ZONE_ELASTIC.setUnits

Set of UNITs.

#number ZONE_ELASTIC.updateID

Scheduler ID for updating.

Function(s)

ZONE_ELASTIC:AddSetGroup(GroupSet)

ZONE_ELASTIC:New(ZoneName, Points)

Constructor to create a ZONE_ELASTIC instance.

Defined in:

ZONE_ELASTIC

Parameters:

#string ZoneName

Name of the zone.

DCS#Vec2 Points

(Optional) Fixed points.

Return value:

#ZONE_ELASTIC:

self

ZONE_ELASTIC:StartUpdate(Tstart, dT, Tstop, Draw)

Start the updating scheduler.

Defined in:

ZONE_ELASTIC

Parameters:

#number Tstart

Time in seconds before the updating starts.

#number dT

Time interval in seconds between updates. Default 60 sec.

#number Tstop

Time in seconds after which the updating stops. Default nil.

#boolean Draw

Draw the zone. Default nil.

Return value:

#ZONE_ELASTIC:

self

ZONE_ELASTIC:StopUpdate(Delay)

Stop the updating scheduler.

Defined in:

ZONE_ELASTIC

Parameter:

#number Delay

ZONE_GROUP:GetRandomPointVec2(inner, outer)

Returns a Core.Point#POINT_VEC2 object reflecting a random 2D location within the zone.

Note that this is actually a Core.Point#COORDINATE type object, and not a simple Vec2 table.

Defined in:

ZONE_GROUP

Parameters:

#number inner

Constructor to create a ZONE_GROUP instance, taking the zone name, a zone Wrapper.Group#GROUP and a radius.

Defined in:

ZONE_GROUP

Parameters:

#string ZoneName

Name of the zone.

Wrapper.Group#GROUP ZoneGROUP

The Wrapper.Group as the center of the zone.

DCS#Distance Radius

The radius of the zone.

Return value:

#ZONE_GROUP:

self

Type ZONE_OVAL

ZONE_OVAL created from a center point, major axis, minor axis, and angle.

Ported from https://github.com/nielsvaes/CCMOOSE/blob/master/Moose%20Development/Moose/Shapes/Oval.lua

Field(s)

ZONE_OVAL.CenterVec2

ZONE_OVAL.DrawPoly

ZONE_OVAL.MajorAxis

ZONE_OVAL.MinorAxis

ZONE_OVAL.ZoneName

Function(s)

ZONE_OVAL:DrawZone(Coalition, Color, Alpha, FillColor, FillAlpha, LineType, ReadOnly)

Draw the zone on the F10 map.

ported from https://github.com/nielsvaes/CCMOOSE/blob/master/Moose%20Development/Moose/Shapes/Oval.lua

Defined in:

ZONE_OVAL

Parameters:

#number Coalition

Coalition: All=-1, Neutral=0, Red=1, Blue=2. Default -1=All.

#table Color

RGB color table {r, g, b}, e.g. {1,0,0} for red.

#number Alpha

Transparency [0,1]. Default 1.

#table FillColor

RGB color table {r, g, b}, e.g. {1,0,0} for red. Default is same as Color value. -- doesn't seem to work

#number FillAlpha

Transparency [0,1]. Default 0.15. -- doesn't seem to work

#number LineType

Line type: 0=No line, 1=Solid, 2=Dashed, 3=Dotted, 4=Dot dash, 5=Long dash, 6=Two dash. Default 1=Solid.

#boolean ReadOnly

(Optional) Mark is readonly and cannot be removed by users. Default false.

Return value:

#ZONE_OVAL:

self

ZONE_OVAL:GetAngle()

Gets the angle of the oval.

Defined in:

ZONE_OVAL

Return value:

#number:

The angle of the oval

ZONE_OVAL:GetBoundingSquare()

ZONE_OVAL:GetRandomPointVec2()

Define a random Core.Point#POINT_VEC2 within the zone.

Note that this is actually a Core.Point#COORDINATE type object, and not a simple Vec2 table.

Defined in:

ZONE_OVAL

Return value:

The PointVec2 coordinates.

ZONE_OVAL:GetRandomPointVec3()

vec2

Return value:

#bool:

True if the point is contained, false otherwise

ZONE_OVAL:New(name, vec2, major_axis, minor_axis, angle)

Creates a new ZONE_OVAL from a center point, major axis, minor axis, and angle.

ported from https://github.com/nielsvaes/CCMOOSE/blob/master/Moose%20Development/Moose/Shapes/Oval.lua

Defined in:

ZONE_OVAL

Parameters:

#string name

Name of the zone.

#table vec2

The center point of the oval

#number major_axis

The major axis of the oval

#number minor_axis

The minor axis of the oval

#number angle

The angle of the oval

Return value:

#ZONE_OVAL:

The new oval

ZONE_OVAL:NewFromDrawing(DrawingName)

Constructor to create a ZONE_OVAL instance, taking the name of a drawing made with the draw tool in the Mission Editor.

ported from https://github.com/nielsvaes/CCMOOSE/blob/master/Moose%20Development/Moose/Shapes/Oval.lua

Defined in:

ZONE_OVAL

Parameter:

#string DrawingName

The name of the drawing in the Mission Editor

Return value:

#ZONE_OVAL:

self

ZONE_OVAL:PointsOnEdge(num_points)

Find points on the edge of the oval

Defined in:

ZONE_OVAL

Parameter:

#number num_points

How many points should be found. More = smoother shape

Return value:

#table:

Points on he edge

ZONE_OVAL:UndrawZone()

Remove drawing from F10 map

Defined in:

ZONE_OVAL

Field(s)

ZONE_OVAL.CenterVec2

ZONE_OVAL.DrawPoly

ZONE_OVAL.MajorAxis

ZONE_OVAL.MinorAxis

ZONE_OVAL.ZoneName

Function(s)

ZONE_OVAL:BoundZone()

Bound the zone boundaries with a tires.

Defined in:

ZONE_OVAL:Get2DDistance(Coordinate)

Get 2D distance to a coordinate.

Defined in:

Parameter:

The Coordinate of the zone.

ZONE_OVAL:GetDrawCoalition()

Get draw coalition of zone.

Defined in:

Return value:

#number:

Draw coalition.

ZONE_OVAL:GetDrawID()

Return value:

The PointVec2 of the zone.

ZONE_OVAL:GetPointVec3(Height)

Returns a Core.Point#POINT_VEC3 of the zone.

Defined in:

Parameter:

DCS#Distance Height

The height to add to the land height where the center of the zone is located.

Return value:

The PointVec3 of the zone.

ZONE_OVAL:GetProperty(PropertyName)

Returns the Value of the zone with the given PropertyName, or nil if no matching property exists.

Defined in:

Parameter:

#string PropertyName

The name of a the TriggerZone Property to be retrieved.

Return value:

#string:

The Value of the TriggerZone Property with the given PropertyName, or nil if absent.

Usage:


local PropertiesZone = ZONE:FindByName("Properties Zone")
local Property = "ExampleProperty"
local PropertyValue = PropertiesZone:GetProperty(Property)

ZONE_OVAL:GetRandomPointVec2()

Define a random Core.Point#POINT_VEC2 within the zone.

Note that this is actually a Core.Point#COORDINATE type object, and not a simple Vec2 table.

Defined in:

Return value:

The PointVec2 coordinates.

ZONE_OVAL:GetRandomPointVec3()

ZONE_OVAL:GetVec2()

Returns the DCS#Vec2 coordinate of the zone.

Defined in:

Return value:

#nil:

ZONE_OVAL:GetVec3(Height)

Returns the DCS#Vec3 of the zone.

Defined in:

Parameter:

DCS#Distance Height

The height to add to the land height where the center of the zone is located.

Return value:

The Vec3 of the zone.

ZONE_OVAL:GetZoneMaybe()

Get the zone taking into account the randomization probability of a zone to be selected.

Defined in:

Return values:

The zone is selected taking into account the randomization probability factor.

#nil:

The zone is not selected taking into account the randomization probability factor.

Usage:


local ZoneArray = { ZONE:New( "Zone1" ), ZONE:New( "Zone2" ) }

-- We set a zone probability of 70% to the first zone and 30% to the second zone.
ZoneArray[1]:SetZoneProbability( 0.5 )
ZoneArray[2]:SetZoneProbability( 0.5 )

local ZoneSelected = nil

while ZoneSelected == nil do
  for _, Zone in pairs( ZoneArray ) do
    ZoneSelected = Zone:GetZoneMaybe()
    if ZoneSelected ~= nil then
      break
    end
  end
end

-- The result should be that Zone1 would be more probable selected than Zone2.

ZONE_OVAL:GetZoneProbability()

Get the randomization probability of a zone to be selected.

Defined in:

Return value:

#number:

A value between 0 and 1. 0 = 0% and 1 = 100% probability.

ZONE_OVAL:IsCoordinateInZone(Coordinate)

Returns if a Coordinate is within the zone.

Defined in:

Parameter:

Core.Point#COORDINATE Coordinate

The coordinate to test.

Return value:

#boolean:

true if the coordinate is within the zone.

ZONE_OVAL:IsPointVec2InZone(Coordinate)

ZONE_OVAL:OnAfterEnteredZone(From, Event, To, Controllable)

On After "EnteredZone" event.

An observed object has entered the zone.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Wrapper.Controllable#CONTROLLABLE Controllable

The controllable entering the zone.

ZONE_OVAL:OnAfterLeftZone(From, Event, To, Controllable)

On After "LeftZone" event.

An observed object has left the zone.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Wrapper.Controllable#CONTROLLABLE Controllable

The controllable leaving the zone.

ZONE_OVAL:SetCheckTime(seconds)

Set the check time for ZONE:Trigger()

Defined in:

Parameter:

#number seconds

Check every seconds for objects entering or leaving the zone. Defaults to 5 secs.

Return value:

self

ZONE_OVAL:SetColor(RGBcolor, Alpha)

Set color of zone.

Defined in:

Parameters:

#table RGBcolor

RGB color table. Default {1, 0, 0}.

#number Alpha

Transparency between 0 and 1. Default 0.15.

Return value:

self

ZONE_OVAL:SetDrawCoalition(Coalition)

Set draw coalition of zone.

Defined in:

Parameter:

#number Coalition

Coalition. Default -1.

Return value:

self

ZONE_OVAL:SetFillColor(RGBcolor, Alpha)

Set fill color of zone.

Defined in:

Parameters:

#table RGBcolor

RGB color table. Default {1, 0, 0}.

#number Alpha

Transparacy between 0 and 1. Default 0.15.

Return value:

self

ZONE_OVAL:SetName(ZoneName)

Sets the name of the zone.

Defined in:

Parameter:

#string ZoneName

The name of the zone.

Return value:

ZONE_OVAL:SetZoneProbability(ZoneProbability)

Set the randomization probability of a zone to be selected.

Defined in:

Parameter:

#number ZoneProbability

A value between 0 and 1. 0 = 0% and 1 = 100% probability.

Return value:

self

ZONE_OVAL:SmokeZone(SmokeColor)

Smokes the zone boundaries in a color.

Defined in:

Parameter:

Utilities.Utils#SMOKECOLOR SmokeColor

The smoke color.

ZONE_OVAL:Trigger(Objects)

Start watching if the Object or Objects move into or out of a zone.

Defined in:

Parameter:

Wrapper.Controllable#CONTROLLABLE Objects

Object or Objects to watch, can be of type UNIT, GROUP, CLIENT, or SET_UNIT, SET_GROUP, SET_CLIENT

Return value:

self

Usage:

           -- Create a new zone and start watching it every 5 secs for a defined GROUP entering or leaving
           local triggerzone = ZONE:New("ZonetoWatch"):Trigger(GROUP:FindByName("Aerial-1"))

           -- This FSM function will be called when the group enters the zone
           function triggerzone:OnAfterEnteredZone(From,Event,To,Group)
             MESSAGE:New("Group has entered zone!",15):ToAll()
           end

           -- This FSM function will be called when the group leaves the zone
           function triggerzone:OnAfterLeftZone(From,Event,To,Group)
             MESSAGE:New("Group has left zone!",15):ToAll()
           end

           -- Stop watching the zone after 1 hour
          triggerzone:__TriggerStop(3600)

ZONE_OVAL:TriggerStop()

Triggers the FSM event "TriggerStop".

Stops the ZONE_BASE Trigger.

(Internal) Check the assigned objects for being in/out of the zone

Defined in:

Parameters:

#string From

#string Event

#string to

Return value:

self

Field(s)

ZONE_OVAL.CenterVec2

ZONE_OVAL.DrawPoly

ZONE_OVAL.MajorAxis

ZONE_OVAL.MinorAxis

ZONE_OVAL.ZoneName

Function(s)

ZONE_OVAL:AddEndState(State)

Adds an End state.

Defined in:

Parameter:

#string State

The FSM state.

ZONE_OVAL:AddProcess(From, Event, Process, ReturnEvents)

Set the default #FSM_PROCESS template with key ProcessName providing the ProcessClass and the process object when it is assigned to a Wrapper.Controllable by the task.

Defined in:

Parameters:

#table From

Can contain a string indicating the From state or a table of strings containing multiple From states.

#string Event

The Event name.

Core.Fsm#FSM_PROCESS Process

An sub-process FSM.

#table ReturnEvents

A table indicating for which returned events of the SubFSM which Event must be triggered in the FSM.

Return value:

Core.Fsm#FSM_PROCESS:

The SubFSM.

ZONE_OVAL:AddScore(State, ScoreText, Score)

Adds a score for the FSM to be achieved.

Defined in:

Parameters:

#string State

is the state of the process when the score needs to be given. (See the relevant state descriptions of the process).

#string ScoreText

is a text describing the score that is given according the status.

#number Score

is a number providing the score of the status.

Return value:

self

ZONE_OVAL:AddScoreProcess(From, Event, State, ScoreText, Score)

Adds a score for the FSM_PROCESS to be achieved.

Defined in:

Parameters:

#string From

is the From State of the main process.

#string Event

is the Event of the main process.

#string State

is the state of the process when the score needs to be given. (See the relevant state descriptions of the process).

#string ScoreText

is a text describing the score that is given according the status.

#number Score

is a number providing the score of the status.

Return value:

self

ZONE_OVAL:AddTransition(From, Event, To)

Add a new transition rule to the FSM.

A transition rule defines when and if the FSM can transition from a state towards another state upon a triggered event.

Defined in:

Parameters:

#table From

Can contain a string indicating the From state or a table of strings containing multiple From states.

#string Event

The Event name.

#string To

The To state.

ZONE_OVAL:GetCurrentState()

Get current state.

Defined in:

Return value:

#string:

Current FSM state.

ZONE_OVAL:GetEndStates()

Returns the End states.

Defined in:

Return value:

#table:

End states.

#boolean:

If true, FSM is in this state.

ZONE_OVAL:LoadCallBacks(CallBackTable)

Load call backs.

Defined in:

Parameter:

#table CallBackTable

Table of call backs.

ZONE_OVAL:New()

Creates a new FSM object.

Defined in:

Return value:

ZONE_OVAL:SetProcess(From, Event, Fsm)

Defined in:

Parameters:

From

Parameters:

#string step

Step "onafter", "onbefore", "onenter", "onleave".

#string trigger

Trigger.

#table params

Parameters.

#string EventName

Event name.

Return value:

ZONE_OVAL:_gosub(ParentFrom, ParentEvent)

Go sub.

Defined in:

Parameters:

#string ParentFrom

Parent from state.

#string ParentEvent

Parent event name.

Return value:

#table:

Subs.

ZONE_OVAL:_handler(EventName, ...)

Handler.

Defined in:

Parameters:

#string EventName

Event name.

...

Arguments.

ZONE_OVAL:_isendstate(Current)

Is end state.

Defined in:

Parameter:

#string Current

Current state name.

Return values:

#table:

FSM parent.

#string:

Event name.

ZONE_OVAL:_submap(subs, sub, name)

Sub maps.

Defined in:

Parameters:

#table subs

Subs.

#table sub

Sub.

#string name

Name.

ZONE_OVAL:can(e)

Check if can do an event.

Defined in:

Parameter:

#string e

Event name.

Return values:

#boolean:

If true, FSM can do the event.

#string:

To state.

ZONE_OVAL:cannot(e)

Check if cannot do an event.

Defined in:

Parameter:

#string e

Event name.

Return value:

#boolean:

If true, FSM cannot do the event.

ZONE_OVAL:is(State, state)

Check if FSM is in state.

Defined in:

Parameters:

#string State

State name.

state

Return value:

#boolean:

If true, FSM is in this state.

Field(s)

ZONE_OVAL.CenterVec2

ZONE_OVAL.DrawPoly

ZONE_OVAL.MajorAxis

ZONE_OVAL.MinorAxis

ZONE_OVAL.ZoneName

Function(s)

ZONE_OVAL:ClearState(Object, StateName)

Clear the state of an object.

Defined in:

Parameters:

Object

The object that holds the Value set by the Key.

StateName

The key that is should be cleared.

ZONE_OVAL:CreateEventBirth(EventTime, Initiator, IniUnitName, place, subplace)

Creation of a Birth Event.

Defined in:

Parameters:

DCS#Time EventTime

Defined in:

Parameter:

Arguments

A #table or any field.

ZONE_OVAL:EventDispatcher()

Returns the event dispatcher

Defined in:

Return value:

Core.Event#EVENT:

ZONE_OVAL:EventRemoveAll()

Remove all subscribed events

Defined in:

ZONE_OVAL:GetClassNameAndID()

Get the ClassName + ClassID of the class instance.

The ClassName + ClassID is formatted as '%s#%09d'.

Defined in:

Return value:

#string:

The ClassName + ClassID of the class instance.

ZONE_OVAL:GetEventPriority()

Get the Class Core.Event processing Priority.

The Event processing Priority is a number from 1 to 10, reflecting the order of the classes subscribed to the Event to be processed.

Defined in:

Return value:

#number:

The Core.Event processing Priority.

ZONE_OVAL:GetParent(Child, FromClass)

This is the worker method to retrieve the Parent class.

Note that the Parent class must be passed to call the parent class method.

self:GetParent(self):ParentMethod()

Defined in:

Parameters:

#BASE Child

This is the Child class from which the Parent class needs to be retrieved.

#BASE FromClass

(Optional) The class from which to get the parent.

Return value:

ZONE_OVAL:GetState(Object, Key)

Get a Value given a Key from the Object.

Note that if the Object is destroyed, set to nil, or garbage collected, then the Values and Keys will also be gone.

Defined in:

Parameters:

Object

The object that holds the Value set by the Key.

Key

The key that is used to retrieve the value. Note that the key can be a #string, but it can also be any other type!

Return value:

The Value retrieved or nil if the Key was not found and thus the Value could not be retrieved.

ZONE_OVAL:HandleEvent(EventID, EventFunction)

Subscribe to a DCS Event.

Defined in:

Parameters:

Core.Event#EVENTS EventID

Event ID.

#function EventFunction

(optional) The function to be called when the event occurs for the unit.

Return value:

ZONE_OVAL:I(Arguments)

Log an information which will be traced always.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

ZONE_OVAL:Inherit(Child, Parent)

This is the worker method to inherit from a parent class.

Defined in:

Parameters:

Child

is the Child class that inherits.

#BASE Parent

is the Parent class that the Child inherits from.

Return value:

Child

ZONE_OVAL:IsInstanceOf(ClassName)

This is the worker method to check if an object is an (sub)instance of a class.

Examples:

ZONE:New( 'some zone' ):IsInstanceOf( ZONE ) will return true
ZONE:New( 'some zone' ):IsInstanceOf( 'ZONE' ) will return true
ZONE:New( 'some zone' ):IsInstanceOf( 'zone' ) will return true
ZONE:New( 'some zone' ):IsInstanceOf( 'BASE' ) will return true
ZONE:New( 'some zone' ):IsInstanceOf( 'GROUP' ) will return false

Defined in:

Parameter:

ZONE_OVAL:OnEvent(EventData)

Occurs when an Event for an object is triggered.

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that triggered the event.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

ZONE_OVAL:OnEventBDA(EventData)

BDA.

Have a look at the class Core.Event#EVENT as these are just the prototypes.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

Unknown precisely what creates this event, likely tied into newer damage model.

Will update this page when new information become available.

initiator: The unit that had the failure.

initiator: Static object representing the ejected pilot. Place : Aircraft that the pilot ejected from.
place: may not return as a valid object if the aircraft has crashed into the ground and no longer exists.
subplace: is always 0 for unknown reasons.

Core.Event#EVENTDATA EventData

The EventData structure.

ZONE_OVAL:OnEventPilotDead(EventData)

Occurs when the pilot of an aircraft is killed.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

Have a look at the class Core.Event#EVENT as these are just the prototypes.

initiator: The unit that is was destroyed.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

ZONE_OVAL:ScheduleOnce(Start, SchedulerFunction, ...)

Schedule a new time event.

Note that the schedule will only take place if the scheduler is started. Even for a single schedule event, the scheduler needs to be started also.

Defined in:

Parameters:

#number Start

Specifies the amount of seconds that will be waited before the scheduling is started, and the event function is called.

#function SchedulerFunction

The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.

#table ...

Optional arguments that can be given as part of scheduler. The arguments need to be given as a table { param1, param 2, ... }.

Return value:

#string:

The Schedule ID of the planned schedule.

ZONE_OVAL:ScheduleRepeat(Start, Repeat, RandomizeFactor, Stop, SchedulerFunction, ...)

Schedule a new time event.

Note that the schedule will only take place if the scheduler is started. Even for a single schedule event, the scheduler needs to be started also.

Defined in:

Parameters:

#number Start

Specifies the amount of seconds that will be waited before the scheduling is started, and the event function is called.

#number Repeat

Specifies the interval in seconds when the scheduler will call the event function.

#number RandomizeFactor

Specifies a randomization factor between 0 and 1 to randomize the Repeat.

#number Stop

Specifies the amount of seconds when the scheduler will be stopped.

#function SchedulerFunction

The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.

#table ...

Optional arguments that can be given as part of scheduler. The arguments need to be given as a table { param1, param 2, ... }.

Return value:

#string:

The Schedule ID of the planned schedule.

ZONE_OVAL:ScheduleStop(SchedulerID)

Stops the Schedule.

Defined in:

Parameter:

#string SchedulerID

(Optional) Scheduler ID to be stopped. If nil, all pending schedules are stopped.

ZONE_OVAL:SetEventPriority(EventPriority)

Set the Class Core.Event processing Priority.

The Event processing Priority is a number from 1 to 10, reflecting the order of the classes subscribed to the Event to be processed.

Defined in:

Parameter:

#number EventPriority

The Core.Event processing Priority.

Return value:

self

ZONE_OVAL:SetState(Object, Key, Value)

Set a state or property of the Object given a Key and a Value.

Note that if the Object is destroyed, set to nil, or garbage collected, then the Values and Keys will also be gone.

Defined in:

Parameters:

Object

The object that will hold the Value set by the Key.

Key

The key that is used as a reference of the value. Note that the key can be a #string, but it can also be any other type!

Value

The value to is stored in the object.

#number Level

ZONE_OVAL:TraceOff()

Set trace off.

Defined in:

Usage:

-- Switch the tracing Off
BASE:TraceOff()

ZONE_OVAL:TraceOn()

Set trace on.

Defined in:

Usage:

-- Switch the tracing On
BASE:TraceOn()

ZONE_OVAL:TraceOnOff(TraceOnOff)

Set trace on or off Note that when trace is off, no BASE.Debug statement is performed, increasing performance! When Moose is loaded statically, (as one file), tracing is switched off by default.

So tracing must be switched on manually in your mission if you are using Moose statically. When moose is loading dynamically (for moose class development), tracing is switched on by default.

Defined in:

Parameter:

#boolean TraceOnOff

Switch the tracing on or off.

Usage:


  -- Switch the tracing On
  BASE:TraceOnOff( true )

  -- Switch the tracing Off
  BASE:TraceOnOff( false )

ZONE_OVAL:UnHandleEvent(EventID)

UnSubscribe to a DCS event.

Defined in:

Parameter:

Core.Event#EVENTS EventID

Event ID.

Return value:

ZONE_OVAL:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function call.

The main event handling function...

This function captures all events generated for the class.

Defined in:

Parameter:

DCS#Event event

Type ZONE_POLYGON

Field(s)

#table ZONE_POLYGON.ScanData

Core.Set#SET_GROUP ZONE_POLYGON.ScanSetGroup

Function(s)

ZONE_POLYGON:CheckScannedCoalition(Coalition)

Check if a certain coalition is inside a scanned zone.

Defined in:

ZONE_POLYGON

Parameter:

self

ZONE_POLYGON:GetScannedCoalition(Coalition)

Get Coalitions of the units in the Zone, or Check if there are units of the given Coalition in the Zone.

Returns nil if there are none to two Coalitions in the zone! Returns one Coalition if there are only Units of one Coalition in the Zone. Returns the Coalition for the given Coalition if there are units of the Coalition in the Zone.

Defined in:

ZONE_POLYGON

Parameter:

Coalition

#table:

Table of DCS units and DCS statics inside the zone.

ZONE_POLYGON:IsAllInZoneOfCoalition(Coalition)

Is All in Zone of Coalition?

Check if only the specified coalition is inside the zone and noone else.

Defined in:

ZONE_POLYGON

Parameter:

#number Coalition

Coalition ID of the coalition which is checked to be the only one in the zone.

Return value:

#boolean:

True, if only that coalition is inside the zone and no one else.

Usage:

   self.Zone:Scan()
   local IsGuarded = self.Zone:IsAllInZoneOfCoalition( self.Coalition )

ZONE_POLYGON:IsAllInZoneOfOtherCoalition(Coalition)

Is All in Zone of Other Coalition?

Check if only one coalition is inside the zone and the specified coalition is not the one. You first need to use the ZONE_POLYGON.Scan method to scan the zone before it can be evaluated! Note that once a zone has been scanned, multiple evaluations can be done on the scan result set.

Defined in:

ZONE_POLYGON

Parameter:

#number Coalition

Coalition ID of the coalition which is not supposed to be in the zone.

Return value:

#boolean:

True, if and only if only one coalition is inside the zone and the specified coalition is not it.

Usage:

   self.Zone:Scan()
   local IsCaptured = self.Zone:IsAllInZoneOfOtherCoalition( self.Coalition )

ZONE_POLYGON:IsNoneInZone()

Is None in Zone?

You first need to use the ZONE_POLYGON.Scan method to scan the zone before it can be evaluated! Note that once a zone has been scanned, multiple evaluations can be done on the scan result set.

Defined in:

ZONE_POLYGON

Return value:

#boolean:

Usage:

   self.Zone:Scan()
   local IsEmpty = self.Zone:IsNoneInZone()

ZONE_POLYGON:IsNoneInZoneOfCoalition(Coalition)

Is None in Zone of Coalition?

You first need to use the ZONE_POLYGON.Scan method to scan the zone before it can be evaluated! Note that once a zone has been scanned, multiple evaluations can be done on the scan result set.

Defined in:

ZONE_POLYGON

Parameter:

Coalition

Return value:

#boolean:

Usage:

   self.Zone:Scan()
   local IsOccupied = self.Zone:IsNoneInZoneOfCoalition( self.Coalition )

ZONE_POLYGON:IsSomeInZoneOfCoalition(Coalition)

Is Some in Zone of Coalition?

Check if more than one coalition is inside the zone and the specified coalition is one of them. You first need to use the ZONE_POLYGON.Scan method to scan the zone before it can be evaluated! Note that once a zone has been scanned, multiple evaluations can be done on the scan result set.

Defined in:

ZONE_POLYGON

Parameter:

#number Coalition

ID of the coalition which is checked to be inside the zone.

Return value:

#boolean:

True if more than one coalition is inside the zone and the specified coalition is one of them.

Usage:

   self.Zone:Scan()
   local IsAttacked = self.Zone:IsSomeInZoneOfCoalition( self.Coalition )

ZONE_POLYGON:New(ZoneName, ZoneGroup)

Constructor to create a ZONE_POLYGON instance, taking the zone name and the Wrapper.Group#GROUP defined within the Mission Editor.

The Wrapper.Group#GROUP waypoints define the polygon corners. The first and the last point are automatically connected by ZONE_POLYGON.

Defined in:

ZONE_POLYGON

Parameters:

#string ZoneName

Name of the zone.

Wrapper.Group#GROUP ZoneGroup

The GROUP waypoints as defined within the Mission Editor define the polygon shape.

Return value:

self

ZONE_POLYGON:NewFromDrawing(DrawingName)

Constructor to create a ZONE_POLYGON instance, taking the name of a drawing made with the draw tool in the Mission Editor.

Defined in:

ZONE_POLYGON

Parameter:

#string DrawingName

The name of the drawing in the Mission Editor

Return value:

self

ZONE_POLYGON:NewFromGroupName(GroupName)

Constructor to create a ZONE_POLYGON instance, taking the zone name and the name of the Wrapper.Group#GROUP defined within the Mission Editor.

The Wrapper.Group#GROUP waypoints define the polygon corners. The first and the last point are automatically connected by ZONE_POLYGON.

Defined in:

ZONE_POLYGON

Parameter:

#string GroupName

The group name of the GROUP defining the waypoints within the Mission Editor to define the polygon shape.

Return value:

self

ZONE_POLYGON:NewFromPointsArray(ZoneName, PointsArray)

Constructor to create a ZONE_POLYGON instance, taking the zone name and an array of DCS#Vec2, forming a polygon.

Defined in:

ZONE_POLYGON

Parameters:

#string ZoneName

Name of the zone.

#ZONE_POLYGON_BASE.ListVec2 PointsArray

An array of DCS#Vec2, forming a polygon.

Return value:

self

ZONE_POLYGON:Scan(ObjectCategories, UnitCategories)

Scan the zone for the presence of units of the given ObjectCategories.

Does not scan for scenery at the moment. Note that only after a zone has been scanned, the zone can be evaluated by:

Core.Zone#ZONE_POLYGON.IsAllInZoneOfCoalition(): Scan the presence of units in the zone of a coalition.
Core.Zone#ZONE_POLYGON.IsAllInZoneOfOtherCoalition(): Scan the presence of units in the zone of an other coalition.
Core.Zone#ZONE_POLYGON.IsSomeInZoneOfCoalition(): Scan if there is some presence of units in the zone of the given coalition.
Core.Zone#ZONE_POLYGON.IsNoneInZoneOfCoalition(): Scan if there isn't any presence of units in the zone of an other coalition than the given one.
Core.Zone#ZONE_POLYGON.IsNoneInZone(): Scan if the zone is empty.

Defined in:

ZONE_POLYGON

Parameters:

ObjectCategories

An array of categories of the objects to find in the zone. E.g. {Object.Category.UNIT}

UnitCategories

An array of unit categories of the objects to find in the zone. E.g. {Unit.Category.GROUND_UNIT,Unit.Category.SHIP}

Usage:

   myzone:Scan({Object.Category.UNIT},{Unit.Category.GROUND_UNIT})
   local IsAttacked = myzone:IsSomeInZoneOfCoalition( self.Coalition )

Type ZONE_POLYGON_BASE

Field(s)

#table ZONE_POLYGON_BASE.Borderlines

#table ZONE_POLYGON_BASE.DrawID

#table ZONE_POLYGON_BASE.FillTriangles

#ZONE_POLYGON_BASE.ListVec2 ZONE_POLYGON_BASE.Polygon

The polygon defined by an array of DCS#Vec2.

#number ZONE_POLYGON_BASE.SurfaceArea

#table ZONE_POLYGON_BASE._Triangles

Function(s)

ZONE_POLYGON_BASE:BoundZone(UnBound)

Smokes the zone boundaries in a color.

Defined in:

ZONE_POLYGON_BASE

Parameter:

#boolean UnBound

If true, the tyres will be destroyed.

Return value:

self

ZONE_POLYGON_BASE:Boundary(Coalition, Color, Radius, Alpha, Segments, Closed)

Draw a frontier on the F10 map with small filled circles.

Defined in:

ZONE_POLYGON_BASE

Parameters:

#number Coalition

(Optional) Coalition: All=-1, Neutral=0, Red=1, Blue=2. Default -1= All.

#table Color

(Optional) RGB color table {r, g, b}, e.g. {1, 0, 0} for red. Default {1, 1, 1}= White.

#number Radius

(Optional) Radius of the circles in meters. Default 1000.

#number Alpha

(Optional) Alpha transparency [0,1]. Default 1.

#number Segments

(Optional) Number of segments within boundary line. Default 10.

#boolean Closed

(Optional) Link the last point with the first one to obtain a closed boundary. Default false

Return value:

self

ZONE_POLYGON_BASE:DrawZone(Coalition, Color, Alpha, FillColor, FillAlpha, LineType, ReadOnly, IncludeTriangles)

Draw the zone on the F10 map.

Infinite number of points supported - ported from https://github.com/nielsvaes/CCMOOSE/blob/master/Moose%20Development/Moose/Shapes/Polygon.lua

Defined in:

ZONE_POLYGON_BASE

Parameters:

#number Coalition

Coalition: All=-1, Neutral=0, Red=1, Blue=2. Default -1=All.

#table Color

RGB color table {r, g, b}, e.g. {1,0,0} for red.

#number Alpha

Transparency [0,1]. Default 1.

#table FillColor

RGB color table {r, g, b}, e.g. {1,0,0} for red. Default is same as Color value. -- doesn't seem to work

#number FillAlpha

Transparency [0,1]. Default 0.15. -- doesn't seem to work

#number LineType

Line type: 0=No line, 1=Solid, 2=Dashed, 3=Dotted, 4=Dot dash, 5=Long dash, 6=Two dash. Default 1=Solid.

#boolean ReadOnly

(Optional) Mark is readonly and cannot be removed by users. Default false.s

IncludeTriangles

Return value:

self

ZONE_POLYGON_BASE:FlareZone(FlareColor, Segments, Azimuth, AddHeight)

Flare the zone boundaries in a color.

Defined in:

ZONE_POLYGON_BASE

Parameters:

Utilities.Utils#FLARECOLOR FlareColor

The flare color.

#number Segments

(Optional) Number of segments within boundary line. Default 10.

DCS#Azimuth Azimuth

ZONE_POLYGON_BASE:GetRandomPointVec2()

Return a Core.Point#POINT_VEC2 object representing a random 2D point at landheight within the zone.

Note that this is actually a Core.Point#COORDINATE type object, and not a simple Vec2 table.

Defined in:

ZONE_POLYGON_BASE

Return value:

Core.Point#POINT_VEC2

ZONE_POLYGON_BASE:GetRandomPointVec3()

Return a Core.Point#POINT_VEC3 object representing a random 3D point at landheight within the zone.

Note that this is actually a Core.Point#COORDINATE type object, and not a simple Vec3 table.

Defined in:

Return value:

#number:

Surface area

ZONE_POLYGON_BASE:GetVec2()

Returns the center location of the polygon.

#table:

List of COORDINATES verticies defining the edges of the polygon.

ZONE_POLYGON_BASE:GetVerticiesVec2()

Get a list of verticies of the polygon.

Defined in:

ZONE_POLYGON_BASE

Return value:

List of DCS#Vec2 verticies defining the edges of the polygon.

ZONE_POLYGON_BASE:GetVerticiesVec3()

Get a list of verticies of the polygon.

Defined in:

ZONE_POLYGON_BASE

Return value:

#table:

List of DCS#Vec3 verticies defining the edges of the polygon.

ZONE_POLYGON_BASE:GetZoneQuad(ZoneName, DoNotRegisterZone)

Get the smallest rectangular zone encompassing all points points of the polygon zone.

Defined in:

ZONE_POLYGON_BASE

Parameters:

#string ZoneName

(Optional) Name of the zone. Default is the name of the polygon zone.

#boolean DoNotRegisterZone

(Optional) If true, zone is not registered.

Return value:

The rectangular zone.

ZONE_POLYGON_BASE:GetZoneRadius(ZoneName, DoNotRegisterZone)

Get the smallest circular zone encompassing all points of the polygon zone.

Defined in:

Parameter:

DCS#Vec3 Vec3

The point to test.

Return value:

#boolean:

true if the point is within the zone.

ZONE_POLYGON_BASE:New(ZoneName, PointsArray)

Constructor to create a ZONE_POLYGON_BASE instance, taking the zone name and an array of DCS#Vec2, forming a polygon.

The Wrapper.Group#GROUP waypoints define the polygon corners. The first and the last point are automatically connected.

Defined in:

ZONE_POLYGON_BASE

Parameters:

#string ZoneName

Name of the zone.

#ZONE_POLYGON_BASE.ListVec2 PointsArray

An array of DCS#Vec2, forming a polygon.

Return value:

self

ZONE_POLYGON_BASE:ReDrawBorderline(Color, Alpha, LineType)

Change/Re-draw the border of a Polygon Zone

Defined in:

ZONE_POLYGON_BASE

Parameters:

#table Color

RGB color table {r, g, b}, e.g. {1,0,0} for red.

#number Alpha

Transparency [0,1]. Default 1.

#number LineType

Line type: 0=No line, 1=Solid, 2=Dashed, 3=Dotted, 4=Dot dash, 5=Long dash, 6=Two dash. Default 1=Solid.

Return value:

ZONE_POLYGON_BASE:ReFill(Color, Alpha)

Change/Re-fill a Polygon Zone

Defined in:

Parameters:

Utilities.Utils#SMOKECOLOR SmokeColor

The smoke color.

#number Segments

(Optional) Number of segments within boundary line. Default 10.

Return value:

self

ZONE_POLYGON_BASE:UpdateFromVec2(Vec2Array)

Update polygon points with an array of DCS#Vec2.

Defined in:

ZONE_POLYGON_BASE

Parameter:

#ZONE_POLYGON_BASE.ListVec2 Vec2Array

An array of DCS#Vec2, forming a polygon.

Return value:

self

ZONE_POLYGON_BASE:UpdateFromVec3(Vec2Array, Vec3Array)

Update polygon points with an array of DCS#Vec3.

Defined in:

ZONE_POLYGON_BASE

Parameters:

#ZONE_POLYGON_BASE.ListVec3 Vec2Array

An array of DCS#Vec3, forming a polygon.

Vec3Array

Return value:

self

ZONE_POLYGON_BASE:_CalculateSurfaceArea()

Calculates the surface area of the polygon.

The surface area is the sum of the areas of the triangles that make up the polygon. - ported from https://github.com/nielsvaes/CCMOOSE/blob/master/Moose%20Development/Moose/Shapes/Polygon.lua

Defined in:

ZONE_POLYGON_BASE

Return value:

#number:

The surface area of the polygon

ZONE_POLYGON_BASE:_Triangulate()

Triangulates the polygon.

ported from https://github.com/nielsvaes/CCMOOSE/blob/master/Moose%20Development/Moose/Shapes/Polygon.lua

Defined in:

ZONE_POLYGON_BASE

Return value:

#table:

The #ZONETRIANGLE list that makes up the polygon

Type ZONE_RADIUS

The ZONE_RADIUS class, defined by a zone name, a location and a radius.

Field(s)

ZONE_RADIUS.DrawID

DCS#Distance ZONE_RADIUS.Radius

The radius of the zone.

#table ZONE_RADIUS.ScanData

Core.Set#SET_GROUP ZONE_RADIUS.ScanSetGroup

DCS#Vec2 ZONE_RADIUS.Vec2

The current location of the zone.

Function(s)

ZONE_RADIUS:BoundZone(Points, CountryID, UnBound)

Bounds the zone with tires.

Defined in:

ZONE_RADIUS

Parameters:

#number Points

(optional) The amount of points in the circle. Default 360.

DCS#country.id CountryID

The country id of the tire objects, e.g. country.id.USA for blue or country.id.RUSSIA for red.

#boolean UnBound

(Optional) If true the tyres will be destroyed.

Return value:

self

ZONE_RADIUS:CheckScannedCoalition(Coalition)

Check if a certain coalition is inside a scanned zone.

Defined in:

ZONE_RADIUS

Parameter:

#number Coalition

The coalition id, e.g. coalition.side.BLUE.

Return value:

#boolean:

If true, the coalition is inside the zone.

ZONE_RADIUS:CountScannedCoalitions()

Count the number of different coalitions inside the zone.

Defined in:

ZONE_RADIUS

Return value:

#number:

Counted coalitions.

ZONE_RADIUS:DrawZone(Coalition, Color, Alpha, FillColor, FillAlpha, LineType, ReadOnly)

Draw the zone circle on the F10 map.

Defined in:

ZONE_RADIUS

Parameters:

#number Coalition

Coalition: All=-1, Neutral=0, Red=1, Blue=2. Default -1=All.

#table Color

RGB color table {r, g, b}, e.g. {1,0,0} for red.

#number Alpha

Transparency [0,1]. Default 1.

#table FillColor

RGB color table {r, g, b}, e.g. {1,0,0} for red. Default is same as Color value.

#number FillAlpha

Transparency [0,1]. Default 0.15.

#number LineType

Line type: 0=No line, 1=Solid, 2=Dashed, 3=Dotted, 4=Dot dash, 5=Long dash, 6=Two dash. Default 1=Solid.

#boolean ReadOnly

(Optional) Mark is readonly and cannot be removed by users. Default false.

Return value:

self

ZONE_RADIUS:FlareZone(FlareColor, Points, Azimuth, AddHeight)

Flares the zone boundaries in a color.

Defined in:

ZONE_RADIUS

Parameters:

Utilities.Utils#FLARECOLOR FlareColor

The flare color.

#number Points

(optional) The amount of points in the circle.

DCS#Azimuth Azimuth

(optional) Azimuth The azimuth of the flare.

#number AddHeight

(optional) The height to be added for the smoke.

Return value:

self

ZONE_RADIUS:GetRadius()

Returns the radius of the zone.

Defined in:

ZONE_RADIUS

Return value:

DCS#Distance:

The radius of the zone.

ZONE_RADIUS:GetRandomCoordinate(inner, outer, surfacetypes)

Returns a Core.Point#COORDINATE object reflecting a random 3D location within the zone.

Defined in:

ZONE_RADIUS

Parameters:

#number inner

(Optional) Minimal distance from the center of the zone in meters. Default is 0 m.

#number outer

(Optional) Maximal distance from the outer edge of the zone in meters. Default is the radius of the zone.

#table surfacetypes

(Optional) Table of surface types. Can also be a single surface type. We will try max 100 times to find the right type!

Return value:

The random coordinate.

ZONE_RADIUS:GetRandomCoordinateWithoutBuildings(inner, outer, distance, markbuildings, markfinal)

Returns a Core.Point#COORDINATE object reflecting a random location within the zone where there are no map objects of type "Building".

Does not find statics you might have placed there. Note This might be quite CPU intensive, use with care.

Defined in:

ZONE_RADIUS

Parameters:

#number inner

(Optional) Minimal distance from the center of the zone in meters. Default is 0m.

#number outer

(Optional) Maximal distance from the outer edge of the zone in meters. Default is the radius of the zone.

#number distance

(Optional) Minimum distance from any building coordinate. Defaults to 100m.

#boolean markbuildings

(Optional) Place markers on found buildings (if any).

#boolean markfinal

(Optional) Place marker on the final coordinate (if any).

Return value:

The random coordinate or nil if cannot be found in 1000 iterations.

ZONE_RADIUS:GetRandomPointVec2(inner, outer)

Returns a Core.Point#POINT_VEC2 object reflecting a random 2D location within the zone.

Note that this is actually a Core.Point#COORDINATE type object, and not a simple Vec2 table.

Defined in:

ZONE_RADIUS

Parameters:

#number inner

(optional) Minimal distance from the center of the zone. Default is 0.

#number outer

(optional) Maximal distance from the outer edge of the zone. Default is the radius of the zone.

Return value:

The Core.Point#POINT_VEC2 object reflecting the random 3D location within the zone.

ZONE_RADIUS:GetRandomPointVec3(inner, outer)

Returns a Core.Point#POINT_VEC3 object reflecting a random 3D location within the zone.

Note that this is actually a Core.Point#COORDINATE type object, and not a simple Vec3 table.

Defined in:

ZONE_RADIUS

Parameters:

#number inner

(optional) Minimal distance from the center of the zone. Default is 0.

#number outer

(optional) Maximal distance from the outer edge of the zone. Default is the radius of the zone.

Return value:

The Core.Point#POINT_VEC3 object reflecting the random 3D location within the zone.

ZONE_RADIUS:GetRandomVec2(inner, outer, surfacetypes)

Returns a random Vec2 location within the zone.

Defined in:

ZONE_RADIUS

Parameters:

#number inner

(Optional) Minimal distance from the center of the zone. Default is 0.

#number outer

(Optional) Maximal distance from the outer edge of the zone. Default is the radius of the zone.

#table surfacetypes

(Optional) Table of surface types. Can also be a single surface type. We will try max 100 times to find the right type!

Return value:

DCS#Vec2:

The random location within the zone.

ZONE_RADIUS:GetRandomVec3(inner, outer)

Returns Returns a random Vec3 location within the zone.

Defined in:

ZONE_RADIUS

Parameters:

#number inner

(optional) Minimal distance from the center of the zone. Default is 0.

#number outer

(optional) Maximal distance from the outer edge of the zone. Default is the radius of the zone.

Return value:

The random location within the zone.

ZONE_RADIUS:GetScannedCoalition(Coalition)

Get Coalitions of the units in the Zone, or Check if there are units of the given Coalition in the Zone.

Defined in:

ZONE_RADIUS

Parameter:

Coalition

DCS#Distance Height

The height to add to the land height where the center of the zone is located.

Return value:

The point of the zone.

ZONE_RADIUS:IsAllInZoneOfCoalition(Coalition)

Is All in Zone of Coalition?

Check if only the specified coalition is inside the zone and no one else.

Defined in:

ZONE_RADIUS

Parameter:

#number Coalition

Coalition ID of the coalition which is checked to be the only one in the zone.

Return value:

#boolean:

True, if only that coalition is inside the zone and no one else.

Usage:

   self.Zone:Scan()
   local IsGuarded = self.Zone:IsAllInZoneOfCoalition( self.Coalition )

ZONE_RADIUS:IsAllInZoneOfOtherCoalition(Coalition)

Is All in Zone of Other Coalition?

Check if only one coalition is inside the zone and the specified coalition is not the one. You first need to use the ZONE_RADIUS.Scan method to scan the zone before it can be evaluated! Note that once a zone has been scanned, multiple evaluations can be done on the scan result set.

Defined in:

ZONE_RADIUS

Parameter:

#number Coalition

Coalition ID of the coalition which is not supposed to be in the zone.

Return value:

#boolean:

True, if and only if only one coalition is inside the zone and the specified coalition is not it.

Usage:

   self.Zone:Scan()
   local IsCaptured = self.Zone:IsAllInZoneOfOtherCoalition( self.Coalition )

ZONE_RADIUS:IsNoneInZone()

Is None in Zone?

You first need to use the ZONE_RADIUS.Scan method to scan the zone before it can be evaluated! Note that once a zone has been scanned, multiple evaluations can be done on the scan result set.

Defined in:

ZONE_RADIUS

Return value:

#boolean:

Usage:

   self.Zone:Scan()
   local IsEmpty = self.Zone:IsNoneInZone()

ZONE_RADIUS:IsNoneInZoneOfCoalition(Coalition)

Is None in Zone of Coalition?

You first need to use the ZONE_RADIUS.Scan method to scan the zone before it can be evaluated! Note that once a zone has been scanned, multiple evaluations can be done on the scan result set.

Defined in:

ZONE_RADIUS

Parameter:

Coalition

Return value:

#boolean:

Usage:

   self.Zone:Scan()
   local IsOccupied = self.Zone:IsNoneInZoneOfCoalition( self.Coalition )

ZONE_RADIUS:IsSomeInZoneOfCoalition(Coalition)

Is Some in Zone of Coalition?

Check if more than one coalition is inside the zone and the specified coalition is one of them. You first need to use the ZONE_RADIUS.Scan method to scan the zone before it can be evaluated! Note that once a zone has been scanned, multiple evaluations can be done on the scan result set.

Defined in:

ZONE_RADIUS

Parameter:

#number Coalition

ID of the coalition which is checked to be inside the zone.

Return value:

#boolean:

True if more than one coalition is inside the zone and the specified coalition is one of them.

Usage:

   self.Zone:Scan()
   local IsAttacked = self.Zone:IsSomeInZoneOfCoalition( self.Coalition )

The radius of the zone.

DCS#Boolean DoNotRegisterZone

Determines if the Zone should not be registered in the _Database Table. Default=false

Return value:

self

ZONE_RADIUS:RemoveJunk()

Remove junk inside the zone using the world.removeJunk function.

Defined in:

ZONE_RADIUS

Return value:

#number:

Number of deleted objects.

ZONE_RADIUS:Scan(ObjectCategories, UnitCategories)

Scan the zone for the presence of units of the given ObjectCategories.

Note that only after a zone has been scanned, the zone can be evaluated by:

Core.Zone#ZONE_RADIUS.IsAllInZoneOfCoalition(): Scan the presence of units in the zone of a coalition.
Core.Zone#ZONE_RADIUS.IsAllInZoneOfOtherCoalition(): Scan the presence of units in the zone of an other coalition.
Core.Zone#ZONE_RADIUS.IsSomeInZoneOfCoalition(): Scan if there is some presence of units in the zone of the given coalition.
Core.Zone#ZONE_RADIUS.IsNoneInZoneOfCoalition(): Scan if there isn't any presence of units in the zone of an other coalition than the given one.
Core.Zone#ZONE_RADIUS.IsNoneInZone(): Scan if the zone is empty.

Defined in:

ZONE_RADIUS

Parameters:

ObjectCategories

An array of categories of the objects to find in the zone. E.g. {Object.Category.UNIT}

UnitCategories

An array of unit categories of the objects to find in the zone. E.g. {Unit.Category.GROUND_UNIT,Unit.Category.SHIP}

Usage:

   myzone:Scan({Object.Category.UNIT},{Unit.Category.GROUND_UNIT})
   local IsAttacked = myzone:IsSomeInZoneOfCoalition( self.Coalition )

ZONE_RADIUS:SearchZone(ObjectCategories, EvaluateFunction)

Searches the zone

Defined in:

ZONE_RADIUS

Parameters:

#number Points

(optional) The amount of points in the circle.

#number AddHeight

(optional) The height to be added for the smoke.

#number AddOffSet

(optional) The angle to be added for the smoking start position.

AngleOffset

Return value:

self

ZONE_RADIUS:UpdateFromVec2(Vec2, Radius)

Update zone from a 2D vector.

Defined in:

ZONE_RADIUS

Parameters:

DCS#Vec2 Vec2

The location of the zone.

DCS#Distance Radius

The radius of the zone.

Return value:

self

ZONE_RADIUS:UpdateFromVec3(Vec3, Radius)

Update zone from a 2D vector.

Defined in:

ZONE_RADIUS

Parameters:

DCS#Vec3 Vec3

The location of the zone.

DCS#Distance Radius

The radius of the zone.

Return value:

self

Type ZONE_UNIT

Field(s)

ZONE_UNIT.LastVec2

DCS#Distance Height

The height to add to the land height where the center of the zone is located.

Return value:

The point of the zone.

ZONE_UNIT:New(ZoneName, ZoneUNIT, Radius, Offset)

Constructor to create a ZONE_UNIT instance, taking the zone name, a zone unit and a radius and optional offsets in X and Y directions.

Defined in:

ZONE_UNIT

Parameters:

#string ZoneName

Name of the zone.

Wrapper.Unit#UNIT ZoneUNIT

The unit as the center of the zone.

#number Radius

The radius of the zone in meters.

#table Offset

A table specifying the offset. The offset table may have the following elements: dx The offset in X direction, +x is north. dy The offset in Y direction, +y is east. rho The distance of the zone from the unit theta The azimuth of the zone relative to unit relative_to_unit If true, theta is measured clockwise from unit's direction else clockwise from north. If using dx, dy setting this to true makes +x parallel to unit heading. dx, dy OR rho, theta may be used, not both.

Return value:

#ZONE_UNIT:

self

Field(s)

ZONE_UNIT.LastVec2

Wrapper.Unit#UNIT ZONE_UNIT.ZoneUNIT

Function(s)

ZONE_UNIT:BoundZone(Points, CountryID, UnBound)

Bounds the zone with tires.

Defined in:

Parameters:

#number Points

(optional) The amount of points in the circle. Default 360.

DCS#country.id CountryID

The country id of the tire objects, e.g. country.id.USA for blue or country.id.RUSSIA for red.

#boolean UnBound

(Optional) If true the tyres will be destroyed.

Return value:

self

ZONE_UNIT:CheckScannedCoalition(Coalition)

Check if a certain coalition is inside a scanned zone.

Defined in:

Parameter:

#number Coalition

The coalition id, e.g. coalition.side.BLUE.

Return value:

#boolean:

If true, the coalition is inside the zone.

ZONE_UNIT:CountScannedCoalitions()

Count the number of different coalitions inside the zone.

Defined in:

Return value:

#number:

Counted coalitions.

ZONE_UNIT:DrawZone(Coalition, Color, Alpha, FillColor, FillAlpha, LineType, ReadOnly)

Draw the zone circle on the F10 map.

Defined in:

Parameters:

#number Coalition

Coalition: All=-1, Neutral=0, Red=1, Blue=2. Default -1=All.

#table Color

RGB color table {r, g, b}, e.g. {1,0,0} for red.

#number Alpha

Transparency [0,1]. Default 1.

#table FillColor

RGB color table {r, g, b}, e.g. {1,0,0} for red. Default is same as Color value.

#number FillAlpha

Transparency [0,1]. Default 0.15.

#number LineType

Line type: 0=No line, 1=Solid, 2=Dashed, 3=Dotted, 4=Dot dash, 5=Long dash, 6=Two dash. Default 1=Solid.

#boolean ReadOnly

(Optional) Mark is readonly and cannot be removed by users. Default false.

Return value:

self

ZONE_UNIT:FlareZone(FlareColor, Points, Azimuth, AddHeight)

Flares the zone boundaries in a color.

Defined in:

Parameters:

Utilities.Utils#FLARECOLOR FlareColor

The flare color.

#number Points

(optional) The amount of points in the circle.

DCS#Azimuth Azimuth

(optional) Azimuth The azimuth of the flare.

#number AddHeight

(optional) The height to be added for the smoke.

Return value:

self

ZONE_UNIT:GetRadius()

Returns the radius of the zone.

Defined in:

Return value:

DCS#Distance:

The radius of the zone.

ZONE_UNIT:GetRandomCoordinate(inner, outer, surfacetypes)

Returns a Core.Point#COORDINATE object reflecting a random 3D location within the zone.

Defined in:

Parameters:

#number inner

(Optional) Minimal distance from the center of the zone in meters. Default is 0 m.

#number outer

(Optional) Maximal distance from the outer edge of the zone in meters. Default is the radius of the zone.

#table surfacetypes

(Optional) Table of surface types. Can also be a single surface type. We will try max 100 times to find the right type!

Return value:

The random coordinate.

ZONE_UNIT:GetRandomCoordinateWithoutBuildings(inner, outer, distance, markbuildings, markfinal)

Returns a Core.Point#COORDINATE object reflecting a random location within the zone where there are no map objects of type "Building".

Does not find statics you might have placed there. Note This might be quite CPU intensive, use with care.

Defined in:

Parameters:

#number inner

(Optional) Minimal distance from the center of the zone in meters. Default is 0m.

#number outer

(Optional) Maximal distance from the outer edge of the zone in meters. Default is the radius of the zone.

#number distance

(Optional) Minimum distance from any building coordinate. Defaults to 100m.

#boolean markbuildings

(Optional) Place markers on found buildings (if any).

#boolean markfinal

(Optional) Place marker on the final coordinate (if any).

Return value:

The random coordinate or nil if cannot be found in 1000 iterations.

ZONE_UNIT:GetRandomPointVec2(inner, outer)

Returns a Core.Point#POINT_VEC2 object reflecting a random 2D location within the zone.

Note that this is actually a Core.Point#COORDINATE type object, and not a simple Vec2 table.

Defined in:

Parameters:

#number inner

(optional) Minimal distance from the center of the zone. Default is 0.

#number outer

(optional) Maximal distance from the outer edge of the zone. Default is the radius of the zone.

Return value:

The Core.Point#POINT_VEC2 object reflecting the random 3D location within the zone.

ZONE_UNIT:GetRandomPointVec3(inner, outer)

Returns a Core.Point#POINT_VEC3 object reflecting a random 3D location within the zone.

Note that this is actually a Core.Point#COORDINATE type object, and not a simple Vec3 table.

Defined in:

Parameters:

#number inner

(optional) Minimal distance from the center of the zone. Default is 0.

#number outer

(optional) Maximal distance from the outer edge of the zone. Default is the radius of the zone.

Return value:

The Core.Point#POINT_VEC3 object reflecting the random 3D location within the zone.

ZONE_UNIT:GetRandomVec2(inner, outer, surfacetypes)

Returns a random Vec2 location within the zone.

Defined in:

Parameters:

#number inner

(Optional) Minimal distance from the center of the zone. Default is 0.

#number outer

(Optional) Maximal distance from the outer edge of the zone. Default is the radius of the zone.

#table surfacetypes

(Optional) Table of surface types. Can also be a single surface type. We will try max 100 times to find the right type!

Return value:

DCS#Vec2:

The random location within the zone.

ZONE_UNIT:GetRandomVec3(inner, outer)

Returns Returns a random Vec3 location within the zone.

Defined in:

Parameters:

#number inner

(optional) Minimal distance from the center of the zone. Default is 0.

#number outer

(optional) Maximal distance from the outer edge of the zone. Default is the radius of the zone.

Return value:

The random location within the zone.

ZONE_UNIT:GetScannedCoalition(Coalition)

Get Coalitions of the units in the Zone, or Check if there are units of the given Coalition in the Zone.

Defined in:

Parameter:

Coalition

DCS#Distance Height

The height to add to the land height where the center of the zone is located.

Return value:

The point of the zone.

ZONE_UNIT:IsAllInZoneOfCoalition(Coalition)

Is All in Zone of Coalition?

Check if only the specified coalition is inside the zone and no one else.

Defined in:

Parameter:

#number Coalition

Coalition ID of the coalition which is checked to be the only one in the zone.

Return value:

#boolean:

True, if only that coalition is inside the zone and no one else.

Usage:

   self.Zone:Scan()
   local IsGuarded = self.Zone:IsAllInZoneOfCoalition( self.Coalition )

ZONE_UNIT:IsAllInZoneOfOtherCoalition(Coalition)

Is All in Zone of Other Coalition?

Defined in:

Parameter:

#number Coalition

Coalition ID of the coalition which is not supposed to be in the zone.

Return value:

#boolean:

True, if and only if only one coalition is inside the zone and the specified coalition is not it.

Usage:

   self.Zone:Scan()
   local IsCaptured = self.Zone:IsAllInZoneOfOtherCoalition( self.Coalition )

ZONE_UNIT:IsNoneInZone()

Is None in Zone?

You first need to use the ZONE_RADIUS.Scan method to scan the zone before it can be evaluated! Note that once a zone has been scanned, multiple evaluations can be done on the scan result set.

Defined in:

Return value:

#boolean:

Usage:

   self.Zone:Scan()
   local IsEmpty = self.Zone:IsNoneInZone()

ZONE_UNIT:IsNoneInZoneOfCoalition(Coalition)

Is None in Zone of Coalition?

You first need to use the ZONE_RADIUS.Scan method to scan the zone before it can be evaluated! Note that once a zone has been scanned, multiple evaluations can be done on the scan result set.

Defined in:

Parameter:

Coalition

Return value:

#boolean:

Usage:

   self.Zone:Scan()
   local IsOccupied = self.Zone:IsNoneInZoneOfCoalition( self.Coalition )

ZONE_UNIT:IsSomeInZoneOfCoalition(Coalition)

Is Some in Zone of Coalition?

Defined in:

Parameter:

#number Coalition

ID of the coalition which is checked to be inside the zone.

Return value:

#boolean:

True if more than one coalition is inside the zone and the specified coalition is one of them.

Usage:

   self.Zone:Scan()
   local IsAttacked = self.Zone:IsSomeInZoneOfCoalition( self.Coalition )

The radius of the zone.

DCS#Boolean DoNotRegisterZone

Determines if the Zone should not be registered in the _Database Table. Default=false

Return value:

self

ZONE_UNIT:RemoveJunk()

Remove junk inside the zone using the world.removeJunk function.

Defined in:

Return value:

#number:

Number of deleted objects.

ZONE_UNIT:Scan(ObjectCategories, UnitCategories)

Scan the zone for the presence of units of the given ObjectCategories.

Note that only after a zone has been scanned, the zone can be evaluated by:

Core.Zone#ZONE_RADIUS.IsAllInZoneOfCoalition(): Scan the presence of units in the zone of a coalition.
Core.Zone#ZONE_RADIUS.IsAllInZoneOfOtherCoalition(): Scan the presence of units in the zone of an other coalition.
Core.Zone#ZONE_RADIUS.IsSomeInZoneOfCoalition(): Scan if there is some presence of units in the zone of the given coalition.
Core.Zone#ZONE_RADIUS.IsNoneInZoneOfCoalition(): Scan if there isn't any presence of units in the zone of an other coalition than the given one.
Core.Zone#ZONE_RADIUS.IsNoneInZone(): Scan if the zone is empty.

Defined in:

Parameters:

ObjectCategories

An array of categories of the objects to find in the zone. E.g. {Object.Category.UNIT}

UnitCategories

An array of unit categories of the objects to find in the zone. E.g. {Unit.Category.GROUND_UNIT,Unit.Category.SHIP}

Usage:

   myzone:Scan({Object.Category.UNIT},{Unit.Category.GROUND_UNIT})
   local IsAttacked = myzone:IsSomeInZoneOfCoalition( self.Coalition )

ZONE_UNIT:SearchZone(ObjectCategories, EvaluateFunction)

Searches the zone

Defined in:

Parameters:

#number Points

Function(s)

_ZONE_TRIANGLE:ContainsPoint(pt, points)

Checks if a point is contained within the triangle.

Defined in:

ZONETRIANGLE

Parameters:

#table pt

The point to check

#table points

(optional) The points of the triangle, or 3 other points if you're just using the TRIANGLE class without an object of it

Return value:

#bool:

True if the point is contained, false otherwise

_ZONE_TRIANGLE:Draw(Coalition, Color, Alpha, FillColor, FillAlpha, LineType, ReadOnly)

Draw the triangle

Defined in:

ZONETRIANGLE

Parameters:

Coalition

Color

Alpha

FillColor

FillAlpha

LineType

ReadOnly

Return value:

#table:

of draw IDs

_ZONE_TRIANGLE:Fill(Coalition, FillColor, FillAlpha, ReadOnly)

Draw the triangle

Defined in:

ZONETRIANGLE

Parameters:

Coalition

FillColor

FillAlpha

ReadOnly

Return value:

#table:

of draw IDs

_ZONE_TRIANGLE:GetRandomVec2(points)

Returns a random Vec2 within the triangle.

Defined in:

ZONETRIANGLE

Parameter:

#table points

The points of the triangle, or 3 other points if you're just using the TRIANGLE class without an object of it

Return value:

#table:

The random Vec2

_ZONE_TRIANGLE:New(p1, p2, p3)

Defined in:

ZONETRIANGLE

Parameters:

DCS#Vec p1

DCS#Vec p2

DCS#Vec p3

Return value:

#_ZONE_TRIANGLE:

self

Field(s)

Function(s)

_ZONE_TRIANGLE:BoundZone()

Bound the zone boundaries with a tires.

Defined in:

_ZONE_TRIANGLE:Get2DDistance(Coordinate)

Get 2D distance to a coordinate.

Defined in:

Parameter:

The Coordinate of the zone.

_ZONE_TRIANGLE:GetDrawCoalition()

Get draw coalition of zone.

Defined in:

Return value:

#number:

Draw coalition.

_ZONE_TRIANGLE:GetDrawID()

Return value:

The PointVec2 of the zone.

_ZONE_TRIANGLE:GetPointVec3(Height)

Returns a Core.Point#POINT_VEC3 of the zone.

Defined in:

Parameter:

DCS#Distance Height

The height to add to the land height where the center of the zone is located.

Return value:

The PointVec3 of the zone.

_ZONE_TRIANGLE:GetProperty(PropertyName)

Returns the Value of the zone with the given PropertyName, or nil if no matching property exists.

Defined in:

Parameter:

#string PropertyName

The name of a the TriggerZone Property to be retrieved.

Return value:

#string:

The Value of the TriggerZone Property with the given PropertyName, or nil if absent.

Usage:


local PropertiesZone = ZONE:FindByName("Properties Zone")
local Property = "ExampleProperty"
local PropertyValue = PropertiesZone:GetProperty(Property)

_ZONE_TRIANGLE:GetRandomPointVec2()

Define a random Core.Point#POINT_VEC2 within the zone.

Note that this is actually a Core.Point#COORDINATE type object, and not a simple Vec2 table.

Defined in:

Return value:

The PointVec2 coordinates.

_ZONE_TRIANGLE:GetRandomPointVec3()

_ZONE_TRIANGLE:GetVec2()

Returns the DCS#Vec2 coordinate of the zone.

Defined in:

Return value:

#nil:

_ZONE_TRIANGLE:GetVec3(Height)

Returns the DCS#Vec3 of the zone.

Defined in:

Parameter:

DCS#Distance Height

The height to add to the land height where the center of the zone is located.

Return value:

The Vec3 of the zone.

_ZONE_TRIANGLE:GetZoneMaybe()

Get the zone taking into account the randomization probability of a zone to be selected.

Defined in:

Return values:

The zone is selected taking into account the randomization probability factor.

#nil:

The zone is not selected taking into account the randomization probability factor.

Usage:


local ZoneArray = { ZONE:New( "Zone1" ), ZONE:New( "Zone2" ) }

-- We set a zone probability of 70% to the first zone and 30% to the second zone.
ZoneArray[1]:SetZoneProbability( 0.5 )
ZoneArray[2]:SetZoneProbability( 0.5 )

local ZoneSelected = nil

while ZoneSelected == nil do
  for _, Zone in pairs( ZoneArray ) do
    ZoneSelected = Zone:GetZoneMaybe()
    if ZoneSelected ~= nil then
      break
    end
  end
end

-- The result should be that Zone1 would be more probable selected than Zone2.

_ZONE_TRIANGLE:GetZoneProbability()

Get the randomization probability of a zone to be selected.

Defined in:

Return value:

#number:

A value between 0 and 1. 0 = 0% and 1 = 100% probability.

_ZONE_TRIANGLE:IsCoordinateInZone(Coordinate)

Returns if a Coordinate is within the zone.

Defined in:

Parameter:

Core.Point#COORDINATE Coordinate

The coordinate to test.

Return value:

#boolean:

true if the coordinate is within the zone.

_ZONE_TRIANGLE:IsPointVec2InZone(Coordinate)

_ZONE_TRIANGLE:OnAfterEnteredZone(From, Event, To, Controllable)

On After "EnteredZone" event.

An observed object has entered the zone.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Wrapper.Controllable#CONTROLLABLE Controllable

The controllable entering the zone.

_ZONE_TRIANGLE:OnAfterLeftZone(From, Event, To, Controllable)

On After "LeftZone" event.

An observed object has left the zone.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Wrapper.Controllable#CONTROLLABLE Controllable

The controllable leaving the zone.

_ZONE_TRIANGLE:SetCheckTime(seconds)

Set the check time for ZONE:Trigger()

Defined in:

Parameter:

#number seconds

Check every seconds for objects entering or leaving the zone. Defaults to 5 secs.

Return value:

self

_ZONE_TRIANGLE:SetColor(RGBcolor, Alpha)

Set color of zone.

Defined in:

Parameters:

#table RGBcolor

RGB color table. Default {1, 0, 0}.

#number Alpha

Transparency between 0 and 1. Default 0.15.

Return value:

self

_ZONE_TRIANGLE:SetDrawCoalition(Coalition)

Set draw coalition of zone.

Defined in:

Parameter:

#number Coalition

Coalition. Default -1.

Return value:

self

_ZONE_TRIANGLE:SetFillColor(RGBcolor, Alpha)

Set fill color of zone.

Defined in:

Parameters:

#table RGBcolor

RGB color table. Default {1, 0, 0}.

#number Alpha

Transparacy between 0 and 1. Default 0.15.

Return value:

self

_ZONE_TRIANGLE:SetName(ZoneName)

Sets the name of the zone.

Defined in:

Parameter:

#string ZoneName

The name of the zone.

Return value:

_ZONE_TRIANGLE:SetZoneProbability(ZoneProbability)

Set the randomization probability of a zone to be selected.

Defined in:

Parameter:

#number ZoneProbability

A value between 0 and 1. 0 = 0% and 1 = 100% probability.

Return value:

self

_ZONE_TRIANGLE:SmokeZone(SmokeColor)

Smokes the zone boundaries in a color.

Defined in:

Parameter:

Utilities.Utils#SMOKECOLOR SmokeColor

The smoke color.

_ZONE_TRIANGLE:Trigger(Objects)

Start watching if the Object or Objects move into or out of a zone.

Defined in:

Parameter:

Wrapper.Controllable#CONTROLLABLE Objects

Object or Objects to watch, can be of type UNIT, GROUP, CLIENT, or SET_UNIT, SET_GROUP, SET_CLIENT

Return value:

self

Usage:

           -- Create a new zone and start watching it every 5 secs for a defined GROUP entering or leaving
           local triggerzone = ZONE:New("ZonetoWatch"):Trigger(GROUP:FindByName("Aerial-1"))

           -- This FSM function will be called when the group enters the zone
           function triggerzone:OnAfterEnteredZone(From,Event,To,Group)
             MESSAGE:New("Group has entered zone!",15):ToAll()
           end

           -- This FSM function will be called when the group leaves the zone
           function triggerzone:OnAfterLeftZone(From,Event,To,Group)
             MESSAGE:New("Group has left zone!",15):ToAll()
           end

           -- Stop watching the zone after 1 hour
          triggerzone:__TriggerStop(3600)

_ZONE_TRIANGLE:TriggerStop()

Triggers the FSM event "TriggerStop".

Stops the ZONE_BASE Trigger.

(Internal) Check the assigned objects for being in/out of the zone

Defined in:

Parameters:

#string From

#string Event

#string to

Return value:

self

Field(s)

Function(s)

_ZONE_TRIANGLE:AddEndState(State)

Adds an End state.

Defined in:

Parameter:

#string State

The FSM state.

_ZONE_TRIANGLE:AddProcess(From, Event, Process, ReturnEvents)

Set the default #FSM_PROCESS template with key ProcessName providing the ProcessClass and the process object when it is assigned to a Wrapper.Controllable by the task.

Defined in:

Parameters:

#table From

Can contain a string indicating the From state or a table of strings containing multiple From states.

#string Event

The Event name.

Core.Fsm#FSM_PROCESS Process

An sub-process FSM.

#table ReturnEvents

A table indicating for which returned events of the SubFSM which Event must be triggered in the FSM.

Return value:

Core.Fsm#FSM_PROCESS:

The SubFSM.

_ZONE_TRIANGLE:AddScore(State, ScoreText, Score)

Adds a score for the FSM to be achieved.

Defined in:

Parameters:

#string State

is the state of the process when the score needs to be given. (See the relevant state descriptions of the process).

#string ScoreText

is a text describing the score that is given according the status.

#number Score

is a number providing the score of the status.

Return value:

self

_ZONE_TRIANGLE:AddScoreProcess(From, Event, State, ScoreText, Score)

Adds a score for the FSM_PROCESS to be achieved.

Defined in:

Parameters:

#string From

is the From State of the main process.

#string Event

is the Event of the main process.

#string State

is the state of the process when the score needs to be given. (See the relevant state descriptions of the process).

#string ScoreText

is a text describing the score that is given according the status.

#number Score

is a number providing the score of the status.

Return value:

self

_ZONE_TRIANGLE:AddTransition(From, Event, To)

Add a new transition rule to the FSM.

A transition rule defines when and if the FSM can transition from a state towards another state upon a triggered event.

Defined in:

Parameters:

#table From

Can contain a string indicating the From state or a table of strings containing multiple From states.

#string Event

The Event name.

#string To

The To state.

_ZONE_TRIANGLE:GetCurrentState()

Get current state.

Defined in:

Return value:

#string:

Current FSM state.

_ZONE_TRIANGLE:GetEndStates()

Returns the End states.

Defined in:

Return value:

#table:

End states.

#boolean:

If true, FSM is in this state.

_ZONE_TRIANGLE:LoadCallBacks(CallBackTable)

Load call backs.

Defined in:

Parameter:

#table CallBackTable

Table of call backs.

_ZONE_TRIANGLE:New()

Creates a new FSM object.

Defined in:

Return value:

_ZONE_TRIANGLE:SetProcess(From, Event, Fsm)

Defined in:

Parameters:

From

Parameters:

#string step

Step "onafter", "onbefore", "onenter", "onleave".

#string trigger

Trigger.

#table params

Parameters.

#string EventName

Event name.

Return value:

_ZONE_TRIANGLE:_gosub(ParentFrom, ParentEvent)

Go sub.

Defined in:

Parameters:

#string ParentFrom

Parent from state.

#string ParentEvent

Parent event name.

Return value:

#table:

Subs.

_ZONE_TRIANGLE:_handler(EventName, ...)

Handler.

Defined in:

Parameters:

#string EventName

Event name.

...

Arguments.

_ZONE_TRIANGLE:_isendstate(Current)

Is end state.

Defined in:

Parameter:

#string Current

Current state name.

Return values:

#table:

FSM parent.

#string:

Event name.

_ZONE_TRIANGLE:_submap(subs, sub, name)

Sub maps.

Defined in:

Parameters:

#table subs

Subs.

#table sub

Sub.

#string name

Name.

_ZONE_TRIANGLE:can(e)

Check if can do an event.

Defined in:

Parameter:

#string e

Event name.

Return values:

#boolean:

If true, FSM can do the event.

#string:

To state.

_ZONE_TRIANGLE:cannot(e)

Check if cannot do an event.

Defined in:

Parameter:

#string e

Event name.

Return value:

#boolean:

If true, FSM cannot do the event.

_ZONE_TRIANGLE:is(State, state)

Check if FSM is in state.

Defined in:

Parameters:

#string State

State name.

state

Return value:

#boolean:

If true, FSM is in this state.

Field(s)

Function(s)

_ZONE_TRIANGLE:ClearState(Object, StateName)

Clear the state of an object.

Defined in:

Parameters:

Object

The object that holds the Value set by the Key.

StateName

The key that is should be cleared.

_ZONE_TRIANGLE:CreateEventBirth(EventTime, Initiator, IniUnitName, place, subplace)

Creation of a Birth Event.

Defined in:

Parameters:

DCS#Time EventTime

Defined in:

Parameter:

Arguments

A #table or any field.

_ZONE_TRIANGLE:EventDispatcher()

Returns the event dispatcher

Defined in:

Return value:

Core.Event#EVENT:

_ZONE_TRIANGLE:EventRemoveAll()

Remove all subscribed events

Defined in:

_ZONE_TRIANGLE:GetClassNameAndID()

Get the ClassName + ClassID of the class instance.

The ClassName + ClassID is formatted as '%s#%09d'.

Defined in:

Return value:

#string:

The ClassName + ClassID of the class instance.

_ZONE_TRIANGLE:GetEventPriority()

Get the Class Core.Event processing Priority.

The Event processing Priority is a number from 1 to 10, reflecting the order of the classes subscribed to the Event to be processed.

Defined in:

Return value:

#number:

The Core.Event processing Priority.

_ZONE_TRIANGLE:GetParent(Child, FromClass)

This is the worker method to retrieve the Parent class.

Note that the Parent class must be passed to call the parent class method.

self:GetParent(self):ParentMethod()

Defined in:

Parameters:

#BASE Child

This is the Child class from which the Parent class needs to be retrieved.

#BASE FromClass

(Optional) The class from which to get the parent.

Return value:

_ZONE_TRIANGLE:GetState(Object, Key)

Get a Value given a Key from the Object.

Note that if the Object is destroyed, set to nil, or garbage collected, then the Values and Keys will also be gone.

Defined in:

Parameters:

Object

The object that holds the Value set by the Key.

Key

The key that is used to retrieve the value. Note that the key can be a #string, but it can also be any other type!

Return value:

The Value retrieved or nil if the Key was not found and thus the Value could not be retrieved.

_ZONE_TRIANGLE:HandleEvent(EventID, EventFunction)

Subscribe to a DCS Event.

Defined in:

Parameters:

Core.Event#EVENTS EventID

Event ID.

#function EventFunction

(optional) The function to be called when the event occurs for the unit.

Return value:

_ZONE_TRIANGLE:I(Arguments)

Log an information which will be traced always.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

_ZONE_TRIANGLE:Inherit(Child, Parent)

This is the worker method to inherit from a parent class.

Defined in:

Parameters:

Child

is the Child class that inherits.

#BASE Parent

is the Parent class that the Child inherits from.

Return value:

Child

_ZONE_TRIANGLE:IsInstanceOf(ClassName)

This is the worker method to check if an object is an (sub)instance of a class.

Examples:

ZONE:New( 'some zone' ):IsInstanceOf( ZONE ) will return true
ZONE:New( 'some zone' ):IsInstanceOf( 'ZONE' ) will return true
ZONE:New( 'some zone' ):IsInstanceOf( 'zone' ) will return true
ZONE:New( 'some zone' ):IsInstanceOf( 'BASE' ) will return true
ZONE:New( 'some zone' ):IsInstanceOf( 'GROUP' ) will return false

Defined in:

Parameter:

_ZONE_TRIANGLE:OnEvent(EventData)

Occurs when an Event for an object is triggered.

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that triggered the event.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

_ZONE_TRIANGLE:OnEventBDA(EventData)

BDA.

Have a look at the class Core.Event#EVENT as these are just the prototypes.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

Unknown precisely what creates this event, likely tied into newer damage model.

Will update this page when new information become available.

initiator: The unit that had the failure.

initiator: Static object representing the ejected pilot. Place : Aircraft that the pilot ejected from.
place: may not return as a valid object if the aircraft has crashed into the ground and no longer exists.
subplace: is always 0 for unknown reasons.

Core.Event#EVENTDATA EventData

The EventData structure.

_ZONE_TRIANGLE:OnEventPilotDead(EventData)

Occurs when the pilot of an aircraft is killed.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

Have a look at the class Core.Event#EVENT as these are just the prototypes.

initiator: The unit that is was destroyed.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

_ZONE_TRIANGLE:ScheduleOnce(Start, SchedulerFunction, ...)

Schedule a new time event.

Note that the schedule will only take place if the scheduler is started. Even for a single schedule event, the scheduler needs to be started also.

Defined in:

Parameters:

#number Start

Specifies the amount of seconds that will be waited before the scheduling is started, and the event function is called.

#function SchedulerFunction

The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.

#table ...

Optional arguments that can be given as part of scheduler. The arguments need to be given as a table { param1, param 2, ... }.

Return value:

#string:

The Schedule ID of the planned schedule.

_ZONE_TRIANGLE:ScheduleRepeat(Start, Repeat, RandomizeFactor, Stop, SchedulerFunction, ...)

Schedule a new time event.

Note that the schedule will only take place if the scheduler is started. Even for a single schedule event, the scheduler needs to be started also.

Defined in:

Parameters:

#number Start

Specifies the amount of seconds that will be waited before the scheduling is started, and the event function is called.

#number Repeat

Specifies the interval in seconds when the scheduler will call the event function.

#number RandomizeFactor

Specifies a randomization factor between 0 and 1 to randomize the Repeat.

#number Stop

Specifies the amount of seconds when the scheduler will be stopped.

#function SchedulerFunction

The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.

#table ...

Optional arguments that can be given as part of scheduler. The arguments need to be given as a table { param1, param 2, ... }.

Return value:

#string:

The Schedule ID of the planned schedule.

_ZONE_TRIANGLE:ScheduleStop(SchedulerID)

Stops the Schedule.

Defined in:

Parameter:

#string SchedulerID

(Optional) Scheduler ID to be stopped. If nil, all pending schedules are stopped.

_ZONE_TRIANGLE:SetEventPriority(EventPriority)

Set the Class Core.Event processing Priority.

The Event processing Priority is a number from 1 to 10, reflecting the order of the classes subscribed to the Event to be processed.

Defined in:

Parameter:

#number EventPriority

The Core.Event processing Priority.

Return value:

self

_ZONE_TRIANGLE:SetState(Object, Key, Value)

Set a state or property of the Object given a Key and a Value.

Note that if the Object is destroyed, set to nil, or garbage collected, then the Values and Keys will also be gone.

Defined in:

Parameters:

Object

The object that will hold the Value set by the Key.

Key

The key that is used as a reference of the value. Note that the key can be a #string, but it can also be any other type!

Value

The value to is stored in the object.

#number Level

_ZONE_TRIANGLE:TraceOff()

Set trace off.

Defined in:

Usage:

-- Switch the tracing Off
BASE:TraceOff()

_ZONE_TRIANGLE:TraceOn()

Set trace on.

Defined in:

Usage:

-- Switch the tracing On
BASE:TraceOn()

_ZONE_TRIANGLE:TraceOnOff(TraceOnOff)

Set trace on or off Note that when trace is off, no BASE.Debug statement is performed, increasing performance! When Moose is loaded statically, (as one file), tracing is switched off by default.

So tracing must be switched on manually in your mission if you are using Moose statically. When moose is loading dynamically (for moose class development), tracing is switched on by default.

Defined in:

Parameter:

#boolean TraceOnOff

Switch the tracing on or off.

Usage:


  -- Switch the tracing On
  BASE:TraceOnOff( true )

  -- Switch the tracing Off
  BASE:TraceOnOff( false )

_ZONE_TRIANGLE:UnHandleEvent(EventID)

UnSubscribe to a DCS event.

Defined in:

Parameter:

Core.Event#EVENTS EventID

Event ID.

Return value:

_ZONE_TRIANGLE:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function call.

The main event handling function...

This function captures all events generated for the class.

Defined in: