Module Ops.PlayerRecce

PLAYERRECCE:DisableSmokeOwnPosition()

[User] Disable smoking of own position

Defined in:

PLAYERRECCE

Return value:

PLAYERRECCE:EnableSmokeAverageTargetPosition()

[User] Enable smoking of average target positions, instead of all targets visible.

Loses smoke per threatlevel -- each is med threat. Default is - smoke all positions.

Defined in:

PLAYERRECCE

Return value:

self

PLAYERRECCE:EnableSmokeOwnPosition()

[User] Enable smoking of own position

Defined in:

PLAYERRECCE

Return value:

self

PLAYERRECCE:New(Name, Coalition, PlayerSet)

Create and run a new PlayerRecce instance.

Defined in:

PLAYERRECCE

Parameters:

#string Name

The name of this instance

#number Coalition

e.g. coalition.side.BLUE

Core.Set#SET_CLIENT PlayerSet

The set of pilots working as recce

Return value:

self

PLAYERRECCE:OnAfterIllumination(From, Event, To, Client, Playername, TargetSet)

FSM Function OnAfterIllumination.

Illumination rocket shot.

Defined in:

PLAYERRECCE

Parameters:

#string From

State.

#string Event

Trigger.

#string To

State.

Wrapper.Client#CLIENT Client

#string Playername

Core.Set#SET_UNIT TargetSet

Return value:

self

PLAYERRECCE:OnAfterRecceOffStation(From, Event, To, Client, Playername)

FSM Function OnAfterRecceOffStation.

Recce went off duty.

Defined in:

PLAYERRECCE

Parameters:

#string From

State.

#string Event

Trigger.

#string To

State.

Wrapper.Client#CLIENT Client

#string Playername

Return value:

self

PLAYERRECCE:OnAfterRecceOnStation(From, Event, To, Client, Playername)

FSM Function OnAfterRecceOnStation.

Recce came on station.

Defined in:

PLAYERRECCE

Parameters:

#string From

State.

#string Event

Trigger.

#string To

State.

Wrapper.Client#CLIENT Client

#string Playername

Return value:

self

PLAYERRECCE:OnAfterShack(From, Event, To, Client, Target)

FSM Function OnAfterShack.

Lased target has been destroyed.

Defined in:

PLAYERRECCE

Parameters:

#string From

State.

#string Event

Trigger.

#string To

State.

Wrapper.Client#CLIENT Client

Wrapper.Unit#UNIT Target

The destroyed target (if obtainable)

Return value:

self

PLAYERRECCE:OnAfterTargetDetected(From, Event, To, Targetsbyclock, Client, Playername)

FSM Function OnAfterTargetDetected.

Targets detected.

Defined in:

PLAYERRECCE

Parameters:

#string From

State.

#string Event

Trigger.

#string To

State.

#table Targetsbyclock

table with index 1..12 containing a #table of Wrapper.Unit#UNIT objects each.

Wrapper.Client#CLIENT Client

#string Playername

Return value:

self

PLAYERRECCE:OnAfterTargetLOSLost(From, Event, To, Client, Target)

FSM Function OnAfterTargetLOSLost.

Lost LOS on lased target.

Defined in:

PLAYERRECCE

Parameters:

#string From

State.

#string Event

Trigger.

#string To

State.

Wrapper.Client#CLIENT Client

Wrapper.Unit#UNIT Target

Return value:

self

PLAYERRECCE:OnAfterTargetLasing(From, Event, To, Client, Target, Lasercode, Lasingtime)

FSM Function OnAfterTargetLasing.

Lasing a new target.

Defined in:

PLAYERRECCE

Parameters:

#string From

State.

#string Event

Trigger.

#string To

State.

Wrapper.Client#CLIENT Client

Wrapper.Unit#UNIT Target

#number Lasercode

#number Lasingtime

Return value:

self

PLAYERRECCE:OnAfterTargetReport(From, Event, To, Client, TargetSet, Target, Text)

FSM Function OnAfterTargetReport.

Laser target report sent.

Defined in:

PLAYERRECCE

Parameters:

#string From

State.

#string Event

Trigger.

#string To

State.

Wrapper.Client#CLIENT Client

Core.Set#SET_UNIT TargetSet

Wrapper.Unit#UNIT Target

Target currently lased

#string Text

Return value:

self

PLAYERRECCE:OnAfterTargetReportSent(From, Event, To, Client, Playername, TargetSet)

FSM Function OnAfterTargetReportSent.

All targets report sent.

Defined in:

PLAYERRECCE

Parameters:

#string From

State.

#string Event

Trigger.

#string To

State.

Wrapper.Client#CLIENT Client

Client sending the report

#string Playername

Player name

Core.Set#SET_UNIT TargetSet

Set of targets

Return value:

self

PLAYERRECCE:OnAfterTargetsFlared(From, Event, To, Client, Playername, TargetSet)

FSM Function OnAfterTargetsFlared.

Flares shot.

Defined in:

PLAYERRECCE

Parameters:

#string From

State.

#string Event

Trigger.

#string To

State.

Wrapper.Client#CLIENT Client

#string Playername

Core.Set#SET_UNIT TargetSet

Return value:

self

PLAYERRECCE:OnAfterTargetsSmoked(From, Event, To, Client, Playername, TargetSet)

FSM Function OnAfterTargetsSmoked.

Smoke grenade shot.

Defined in:

PLAYERRECCE

Parameters:

#string From

State.

#string Event

Trigger.

#string To

State.

Wrapper.Client#CLIENT Client

#string Playername

Core.Set#SET_UNIT TargetSet

Return value:

self

PLAYERRECCE:SetAttackSet(AttackSet)

[User] Set a set of clients which will receive target reports

Defined in:

PLAYERRECCE

Parameter:

Core.Set#SET_CLIENT AttackSet

Return value:

PLAYERRECCE:SetCallSignOptions(ShortCallsign, Keepnumber, CallsignTranslations)

[User] Set callsign options for TTS output.

See Wrapper.Group#GROUP.GetCustomCallSign() on how to set customized callsigns.

Defined in:

PLAYERRECCE

Parameters:

#boolean ShortCallsign

If true, only call out the major flight number

#boolean Keepnumber

If true, keep the customized callsign in the #GROUP name for players as-is, no amendments or numbers.

#table CallsignTranslations

(optional) Table to translate between DCS standard callsigns and bespoke ones. Does not apply if using customized callsigns from playername or group name.

Return value:

self

PLAYERRECCE:SetLaserCodes(LaserCodes)

[User] Set a table of possible laser codes.

Each new RECCE can select a code from this table, default is { 1688, 1130, 4785, 6547, 1465, 4578 }.

Defined in:

PLAYERRECCE

Parameter:

#list<#number> LaserCodes

Return value:

PLAYERRECCE:SetMenuName(Name)

[User] Set the top menu name to a custom string.

Defined in:

PLAYERRECCE

Parameter:

#string Name

The name to use as the top menu designation.

Return value:

self

PLAYERRECCE:SetPlayerTaskController(Controller)

[User] Set PlayerTaskController.

Allows to upload target reports to the controller, in turn creating tasks for other players.

Defined in:

PLAYERRECCE

Parameter:

Ops.PlayerTask#PLAYERTASKCONTROLLER Controller

Return value:

PLAYERRECCE:SetReferencePoint(Coordinate, Name)

[User] Set a reference point coordinate for A2G Operations.

Will be used in coordinate references.

Defined in:

PLAYERRECCE

Parameters:

Core.Point#COORDINATE Coordinate

Coordinate of the RP

#string Name

Name of the RP

Return value:

PLAYERRECCE:SetSRS(Frequency, Modulation, PathToSRS, Gender, Culture, Port, Voice, Volume, PathToGoogleKey)

[User] Set SRS TTS details - see Sound.SRS for details

Defined in:

PLAYERRECCE

Parameters:

#number Frequency

Frequency to be used. Can also be given as a table of multiple frequencies, e.g. 271 or {127,251}. There needs to be exactly the same number of modulations!

#number Modulation

Modulation to be used. Can also be given as a table of multiple modulations, e.g. radio.modulation.AM or {radio.modulation.FM,radio.modulation.AM}. There needs to be exactly the same number of frequencies!

#string PathToSRS

Defaults to "C:\Program Files\DCS-SimpleRadio-Standalone"

#string Gender

(Optional) Defaults to "male"

#string Culture

(Optional) Defaults to "en-US"

#number Port

(Optional) Defaults to 5002

#string Voice

(Optional) Use a specifc voice with the Sound.SRS#SetVoice function, e.g, :SetVoice("Microsoft Hedda Desktop"). Note that this must be installed on your windows system. Can also be Google voice types, if you are using Google TTS.

#number Volume

(Optional) Volume - between 0.0 (silent) and 1.0 (loudest)

#string PathToGoogleKey

(Optional) Path to your google key if you want to use google TTS

Return value:

self

PLAYERRECCE:SetTransmitOnlyWithPlayers(Switch)

[User] For SRS - Switch to only transmit if there are players on the server.

Defined in:

PLAYERRECCE

Parameter:

#boolean Switch

If true, only send SRS if there are alive Players.

Return value:

self

PLAYERRECCE:Start()

Triggers the FSM event "Start".

Starts the PLAYERRECCE. Note: Start() is called automatically after New().

Defined in:

PLAYERRECCE

PLAYERRECCE:_BuildMenus(Client)

[Internal] Build Menus

Defined in:

PLAYERRECCE

Parameter:

Wrapper.Client#CLIENT Client

(optional) Client object

Return value:

self

PLAYERRECCE:_CameraOn(client, playername)

[Internal] Check Gazelle camera in on

Defined in:

PLAYERRECCE

Parameters:

Wrapper.Client#CLIENT client

#string playername

Return value:

#boolean:

OnOff

PLAYERRECCE:_CheckNewTargets(targetset, client, playername)

[Internal]

Defined in:

PLAYERRECCE

Parameters:

Core.Set#SET_UNIT targetset

Wrapper.Client#CLIENT client

#string playername

Return value:

self

PLAYERRECCE:_CleanupTargetCache()

[Internal]

Defined in:

PLAYERRECCE

Return value:

self

PLAYERRECCE:_EventHandler(EventData)

[Internal] Event handling

Defined in:

PLAYERRECCE

Parameter:

Core.Event#EVENTDATA EventData

Return value:

self

PLAYERRECCE:_FlareTargets(client, group, playername)

[Internal]

Defined in:

PLAYERRECCE

Parameters:

Wrapper.Client#CLIENT client

Wrapper.Group#GROUP group

#string playername

Return value:

self

PLAYERRECCE:_GetActualMaxLOSight(unit, vheading, vnod, vivoff)

[Internal] Get the max line of sight based on unit head and camera nod via trigonometry.

Returns 0 if camera is off.

Defined in:

PLAYERRECCE

Parameters:

Wrapper.Unit#UNIT unit

The unit which LOS we want

#number vheading

Heading where the unit or camera is looking

#number vnod

Nod down in degrees

#boolean vivoff

Camera on or off

Return value:

#number:

maxview Max view distance in meters

PLAYERRECCE:_GetClockDirection(unit, target)

(Internal) Function to determine clockwise direction to target.

Defined in:

PLAYERRECCE

Parameters:

Wrapper.Unit#UNIT unit

The Helicopter

Wrapper.Unit#UNIT target

The downed Group

Return value:

#number:

direction

PLAYERRECCE:_GetGazelleVivianneSight(Gazelle)

[Internal] Get the view parameters from a Gazelle camera

Defined in:

PLAYERRECCE

Parameter:

Wrapper.Unit#UNIT Gazelle

Return values:

#number:

cameraheading in degrees.

#number:

cameranodding in degrees.

#number:

maxview in meters.

#boolean:

cameraison If true, camera is on, else off.

PLAYERRECCE:_GetHVTTarget(targetset)

[Internal]

Defined in:

PLAYERRECCE

Parameter:

Core.Set#SET_UNIT targetset

Set of targets, can be empty!

Return value:

Wrapper.Unit#UNIT:

Target or nil

PLAYERRECCE:_GetKnownTargets(client)

[Internal]

Defined in:

PLAYERRECCE

Parameter:

Wrapper.Client#CLIENT client

Return values:

Core.Set#SET_UNIT:

Set of targets, can be empty!

#number:

count Count of targets

PLAYERRECCE:_GetTargetSet(unit, camera, laser)

[Internal]

Defined in:

PLAYERRECCE

Parameters:

Wrapper.Unit#UNIT unit

The FACA unit

#boolean camera

If true, use the unit's camera for targets in sight

#laser laser

Use laser zone

Return values:

Core.Set#SET_UNIT:

Set of targets, can be empty!

#number:

count Count of targets

PLAYERRECCE:_GetTextForSpeech(text)

[Internal] Get text for text-to-speech.

Numbers are spaced out, e.g. "Heading 180" becomes "Heading 1 8 0 ".

Defined in:

PLAYERRECCE

Parameter:

#string text

Original text.

Return value:

#string:

Spoken text.

PLAYERRECCE:_GetViewZone(unit, vheading, minview, maxview, angle, camon, laser)

[Internal] Build a ZONE_POLYGON from a given viewport of a unit

Defined in:

PLAYERRECCE

Parameters:

Wrapper.Unit#UNIT unit

The unit which is looking

#number vheading

Heading where the unit or camera is looking

#number minview

Min line of sight - for lasing

#number maxview

Max line of sight

#number angle

Angle left/right to be added to heading to form a triangle

#boolean camon

Camera is switched on

#boolean laser

Zone is for lasing

Return value:

Core.Zone#ZONE_POLYGON:

ViewZone or nil if camera is off

PLAYERRECCE:_IlluTargets(client, group, playername)

[Internal]

Defined in:

PLAYERRECCE

Parameters:

Wrapper.Client#CLIENT client

Wrapper.Group#GROUP group

#string playername

Return value:

self

PLAYERRECCE:_LaseTarget(client, targetset)

[Internal]

Defined in:

PLAYERRECCE

Parameters:

Wrapper.Client#CLIENT client

The FACA unit

Core.Set#SET_UNIT targetset

Set of targets, can be empty!

Return value:

self

PLAYERRECCE:_ReportLaserTargets(client, group, playername)

[Internal]

Defined in:

PLAYERRECCE

Parameters:

Wrapper.Client#CLIENT client

Wrapper.Group#GROUP group

#string playername

Return value:

self

PLAYERRECCE:_ReportVisualTargets(client, group, playername)

[Internal]

Defined in:

PLAYERRECCE

Parameters:

Wrapper.Client#CLIENT client

Wrapper.Group#GROUP group

#string playername

Return value:

self

PLAYERRECCE:_SetClientLaserCode(client, group, playername, code)

[Internal]

Defined in:

PLAYERRECCE

Parameters:

Wrapper.Client#CLIENT client

Wrapper.Group#GROUP group

#string playername

code

Return value:

self

PLAYERRECCE:_SmokeTargets(client, group, playername)

[Internal]

Defined in:

PLAYERRECCE

Parameters:

Wrapper.Client#CLIENT client

Wrapper.Group#GROUP group

#string playername

Return value:

self

PLAYERRECCE:_SwitchLasing(client, group, playername)

[Internal]

Defined in:

PLAYERRECCE

Parameters:

Wrapper.Client#CLIENT client

Wrapper.Group#GROUP group

#string playername

Return value:

self

PLAYERRECCE:_SwitchLasingDist(client, group, playername, mindist, maxdist)

[Internal]

Defined in:

PLAYERRECCE

Parameters:

Wrapper.Client#CLIENT client

Wrapper.Group#GROUP group

#string playername

#number mindist

#number maxdist

Return value:

self

PLAYERRECCE:_SwitchOnStation(client, group, playername)

[Internal]

Defined in:

PLAYERRECCE

Parameters:

Wrapper.Client#CLIENT client

Wrapper.Group#GROUP group

#string playername

Return value:

self

PLAYERRECCE:_SwitchSmoke(client, group, playername)

[Internal]

Defined in:

PLAYERRECCE

Parameters:

Wrapper.Client#CLIENT client

Wrapper.Group#GROUP group

#string playername

Return value:

self

PLAYERRECCE:_UploadTargets(client, group, playername)

[Internal]

Defined in:

PLAYERRECCE

Parameters:

Wrapper.Client#CLIENT client

Wrapper.Group#GROUP group

#string playername

Return value:

self

PLAYERRECCE:_WIP(client, group, playername)

[Internal]

Defined in:

PLAYERRECCE

Parameters:

Wrapper.Client#CLIENT client

Wrapper.Group#GROUP group

#string playername

Return value:

self

PLAYERRECCE:__Start(delay)

Triggers the FSM event "Start" after a delay.

Starts the PLAYERRECCE. Note: Start() is called automatically after New().

Defined in:

PLAYERRECCE

Parameter:

#number delay

Delay in seconds.

PLAYERRECCE:__Stop(delay)

Triggers the FSM event "Stop" after a delay.

Stops the PLAYERRECCE and all its event handlers.

Defined in:

PLAYERRECCE

Parameter:

#number delay

Delay in seconds.

PLAYERRECCE:onafterIllumination(From, Event, To, Client, Playername, TargetSet)

[Internal] Targets Illuminated

Defined in:

PLAYERRECCE

Parameters:

#string From

#string Event

#string To

Wrapper.Client#CLIENT Client

#string Playername

Core.Set#SET_UNIT TargetSet

Return value:

self

PLAYERRECCE:onafterRecceOffStation(From, Event, To, Client, Playername)

[Internal] Recce off station

Defined in:

PLAYERRECCE

Parameters:

#string From

#string Event

#string To

Wrapper.Client#CLIENT Client

#string Playername

Return value:

self

PLAYERRECCE:onafterRecceOnStation(From, Event, To, Client, Playername)

[Internal] Recce on station

Defined in:

PLAYERRECCE

Parameters:

#string From

#string Event

#string To

Wrapper.Client#CLIENT Client

#string Playername

Return value:

self

PLAYERRECCE:onafterShack(From, Event, To, Client, Target)

[Internal] Lased target destroyed

Defined in:

PLAYERRECCE

Parameters:

#string From

#string Event

#string To

Wrapper.Client#CLIENT Client

Wrapper.Unit#UNIT Target

Return value:

self

PLAYERRECCE:onafterStatus(From, Event, To)

[Internal] Status Loop

Defined in:

PLAYERRECCE

Parameters:

#string From

#string Event

#string To

Return value:

self

PLAYERRECCE:onafterStop(From, Event, To)

[Internal] Stop

Defined in:

PLAYERRECCE

Parameters:

#string From

#string Event

#string To

Return value:

self

PLAYERRECCE:onafterTargetDetected(From, Event, To, Targetsbyclock, Client, Playername)

[Internal] Target Detected

Defined in:

PLAYERRECCE

Parameters:

#string From

#string Event

#string To

#table Targetsbyclock

#table with index 1..12 containing a #table of Wrapper.Unit#UNIT objects each.

Wrapper.Client#CLIENT Client

#string Playername

Return value:

self

PLAYERRECCE:onafterTargetLOSLost(From, Event, To, Client, Target)

[Internal] Laser lost LOS

Defined in:

PLAYERRECCE

Parameters:

#string From

#string Event

#string To

Wrapper.Client#CLIENT Client

Wrapper.Unit#UNIT Target

Return value:

self

PLAYERRECCE:onafterTargetLasing(From, Event, To, Client, Target, Lasercode, Lasingtime)

[Internal] Target lasing

Defined in:

PLAYERRECCE

Parameters:

#string From

#string Event

#string To

Wrapper.Client#CLIENT Client

Wrapper.Unit#UNIT Target

#number Lasercode

#number Lasingtime

Return value:

self

PLAYERRECCE:onafterTargetReport(From, Event, To, Client, TargetSet, Target, Text)

[Internal] Target report

Defined in:

PLAYERRECCE

Parameters:

#string From

#string Event

#string To

Wrapper.Client#CLIENT Client

Core.Set#SET_UNIT TargetSet

Wrapper.Unit#UNIT Target

#string Text

Return value:

self

PLAYERRECCE:onafterTargetReportSent(From, Event, To, Client, Playername, TargetSet)

[Internal] Target data upload

Defined in:

PLAYERRECCE

Parameters:

#string From

#string Event

#string To

Wrapper.Client#CLIENT Client

Client sending the report

#string Playername

Player name

Core.Set#SET_UNIT TargetSet

Set of targets

Return value:

self

PLAYERRECCE:onafterTargetsFlared(From, Event, To, Client, Playername, TargetSet)

[Internal] Targets Flared

Defined in:

PLAYERRECCE

Parameters:

#string From

#string Event

#string To

Wrapper.Client#CLIENT Client

#string Playername

Core.Set#SET_UNIT TargetSet

Return value:

self

PLAYERRECCE:onafterTargetsSmoked(From, Event, To, Client, Playername, TargetSet)

[Internal] Targets Smoked

Defined in:

PLAYERRECCE

Parameters:

#string From

#string Event

#string To

Wrapper.Client#CLIENT Client

#string Playername

Core.Set#SET_UNIT TargetSet

Return value:

self

Field(s)

Core.Set#SET_CLIENT PLAYERRECCE.AttackSet

#table PLAYERRECCE.AutoLase

PLAYERRECCE.BCFrequency

PLAYERRECCE.BCModulation

#table PLAYERRECCE.CallsignTranslations

#Cameraheight PLAYERRECCE.Cameraheight

#CanLase PLAYERRECCE.CanLase

#string PLAYERRECCE.ClassName

Name of the class.

#table PLAYERRECCE.ClientMenus

#number PLAYERRECCE.Coalition

#string PLAYERRECCE.CoalitionName

Ops.PlayerTask#PLAYERTASKCONTROLLER PLAYERRECCE.Controller

#FlareColor PLAYERRECCE.FlareColor

#table PLAYERRECCE.GazelleViewFactors

#boolean PLAYERRECCE.Keepnumber

#table PLAYERRECCE.LaserCodes

#table PLAYERRECCE.LaserFOV

#LaserRelativePos PLAYERRECCE.LaserRelativePos

#table PLAYERRECCE.LaserSpots

#table PLAYERRECCE.LaserTarget

#MaxViewDistance PLAYERRECCE.MaxViewDistance

PLAYERRECCE.MenuName

#string PLAYERRECCE.Name

#table PLAYERRECCE.OnStation

PLAYERRECCE.PathToGoogleKey

Core.Set#SET_CLIENT PLAYERRECCE.PlayerSet

Wrapper.Marker#MARKER PLAYERRECCE.RPMarker

#string PLAYERRECCE.RPName

Core.Point#COORDINATE PLAYERRECCE.ReferencePoint

Sound.SRS#MSRS PLAYERRECCE.SRS

Sound.SRS#MSRSQUEUE PLAYERRECCE.SRSQueue

#boolean PLAYERRECCE.ShortCallsign

#SmokeColor PLAYERRECCE.SmokeColor

#table PLAYERRECCE.SmokeOwn

#number PLAYERRECCE.TForget

Utilities.FiFo#FIFO PLAYERRECCE.TargetCache

#boolean PLAYERRECCE.TransmitOnlyWithPlayers

#table PLAYERRECCE.UnitLaserCodes

#boolean PLAYERRECCE.UseController

#boolean PLAYERRECCE.UseSRS

#table PLAYERRECCE.ViewZone

#table PLAYERRECCE.ViewZoneLaser

#table PLAYERRECCE.ViewZoneVisual

#boolean PLAYERRECCE.debug

#number PLAYERRECCE.lasingtime

#string PLAYERRECCE.lid

Class id string for output to DCS log file.

#number PLAYERRECCE.minthreatlevel

#boolean PLAYERRECCE.smokeaveragetargetpos

#boolean PLAYERRECCE.smokeownposition

PLAYERRECCE.timestamp

#boolean PLAYERRECCE.verbose

Switch verbosity.

#string PLAYERRECCE.version

Function(s)

PLAYERRECCE:AddEndState(State)

Adds an End state.

Defined in:

Parameter:

#string State

The FSM state.

PLAYERRECCE: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.

PLAYERRECCE: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:

#FSM:

self

PLAYERRECCE: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:

#FSM:

self

PLAYERRECCE: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.

PLAYERRECCE:GetCurrentState()

Get current state.

Defined in:

Return value:

#string:

Current FSM state.

PLAYERRECCE:GetEndStates()

Returns the End states.

Defined in:

Return value:

#table:

End states.

PLAYERRECCE:GetProcess(From, Event)

Defined in:

Parameters:

From

Event

PLAYERRECCE:GetProcesses()

Returns a table of the SubFSM rules defined within the FSM.

Defined in:

Return value:

#table:

Sub processes.

PLAYERRECCE:GetScores()

Returns a table with the scores defined.

Defined in:

Return value:

#table:

Scores.

PLAYERRECCE:GetStartState()

Returns the start state of the FSM.

Defined in:

Return value:

#string:

A string containing the start state.

PLAYERRECCE:GetState()

Get current state.

Defined in:

Return value:

#string:

Current FSM state.

PLAYERRECCE:GetSubs()

Returns a table with the Subs defined.

Defined in:

Return value:

#table:

Sub processes.

PLAYERRECCE:GetTransitions()

Returns a table of the transition rules defined within the FSM.

Defined in:

Return value:

#table:

Transitions.

PLAYERRECCE:Is(State)

Check if FSM is in state.

Defined in:

Parameter:

#string State

State name.

Return value:

#boolean:

If true, FSM is in this state.

PLAYERRECCE:LoadCallBacks(CallBackTable)

Load call backs.

Defined in:

Parameter:

#table CallBackTable

Table of call backs.

PLAYERRECCE:New()

Creates a new FSM object.

Defined in:

Return value:

#FSM:

PLAYERRECCE:SetProcess(From, Event, Fsm)

Defined in:

Parameters:

From

Event

Fsm

PLAYERRECCE:SetStartState(State)

Sets the start state of the FSM.

Defined in:

Parameter:

#string State

A string defining the start state.

PLAYERRECCE:_add_to_map(Map, Event)

Add to map.

Defined in:

Parameters:

#table Map

Map.

#table Event

Event table.

PLAYERRECCE:_call_handler(step, trigger, params, EventName)

Call handler.

Defined in:

Parameters:

#string step

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

#string trigger

Trigger.

#table params

Parameters.

#string EventName

Event name.

Return value:

Value.

PLAYERRECCE:_create_transition(EventName)

Create transition.

Defined in:

Parameter:

#string EventName

Event name.

Return value:

#function:

Function.

PLAYERRECCE:_delayed_transition(EventName)

Delayed transition.

Defined in:

Parameter:

#string EventName

Event name.

Return value:

#function:

Function.

PLAYERRECCE:_eventmap(Events, EventStructure)

Event map.

Defined in:

Parameters:

#table Events

Events.

#table EventStructure

Event structure.

PLAYERRECCE:_gosub(ParentFrom, ParentEvent)

Go sub.

Defined in:

Parameters:

#string ParentFrom

Parent from state.

#string ParentEvent

Parent event name.

Return value:

#table:

Subs.

PLAYERRECCE:_handler(EventName, ...)

Handler.

Defined in:

Parameters:

#string EventName

Event name.

...

Arguments.

PLAYERRECCE:_isendstate(Current)

Is end state.

Defined in:

Parameter:

#string Current

Current state name.

Return values:

#table:

FSM parent.

#string:

Event name.

PLAYERRECCE:_submap(subs, sub, name)

Sub maps.

Defined in:

Parameters:

#table subs

Subs.

#table sub

Sub.

#string name

Name.

PLAYERRECCE: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.

PLAYERRECCE: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.

PLAYERRECCE: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)

Core.Set#SET_CLIENT PLAYERRECCE.AttackSet

#table PLAYERRECCE.AutoLase

PLAYERRECCE.BCFrequency

PLAYERRECCE.BCModulation

#table PLAYERRECCE.CallsignTranslations

#Cameraheight PLAYERRECCE.Cameraheight

#CanLase PLAYERRECCE.CanLase

#string PLAYERRECCE.ClassName

Name of the class.

#table PLAYERRECCE.ClientMenus

#number PLAYERRECCE.Coalition

#string PLAYERRECCE.CoalitionName

Ops.PlayerTask#PLAYERTASKCONTROLLER PLAYERRECCE.Controller

#FlareColor PLAYERRECCE.FlareColor

#table PLAYERRECCE.GazelleViewFactors

#boolean PLAYERRECCE.Keepnumber

#table PLAYERRECCE.LaserCodes

#table PLAYERRECCE.LaserFOV

#LaserRelativePos PLAYERRECCE.LaserRelativePos

#table PLAYERRECCE.LaserSpots

#table PLAYERRECCE.LaserTarget

#MaxViewDistance PLAYERRECCE.MaxViewDistance

PLAYERRECCE.MenuName

#string PLAYERRECCE.Name

#table PLAYERRECCE.OnStation

PLAYERRECCE.PathToGoogleKey

Core.Set#SET_CLIENT PLAYERRECCE.PlayerSet

Wrapper.Marker#MARKER PLAYERRECCE.RPMarker

#string PLAYERRECCE.RPName

Core.Point#COORDINATE PLAYERRECCE.ReferencePoint

Sound.SRS#MSRS PLAYERRECCE.SRS

Sound.SRS#MSRSQUEUE PLAYERRECCE.SRSQueue

#boolean PLAYERRECCE.ShortCallsign

#SmokeColor PLAYERRECCE.SmokeColor

#table PLAYERRECCE.SmokeOwn

#number PLAYERRECCE.TForget

Utilities.FiFo#FIFO PLAYERRECCE.TargetCache

#boolean PLAYERRECCE.TransmitOnlyWithPlayers

#table PLAYERRECCE.UnitLaserCodes

#boolean PLAYERRECCE.UseController

#boolean PLAYERRECCE.UseSRS

#table PLAYERRECCE.ViewZone

#table PLAYERRECCE.ViewZoneLaser

#table PLAYERRECCE.ViewZoneVisual

#boolean PLAYERRECCE.debug

#number PLAYERRECCE.lasingtime

#string PLAYERRECCE.lid

Class id string for output to DCS log file.

#number PLAYERRECCE.minthreatlevel

#boolean PLAYERRECCE.smokeaveragetargetpos

#boolean PLAYERRECCE.smokeownposition

PLAYERRECCE.timestamp

#boolean PLAYERRECCE.verbose

Switch verbosity.

#string PLAYERRECCE.version

Function(s)

PLAYERRECCE: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.

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

Creation of a Birth Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

#string IniUnitName

The initiating unit name.

place

subplace

PLAYERRECCE:CreateEventCrash(EventTime, Initiator, IniObjectCategory)

Creation of a Crash Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

IniObjectCategory

PLAYERRECCE:CreateEventDead(EventTime, Initiator, IniObjectCategory)

Creation of a Dead Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

IniObjectCategory

PLAYERRECCE:CreateEventPlayerEnterAircraft(PlayerUnit)

Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

Defined in:

Parameter:

Wrapper.Unit#UNIT PlayerUnit

The aircraft unit the player entered.

PLAYERRECCE:CreateEventRemoveUnit(EventTime, Initiator)

Creation of a Remove Unit Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

PLAYERRECCE:CreateEventTakeoff(EventTime, Initiator)

Creation of a Takeoff Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

PLAYERRECCE:CreateEventUnitLost(EventTime, Initiator)

Creation of a Crash Event.

Defined in:

Parameters:

DCS#Time EventTime

The time stamp of the event.

DCS#Object Initiator

The initiating object of the event.

PLAYERRECCE:E(Arguments)

Log an exception which will be traced always.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

PLAYERRECCE:EventDispatcher()

Returns the event dispatcher

Defined in:

Return value:

Core.Event#EVENT:

PLAYERRECCE:EventRemoveAll()

Remove all subscribed events

Defined in:

Return value:

PLAYERRECCE:F(Arguments)

Trace a function call.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

PLAYERRECCE:F2(Arguments)

Trace a function call level 2.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

PLAYERRECCE:F3(Arguments)

Trace a function call level 3.

Must be at the beginning of the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

PLAYERRECCE:GetClassID()

Get the ClassID of the class instance.

Defined in:

Return value:

#string:

The ClassID of the class instance.

PLAYERRECCE:GetClassName()

Get the ClassName of the class instance.

Defined in:

Return value:

#string:

The ClassName of the class instance.

PLAYERRECCE: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.

PLAYERRECCE: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.

PLAYERRECCE: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:

PLAYERRECCE: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.

PLAYERRECCE: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:

PLAYERRECCE: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.

PLAYERRECCE: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

PLAYERRECCE: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:

ClassName

is the name of the class or the class itself to run the check against

Return value:

#boolean:

PLAYERRECCE:IsTrace()

Enquires if tracing is on (for the class).

Defined in:

Return value:

#boolean:

PLAYERRECCE:New()

BASE constructor.

This is an example how to use the BASE:New() constructor in a new class definition when inheriting from BASE.

function EVENT:New()
  local self = BASE:Inherit( self, BASE:New() ) -- #EVENT
  return self
end

Defined in:

Return value:

PLAYERRECCE: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.

PLAYERRECCE: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.

PLAYERRECCE:OnEventBaseCaptured(EventData)

Occurs when a ground unit captures either an airbase or a farp.

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that captured the base place: The airbase that was captured, can be a FARP or Airbase. When calling place:getCoalition() the faction will already be the new owning faction.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

PLAYERRECCE:OnEventBirth(EventData)

Occurs when any object is spawned into the mission.

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

PLAYERRECCE:OnEventCrash(EventData)

Occurs when any aircraft crashes into the ground and is completely destroyed.

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

PLAYERRECCE:OnEventDead(EventData)

Occurs when an object is dead.

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

PLAYERRECCE: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.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

PLAYERRECCE:OnEventDiscardChairAfterEjection(EventData)

Discard chair after ejection.

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.

PLAYERRECCE:OnEventEjection(EventData)

Occurs when a pilot ejects from an aircraft Have a look at the class Core.Event#EVENT as these are just the prototypes.

initiator : The unit that has ejected

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

PLAYERRECCE:OnEventEngineShutdown(EventData)

Occurs when any aircraft shuts down its engines.

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is stopping its engines.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

PLAYERRECCE:OnEventEngineStartup(EventData)

Occurs when any aircraft starts its engines.

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is starting its engines.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

PLAYERRECCE:OnEventHit(EventData)

Occurs whenever an object is hit by a weapon.

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit object the fired the weapon weapon: Weapon object that hit the target target: The Object that was hit.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

PLAYERRECCE:OnEventHumanFailure(EventData)

Occurs when any system fails on a human controlled aircraft.

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

PLAYERRECCE:OnEventKill(EventData)

Occurs on the death of a unit.

Contains more and different information. Similar to unit_lost it will occur for aircraft before the aircraft crash event occurs. Have a look at the class Core.Event#EVENT as these are just the prototypes.

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

PLAYERRECCE: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.

PLAYERRECCE: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.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

PLAYERRECCE:OnEventLandingQualityMark(EventData)

Landing quality mark.

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.

PLAYERRECCE:OnEventMarkAdded(EventData)

Occurs when a new mark was added.

Have a look at the class Core.Event#EVENT as these are just the prototypes. MarkID: ID of the mark.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

PLAYERRECCE:OnEventMarkChange(EventData)

Occurs when a mark text was changed.

Have a look at the class Core.Event#EVENT as these are just the prototypes. MarkID: ID of the mark.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

PLAYERRECCE:OnEventMarkRemoved(EventData)

Occurs when a mark was removed.

Have a look at the class Core.Event#EVENT as these are just the prototypes. MarkID: ID of the mark.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

PLAYERRECCE:OnEventMissionEnd(EventData)

Occurs when a mission ends 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.

PLAYERRECCE:OnEventMissionStart(EventData)

Occurs when a mission starts 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.

PLAYERRECCE:OnEventParatrooperLanding(EventData)

Weapon add.

Fires when entering a mission per pylon with the name of the weapon (double pylons not counted, infinite wep reload not counted. 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.

PLAYERRECCE:OnEventPilotDead(EventData)

Occurs when the pilot of an aircraft is killed.

Can occur either if the player is alive and crashes or if a weapon kills the pilot without completely destroying the plane. Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that the pilot has died in.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

PLAYERRECCE:OnEventPlayerEnterAircraft(EventData)

Occurs when a player enters a slot and takes control of an aircraft.

Have a look at the class Core.Event#EVENT as these are just the prototypes. NOTE: This is a workaround of a long standing DCS bug with the PLAYER_ENTER_UNIT event. initiator : The unit that is being taken control of.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

PLAYERRECCE:OnEventPlayerEnterUnit(EventData)

Occurs when any player assumes direct control of a unit.

Note - not Mulitplayer safe. Use PlayerEnterAircraft. Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is being taken control of.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

PLAYERRECCE:OnEventPlayerLeaveUnit(EventData)

Occurs when any player relieves control of a unit to the AI.

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

PLAYERRECCE:OnEventRefueling(EventData)

Occurs when an aircraft connects with a tanker and begins taking on fuel.

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

PLAYERRECCE:OnEventRefuelingStop(EventData)

Occurs when an aircraft is finished taking fuel.

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

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

PLAYERRECCE:OnEventScore(EventData)

Occurs when any modification to the "Score" as seen on the debrief menu would occur.

There is no information on what values the score was changed to. Event is likely similar to player_comment in this regard. 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.

PLAYERRECCE:OnEventShootingEnd(EventData)

Occurs when any unit stops firing its weapon.

Event will always correspond with a shooting start event. Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that was doing the shooting.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

PLAYERRECCE:OnEventShootingStart(EventData)

Occurs when any unit begins firing a weapon that has a high rate of fire.

Most common with aircraft cannons (GAU-8), autocannons, and machine guns. Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is doing the shooting. target: The unit that is being targeted.

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

PLAYERRECCE:OnEventShot(EventData)

Occurs whenever any unit in a mission fires a weapon.

But not any machine gun or autocannon based weapon, those are handled by EVENT.ShootingStart. 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.

PLAYERRECCE:OnEventTakeoff(EventData)

Occurs when an aircraft takes off from an airbase, farp, or ship.

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that tookoff place: Object from where the AI took-off from. Can be an Airbase Object, FARP, or Ships

Defined in:

Parameter:

Core.Event#EVENTDATA EventData

The EventData structure.

PLAYERRECCE:OnEventTriggerZone(EventData)

Trigger zone.

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.

PLAYERRECCE:OnEventUnitLost(EventData)

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.

PLAYERRECCE: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.

PLAYERRECCE: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.

PLAYERRECCE:ScheduleStop(SchedulerID)

Stops the Schedule.

Defined in:

Parameter:

#string SchedulerID

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

PLAYERRECCE: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

PLAYERRECCE: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.

Return value:

The Value set.

PLAYERRECCE:T(Arguments)

Trace a function logic level 1.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

PLAYERRECCE:T2(Arguments)

Trace a function logic level 2.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

PLAYERRECCE:T3(Arguments)

Trace a function logic level 3.

Can be anywhere within the function logic.

Defined in:

Parameter:

Arguments

A #table or any field.

PLAYERRECCE:TraceAll(TraceAll)

Trace all methods in MOOSE

Defined in:

Parameter:

#boolean TraceAll

true = trace all methods in MOOSE.

PLAYERRECCE:TraceClass(Class)

Set tracing for a class

Defined in:

Parameter:

#string Class

Class name.

PLAYERRECCE:TraceClassMethod(Class, Method)

Set tracing for a specific method of class

Defined in:

Parameters:

#string Class

Class name.

#string Method

Method.

PLAYERRECCE:TraceLevel(Level)

Set trace level

Defined in:

Parameter:

#number Level

PLAYERRECCE:TraceOff()

Set trace off.

Defined in:

Usage:

-- Switch the tracing Off
BASE:TraceOff()

PLAYERRECCE:TraceOn()

Set trace on.

Defined in:

Usage:

-- Switch the tracing On
BASE:TraceOn()

PLAYERRECCE: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 )

PLAYERRECCE:UnHandleEvent(EventID)

UnSubscribe to a DCS event.

Defined in:

Parameter:

Core.Event#EVENTS EventID

Event ID.

Return value:

PLAYERRECCE:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function call.

This function is private.

Defined in:

Parameters:

Arguments

A #table or any field.

DebugInfoCurrentParam

DebugInfoFromParam

PLAYERRECCE:_Serialize(Arguments)

(Internal) Serialize arguments

Defined in:

Parameter:

#table Arguments

Return value:

#string:

Text

PLAYERRECCE:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function logic.

Defined in:

Parameters:

Arguments

A #table or any field.

DebugInfoCurrentParam

DebugInfoFromParam

PLAYERRECCE:onEvent(event)

The main event handling function...

This function captures all events generated for the class.

Defined in: