Module Ops.Squadron

self

SQUADRON:SetAirwing(Airwing)

Set airwing.

Defined in:

SQUADRON

Parameter:

Ops.Airwing#AIRWING Airwing

The airwing.

Return value:

self

SQUADRON:SetDespawnAfterHolding(Switch)

Set despawn after holding.

Aircraft will be despawned when they arrive at their holding position at the airbase. Can help to avoid DCS AI taxiing issues.

Defined in:

SQUADRON

Parameter:

#boolean Switch

If true (default), activate despawn after holding.

Return value:

self

SQUADRON:SetDespawnAfterLanding(Switch)

Set despawn after landing.

Aircraft will be despawned after the landing event. Can help to avoid DCS AI taxiing issues.

Defined in:

SQUADRON

Parameter:

#boolean Switch

If true (default), activate despawn after landing.

Return value:

self

SQUADRON:SetFuelLowRefuel(switch)

Set if low fuel threshold is reached, flight tries to refuel at the neares tanker.

Defined in:

SQUADRON

Parameter:

#boolean switch

If true or nil, flight goes for refuelling. If false, turn this off.

Return value:

self

SQUADRON:SetFuelLowThreshold(LowFuel)

Set low fuel threshold.

Defined in:

SQUADRON

Parameter:

#number LowFuel

Low fuel threshold in percent. Default 25.

Return value:

self

SQUADRON:SetGrouping(nunits)

Set number of units in groups.

Defined in:

SQUADRON

Parameter:

#number nunits

Number of units. Must be >=1 and <=4. Default 2.

Return value:

self

SQUADRON:SetParkingIDs(ParkingIDs)

Set valid parking spot IDs.

Assets of this squad are only allowed to be spawned at these parking spots. Note that the IDs are different from the ones displayed in the mission editor!

Defined in:

SQUADRON

Parameter:

#table ParkingIDs

Table of parking ID numbers or a single #number.

Return value:

self

SQUADRON:SetTakeoffAir()

Set takeoff type air.

All assets of this squadron will be spawned in air above the airbase.

Defined in:

SQUADRON

Return value:

self

SQUADRON:SetTakeoffCold()

Set takeoff type cold (default).

All assets of this squadron will be spawned with engines off (cold).

Defined in:

SQUADRON

Return value:

self

SQUADRON:SetTakeoffHot()

Set takeoff type hot.

All assets of this squadron will be spawned with engines on (hot).

Defined in:

SQUADRON

Return value:

self

SQUADRON:SetTakeoffType(TakeoffType)

Set takeoff type.

All assets of this squadron will be spawned with cold (default) or hot engines. Spawning on runways is not supported.

Defined in:

SQUADRON

Parameter:

#string TakeoffType

Take off type: "Cold" (default) or "Hot" with engines on or "Air" for spawning in air.

Return value:

self

SQUADRON:onafterStart(From, Event, To)

On after Start event.

Starts the FLIGHTGROUP FSM and event handlers.

Defined in:

SQUADRON

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

SQUADRON:onafterStatus(From, Event, To)

On after "Status" event.

Defined in:

SQUADRON

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Field(s)

#string SQUADRON.ClassName

Name of the class.

#number SQUADRON.Ngroups

Number of asset flight groups this squadron has.

#string SQUADRON.aircrafttype

Type of the airframe the squadron is using.

#table SQUADRON.assets

Squadron assets.

#string SQUADRON.attribute

Generalized attribute of the squadron template group.

#string SQUADRON.callsignName

Callsign name.

#number SQUADRON.callsigncounter

Counter to increase callsign names for new assets.

#boolean SQUADRON.despawnAfterHolding

Aircraft are despawned after holding.

#boolean SQUADRON.despawnAfterLanding

Aircraft are despawned after landing.

#number SQUADRON.engageRange

Mission range in meters.

#number SQUADRON.fuellow

Low fuel threshold.

#boolean SQUADRON.fuellowRefuel

If true, flight tries to refuel at the nearest tanker.

#boolean SQUADRON.isAir

Is air.

SQUADRON.legion

#string SQUADRON.lid

Class id string for output to DCS log file.

#string SQUADRON.livery

Livery of the squadron.

#number SQUADRON.maintenancetime

Time in seconds needed for maintenance of a returned flight.

#table SQUADRON.missiontypes

Capabilities (mission types and performances) of the squadron.

#number SQUADRON.modex

Modex.

#number SQUADRON.modexcounter

Counter to incease modex number for assets.

#string SQUADRON.name

Name of the squadron.

#number SQUADRON.ngrouping

User defined number of units in the asset group.

#table SQUADRON.parkingIDs

Parking IDs for this squadron.

#number SQUADRON.radioFreq

Radio frequency in MHz the squad uses.

#number SQUADRON.radioModu

Radio modulation the squad uses.

#number SQUADRON.refuelSystem

For refuelable squads, the refuel system used (boom=0 or probe=1). Default nil.

#number SQUADRON.repairtime

Time in seconds for each

#number SQUADRON.skill

Skill of squadron members.

#table SQUADRON.tacanChannel

List of TACAN channels available to the squadron.

#string SQUADRON.takeoffType

Take of type.

#number SQUADRON.tankerSystem

For tanker squads, the refuel system used (boom=0 or probpe=1). Default nil.

Wrapper.Group#GROUP SQUADRON.templategroup

Template group.

#string SQUADRON.templatename

Name of the template group.

#number SQUADRON.verbose

Verbosity level.

#string SQUADRON.version

SQUADRON class version.

Function(s)

SQUADRON:AddAsset(Asset)

Add asset to cohort.

Defined in:

Parameter:

The warehouse asset.

Return value:

self

SQUADRON:AddMissionCapability(MissionTypes, Performance)

Set mission types this cohort is able to perform.

Defined in:

Parameters:

#table MissionTypes

Table of mission types. Can also be passed as a #string if only one type.

#number Performance

Performance describing how good this mission can be performed. Higher is better. Default 50. Max 100.

Return value:

self

SQUADRON:AddTacanChannel(ChannelMin, ChannelMax)

Add TACAN channels to the cohort.

Note that channels can only range from 1 to 126.

Defined in:

Parameters:

#number ChannelMin

Channel.

#number ChannelMax

Channel.

Return value:

self

Usage:

mysquad:AddTacanChannel(64,69)  -- adds channels 64, 65, 66, 67, 68, 69

SQUADRON:AddWeaponRange(RangeMin, RangeMax, BitType)

Add a weapon range for ARTY missions (Ops.Auftrag#AUFTRAG).

Defined in:

Parameters:

#number RangeMin

Minimum range in nautical miles. Default 0 NM.

#number RangeMax

Maximum range in nautical miles. Default 10 NM.

#number BitType

Bit mask of weapon type for which the given min/max ranges apply. Default is ENUMS.WeaponFlag.Auto, i.e. for all weapon types.

Return value:

self

SQUADRON:CanMission(Mission)

Check if there is a cohort that can execute a given mission.

We check the mission type, the refuelling system, mission range.

Defined in:

Parameter:

Ops.Auftrag#AUFTRAG Mission

The mission.

Return value:

#boolean:

If true, Cohort can do that type of mission.

SQUADRON:CheckAttribute(Attributes)

Check if the cohort attribute matches the given attribute(s).

Defined in:

Parameter:

#table Attributes

The requested attributes. See WAREHOUSE.Attribute enum. Can also be passed as a single attribute #string.

Return value:

#boolean:

If true, the cohort has the requested attribute.

SQUADRON:CountAssets(InStock, MissionTypes, Attributes)

Count assets in legion warehouse stock.

Defined in:

Parameters:

#boolean InStock

If true, only assets that are in the warehouse stock/inventory are counted. If false, only assets that are NOT in stock (i.e. spawned) are counted. If nil, all assets are counted.

#table MissionTypes

(Optional) Count only assest that can perform certain mission type(s). Default is all types.

#table Attributes

(Optional) Count only assest that have a certain attribute(s), e.g. WAREHOUSE.Attribute.AIR_BOMBER.

Return value:

#number:

Number of assets.

SQUADRON:DelAsset(Asset)

Remove specific asset from chort.

Defined in:

Parameter:

The asset.

Return value:

self

SQUADRON:DelGroup(GroupName)

Remove asset group from cohort.

Defined in:

Parameter:

#string GroupName

Name of the asset group.

Return value:

self

SQUADRON:FetchTacan()

Get an unused TACAN channel.

Defined in:

Return value:

#number:

TACAN channel or nil if no channel is free.

SQUADRON:GetAttribute()

Get generalized attribute.

Defined in:

Return value:

#string:

Generalized attribute, e.g. GROUP.Attribute.Ground_Infantry.

SQUADRON:GetCallsign(Asset)

Create a callsign for the asset.

Defined in:

Parameter:

The warehouse asset.

Return value:

self

SQUADRON:GetCategory()

Get group category.

Defined in:

Return value:

#string:

Group category

SQUADRON:GetMissionCapabilities()

Get mission capabilities of this cohort.

Defined in:

Return value:

#table:

Table of mission capabilities.

SQUADRON:GetMissionCapability(MissionType)

Get missin capability for a given mission type.

Defined in:

Ops.Auftrag#AUFTRAG.Capability:

Parameter:

#string MissionType

Mission type, e.g. AUFTRAG.Type.BAI.

Return value:

Capability table or nil if the capability does not exist.

SQUADRON:GetMissionPeformance(MissionType)

Get mission performance for a given type of misson.

Defined in:

Parameter:

#string MissionType

Type of mission.

Return value:

#number:

Performance or -1.

SQUADRON:GetMissionRange(WeaponTypes)

Get max mission range.

We add the largest weapon range, e.g. for arty or naval if weapon data is available.

Defined in:

Parameter:

#table WeaponTypes

(Optional) Weapon bit type(s) to add to the total range. Default is the max weapon type available.

Return value:

#number:

Range in meters.

SQUADRON:GetMissionTypes()

Get mission types this cohort is able to perform.

Defined in:

Return value:

#table:

Table of mission types. Could be empty {}.

SQUADRON:GetModex(Asset)

Create a modex for the asset.

Defined in:

Parameter:

The warehouse asset.

Return value:

self

SQUADRON:GetName()

Get name of the cohort.

Defined in:

Return value:

#string:

Name of the cohort.

SQUADRON:GetOpsGroups(MissionTypes, Attributes)

Get OPSGROUPs.

Defined in:

Parameters:

#table MissionTypes

(Optional) Count only assest that can perform certain mission type(s). Default is all types.

#table Attributes

(Optional) Count only assest that have a certain attribute(s), e.g. WAREHOUSE.Attribute.AIR_BOMBER.

Return value:

Core.Set#SET_OPSGROUP:

Ops groups set.

SQUADRON:GetProperties()

Get properties, i.e. DCS attributes.

Defined in:

Return value:

#table:

Properties table.

SQUADRON:GetRadio()

Get radio frequency and modulation.

Defined in:

Return values:

#number:

Radio frequency in MHz.

#number:

Radio Modulation (0=AM, 1=FM).

SQUADRON:GetRepairTime(Asset)

Get the time an asset needs to be repaired.

Defined in:

Parameter:

The asset.

Return value:

#number:

Time in seconds until asset is repaired.

SQUADRON:GetWeaponData(BitType)

Get weapon range for given bit type.

Defined in:

Ops.OpsGroup#OPSGROUP.WeaponData:

Parameter:

#number BitType

Bit mask of weapon type.

Return value:

Weapon data.

SQUADRON:HasProperty(Property)

Check if cohort assets have a given property (DCS attribute).

Defined in:

Parameter:

#string Property

The property.

Return value:

#boolean:

If true, cohort assets have the attribute.

SQUADRON:IsOnDuty()

Check if cohort is "OnDuty".

Defined in:

Return value:

#boolean:

If true, cohort is in state "OnDuty".

SQUADRON:IsPaused()

Check if cohort is "Paused".

Defined in:

Return value:

#boolean:

If true, cohort is in state "Paused".

SQUADRON:IsRelocating()

Check if cohort is "Relocating".

Defined in:

Return value:

#boolean:

If true, cohort is relocating.

SQUADRON:IsRepaired(Asset)

Checks if a mission type is contained in a table of possible types.

Defined in:

Parameter:

The asset.

Return value:

#boolean:

If true, the requested mission type is part of the possible mission types.

SQUADRON:IsStopped()

Check if cohort is "Stopped".

Defined in:

Return value:

#boolean:

If true, cohort is in state "Stopped".

SQUADRON:New(TemplateGroupName, Ngroups, CohortName)

Create a new COHORT object and start the FSM.

Defined in:

Parameters:

#string TemplateGroupName

Name of the template group.

#number Ngroups

Number of asset groups of this Cohort. Default 3.

#string CohortName

Name of the cohort.

Return value:

self

SQUADRON:OnAfterPause(From, Event, To)

On after "Pause" event.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

SQUADRON:OnAfterRelocate(From, Event, To)

On after "Relocate" event.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

SQUADRON:OnAfterRelocated(From, Event, To)

On after "Relocated" event.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

SQUADRON:OnAfterUnpause(From, Event, To)

On after "Unpause" event.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

SQUADRON:Pause()

Triggers the FSM event "Pause".

Defined in:

SQUADRON:RecruitAssets(MissionType, Npayloads)

Get assets for a mission.

Defined in:

Parameters:

#string MissionType

Mission type.

#number Npayloads

Number of payloads available.

Return values:

#table:

Assets that can do the required mission.

#number:

Number of payloads still available after recruiting the assets.

SQUADRON:Relocate()

Triggers the FSM event "Relocate".

Defined in:

SQUADRON:Relocated()

Triggers the FSM event "Relocated".

Defined in:

SQUADRON:RemoveAssets(N)

Remove assets from pool.

Not that assets must not be spawned or already reserved or requested.

Defined in:

Parameter:

#number N

Number of assets to be removed. Default 1.

Return value:

self

SQUADRON:ReturnTacan(channel)

"Return" a used TACAN channel.

Defined in:

Parameter:

#number channel

The channel that is available again.

SQUADRON:SetAttribute(Attribute)

Set generalized attribute.

Defined in:

Parameter:

#string Attribute

Generalized attribute, e.g. GROUP.Attribute.Ground_Infantry.

Return value:

self

SQUADRON:SetCallsign(Callsign, Index)

Set call sign.

Defined in:

Parameters:

#number Callsign

Callsign from CALLSIGN.Aircraft, e.g. "Chevy" for CALLSIGN.Aircraft.CHEVY.

#number Index

Callsign index, Chevy-1.

Return value:

self

SQUADRON:SetGrouping(nunits)

Set number of units in groups.

Defined in:

Parameter:

#number nunits

Number of units. Default 2.

Return value:

self

SQUADRON:SetLegion(Legion)

Set Legion.

Defined in:

Parameter:

Ops.Legion#LEGION Legion

The Legion.

Return value:

self

SQUADRON:SetLivery(LiveryName)

Set livery painted on all cohort units.

Note that the livery name in general is different from the name shown in the mission editor.

Valid names are the names of the livery directories. Check out the folder in your DCS installation for:

Full modules: DCS World OpenBeta\CoreMods\aircraft\<Aircraft Type>\Liveries\<Aircraft Type>\<Livery Name>
AI units: DCS World OpenBeta\Bazar\Liveries\<Aircraft Type>\<Livery Name>

The folder name <Livery Name> is the string you want.

Or personal liveries you have installed somewhere in your saved games folder.

Defined in:

Parameter:

#string LiveryName

Name of the livery.

Return value:

self

SQUADRON:SetMissionRange(Range)

Set max mission range.

Only missions in a circle of this radius around the cohort base are executed.

Defined in:

Parameter:

#number Range

Range in NM. Default 150 NM.

Return value:

self

SQUADRON:SetModex(Modex, Prefix, Suffix)

Set modex.

Defined in:

Parameters:

#number Modex

A number like 100.

#string Prefix

A prefix string, which is put before the Modex number.

#string Suffix

A suffix string, which is put after the Modex number.

Return value:

self

SQUADRON:SetRadio(Frequency, Modulation)

Set radio frequency and modulation the cohort uses.

Defined in:

Parameters:

#number Frequency

Radio frequency in MHz. Default 251 MHz.

#number Modulation

Radio modulation. Default 0=AM.

Return value:

self

SQUADRON:SetSkill(Skill)

Set skill level of all cohort team members.

Defined in:

Parameter:

#string Skill

Skill of all flights.

Return value:

self

Usage:

mycohort:SetSkill(AI.Skill.EXCELLENT)

SQUADRON:SetTurnoverTime(MaintenanceTime, RepairTime)

Set turnover and repair time.

If an asset returns from a mission, it will need some time until the asset is available for further missions.

Defined in:

Parameters:

#number MaintenanceTime

Time in minutes it takes until a flight is combat ready again. Default is 0 min.

#number RepairTime

Time in minutes it takes to repair a flight for each life point taken. Default is 0 min.

Return value:

self

SQUADRON:SetVerbosity(VerbosityLevel)

Set verbosity level.

Defined in:

Parameter:

#number VerbosityLevel

Level of output (higher=more). Default 0.

Return value:

self

SQUADRON:Start()

Triggers the FSM event "Start".

Starts the COHORT.

Defined in:

SQUADRON:Status()

Triggers the FSM event "Status".

Defined in:

SQUADRON:Unpause()

Triggers the FSM event "Unpause".

Defined in:

SQUADRON:_AddOperation(Operation)

Add an OPERATION.

Defined in:

Parameter:

Ops.Operation#OPERATION Operation

The operation this cohort is part of.

Return value:

self

SQUADRON:_CheckAmmo()

Check ammo.

Defined in:

Ops.OpsGroup#OPSGROUP.Ammo:

Return value:

Ammo.

SQUADRON:_CheckAssetStatus()

Check asset status.

Defined in:

SQUADRON:_MissileCategoryName(categorynumber)

Returns a name of a missile category.

Defined in:

Parameter:

#number categorynumber

Number of missile category from weapon missile category enumerator. See https://wiki.hoggitworld.com/view/DCS_Class_Weapon

Return value:

#string:

Missile category name.

SQUADRON:__Pause(delay)

Triggers the FSM event "Pause" after a delay.

Defined in:

Parameter:

#number delay

Delay in seconds.

SQUADRON:__Relocate(delay)

Triggers the FSM event "Relocate" after a delay.

Defined in:

Parameter:

#number delay

Delay in seconds.

SQUADRON:__Relocated(delay)

Triggers the FSM event "Relocated" after a delay.

Defined in:

Parameter:

#number delay

Delay in seconds.

SQUADRON:__Start(delay)

Triggers the FSM event "Start" after a delay.

Starts the COHORT.

Defined in:

Parameter:

#number delay

Delay in seconds.

SQUADRON:__Status(delay)

Triggers the FSM event "Status" after a delay.

Defined in:

Parameter:

#number delay

Delay in seconds.

SQUADRON:__Stop(delay)

Triggers the FSM event "Stop" after a delay.

Stops the COHORT and all its event handlers.

Defined in:

Parameter:

#number delay

Delay in seconds.

SQUADRON:__Unpause(delay)

Triggers the FSM event "Unpause" after a delay.

Defined in:

Parameter:

#number delay

Delay in seconds.

SQUADRON:onafterStart(From, Event, To)

On after Start event.

Starts the FLIGHTGROUP FSM and event handlers.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

SQUADRON:onafterStop(From, Event, To)

On after "Stop" event.

Defined in:

Parameters:

#string From

From state.

#string Event

Event.

#string To

To state.

Field(s)

#string SQUADRON.ClassName

Name of the class.

#number SQUADRON.Ngroups

Number of asset flight groups this squadron has.

#string SQUADRON.aircrafttype

Type of the airframe the squadron is using.

#table SQUADRON.assets

Squadron assets.

#string SQUADRON.attribute

Generalized attribute of the squadron template group.

#string SQUADRON.callsignName

Callsign name.

#number SQUADRON.callsigncounter

Counter to increase callsign names for new assets.

#boolean SQUADRON.despawnAfterHolding

Aircraft are despawned after holding.

#boolean SQUADRON.despawnAfterLanding

Aircraft are despawned after landing.

#number SQUADRON.engageRange

Mission range in meters.

#number SQUADRON.fuellow

Low fuel threshold.

#boolean SQUADRON.fuellowRefuel

If true, flight tries to refuel at the nearest tanker.

#boolean SQUADRON.isAir

Is air.

SQUADRON.legion

#string SQUADRON.lid

Class id string for output to DCS log file.

#string SQUADRON.livery

Livery of the squadron.

#number SQUADRON.maintenancetime

Time in seconds needed for maintenance of a returned flight.

#table SQUADRON.missiontypes

Capabilities (mission types and performances) of the squadron.

#number SQUADRON.modex

Modex.

#number SQUADRON.modexcounter

Counter to incease modex number for assets.

#string SQUADRON.name

Name of the squadron.

#number SQUADRON.ngrouping

User defined number of units in the asset group.

#table SQUADRON.parkingIDs

Parking IDs for this squadron.

#number SQUADRON.radioFreq

Radio frequency in MHz the squad uses.

#number SQUADRON.radioModu

Radio modulation the squad uses.

#number SQUADRON.refuelSystem

For refuelable squads, the refuel system used (boom=0 or probe=1). Default nil.

#number SQUADRON.repairtime

Time in seconds for each

#number SQUADRON.skill

Skill of squadron members.

#table SQUADRON.tacanChannel

List of TACAN channels available to the squadron.

#string SQUADRON.takeoffType

Take of type.

#number SQUADRON.tankerSystem

For tanker squads, the refuel system used (boom=0 or probpe=1). Default nil.

Wrapper.Group#GROUP SQUADRON.templategroup

Template group.

#string SQUADRON.templatename

Name of the template group.

#number SQUADRON.verbose

Verbosity level.

#string SQUADRON.version

SQUADRON class version.

Function(s)

SQUADRON:AddEndState(State)

Adds an End state.

Defined in:

Parameter:

#string State

The FSM state.

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

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

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

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

SQUADRON:GetCurrentState()

Get current state.

Defined in:

Return value:

#string:

Current FSM state.

SQUADRON:GetEndStates()

Returns the End states.

Defined in:

Return value:

#table:

End states.

SQUADRON:GetProcess(From, Event)

Defined in:

Parameters:

From

Event

SQUADRON:GetProcesses()

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

Defined in:

Return value:

#table:

Sub processes.

SQUADRON:GetScores()

Returns a table with the scores defined.

Defined in:

Return value:

#table:

Scores.

SQUADRON:GetStartState()

Returns the start state of the FSM.

Defined in:

Return value:

#string:

A string containing the start state.

SQUADRON:GetState()

Get current state.

Defined in:

Return value:

#string:

Current FSM state.

SQUADRON:GetSubs()

Returns a table with the Subs defined.

Defined in:

Return value:

#table:

Sub processes.

SQUADRON:GetTransitions()

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

Defined in:

Return value:

#table:

Transitions.

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

SQUADRON:LoadCallBacks(CallBackTable)

Load call backs.

Defined in:

Parameter:

#table CallBackTable

Table of call backs.

SQUADRON:New()

Creates a new FSM object.

Defined in:

Return value:

#FSM:

SQUADRON:SetProcess(From, Event, Fsm)

Defined in:

Parameters:

From

Event

Fsm

SQUADRON:SetStartState(State)

Sets the start state of the FSM.

Defined in:

Parameter:

#string State

A string defining the start state.

SQUADRON:_add_to_map(Map, Event)

Add to map.

Defined in:

Parameters:

#table Map

Map.

#table Event

Event table.

SQUADRON:_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.

SQUADRON:_create_transition(EventName)

Create transition.

Defined in:

Parameter:

#string EventName

Event name.

Return value:

#function:

Function.

SQUADRON:_delayed_transition(EventName)

Delayed transition.

Defined in:

Parameter:

#string EventName

Event name.

Return value:

#function:

Function.

SQUADRON:_eventmap(Events, EventStructure)

Event map.

Defined in:

Parameters:

#table Events

Events.

#table EventStructure

Event structure.

SQUADRON:_gosub(ParentFrom, ParentEvent)

Go sub.

Defined in:

Parameters:

#string ParentFrom

Parent from state.

#string ParentEvent

Parent event name.

Return value:

#table:

Subs.

SQUADRON:_handler(EventName, ...)

Handler.

Defined in:

Parameters:

#string EventName

Event name.

...

Arguments.

SQUADRON:_isendstate(Current)

Is end state.

Defined in:

Parameter:

#string Current

Current state name.

Return values:

#table:

FSM parent.

#string:

Event name.

SQUADRON:_submap(subs, sub, name)

Sub maps.

Defined in:

Parameters:

#table subs

Subs.

#table sub

Sub.

#string name

Name.

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

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

SQUADRON:is(State, state)

Check if FSM is in state.

Defined in: