ldoc

• Index

Contents

• Tables
• Methods

Classes

• BASE
• CARGO
• CLEANUP
• CLIENT
• DATABASE
• DEPLOYTASK
• DESTROYBASETASK
• DESTROYGROUPSTASK
• DESTROYRADARSTASK
• DESTROYUNITTYPESTASK
• GOHOMETASK
• GROUP
• MENU
• MESSAGE
• MISSION
• MOVEMENT
• NOTASK
• PICKUPTASK
• ROUTETASK
• SEAD
• SPAWN
• STAGE
• TASK
• UNIT
• ZONE

Modules

• routines
• trace

Scripts

• eStatHandler

Class CLIENT

CLIENT Classes

Tables

CLIENT.CLIENT

Clients are those Groups defined within the Mission Editor that have the skillset defined as "Client" or "Player".

Methods

CLIENT:New (ClientName, ClientBriefing)	Use this method to register new Clients within the MOF.
CLIENT:Reset (ClientName)	Resets a CLIENT.
CLIENT:ClientGroup ()	ClientGroup returns the Group of a Client.
CLIENT:GetClientGroupUnit ()	Returns the Unit of the CLIENT.
CLIENT:GetClientGroupDCSUnit ()	Returns the DCSUnit of the CLIENT.
CLIENT:ClientPosition ()	Returns the Position of the CLIENT.
CLIENT:Transport ()	Transport defines that the Client is a Transport.
CLIENT:AddBriefing (ClientBriefing)	AddBriefing adds a briefing to a Client when a Player joins a Mission.
CLIENT:IsTransport ()	IsTransport returns if a Client is a transport.
CLIENT:ShowCargo ()	ShowCargo shows the CARGO within the CLIENT to the Player.
CLIENT:SwitchMessages (PrmTable)	SwitchMessages is a local function called by the DCS World Menu system to switch off messages.
CLIENT:Message (Message, MessageDuration, MessageId, MessageCategory, MessageInterval)	Message is the key Message driver for the CLIENT class.

Tables

CLIENT.CLIENT

Clients are those Groups defined within the Mission Editor that have the skillset defined as "Client" or "Player". These clients are defined within the Mission Orchestration Framework (MOF)

Fields:

• ONBOARDSIDE
• LEFT
• RIGHT
• BACK
• FRONT

Methods

CLIENT:New (ClientName, ClientBriefing)

Use this method to register new Clients within the MOF.

Parameters:

• ClientName string Name of the Group as defined within the Mission Editor. The Group must have a Unit with the type Client.
• ClientBriefing string Text that describes the briefing of the mission when a Player logs into the Client.

Returns:

CLIENT

Usage:

 -- Create new Clients.
	local Mission = MISSIONSCHEDULER.AddMission( 'Russia Transport Troops SA-6', 'Operational', 'Transport troops from the control center to one of the SA-6 SAM sites to activate their operation.', 'Russia' )
	Mission:AddGoal( DeploySA6TroopsGoal )

	Mission:AddClient( CLIENT:New( 'RU MI-8MTV2*HOT-Deploy Troops 1' ):Transport() )
	Mission:AddClient( CLIENT:New( 'RU MI-8MTV2*RAMP-Deploy Troops 3' ):Transport() )
	Mission:AddClient( CLIENT:New( 'RU MI-8MTV2*HOT-Deploy Troops 2' ):Transport() )
	Mission:AddClient( CLIENT:New( 'RU MI-8MTV2*RAMP-Deploy Troops 4' ):Transport() )

CLIENT:Reset (ClientName)

Resets a CLIENT.

Parameters:

• ClientName string Name of the Group as defined within the Mission Editor. The Group must have a Unit with the type Client.

CLIENT:ClientGroup ()

ClientGroup returns the Group of a Client. This function is modified to deal with a couple of bugs in DCS 1.5.3

Returns:

Group

CLIENT:GetClientGroupUnit ()

Returns the Unit of the CLIENT.

Returns:

Unit

CLIENT:GetClientGroupDCSUnit ()

Returns the DCSUnit of the CLIENT.

Returns:

DCSUnit

CLIENT:ClientPosition ()

Returns the Position of the CLIENT.

Returns:

Position

CLIENT:Transport ()

Transport defines that the Client is a Transport.

Returns:

CLIENT

CLIENT:AddBriefing (ClientBriefing)

AddBriefing adds a briefing to a Client when a Player joins a Mission.

Parameters:

• ClientBriefing string is the text defining the Mission briefing.

Returns:

CLIENT

CLIENT:IsTransport ()

IsTransport returns if a Client is a transport.

Returns:

bool

CLIENT:ShowCargo ()

ShowCargo shows the CARGO within the CLIENT to the Player. The CARGO is shown throught the MESSAGE system of DCS World.

CLIENT:SwitchMessages (PrmTable)

SwitchMessages is a local function called by the DCS World Menu system to switch off messages.

Parameters:

• PrmTable

CLIENT:Message (Message, MessageDuration, MessageId, MessageCategory, MessageInterval)

Message is the key Message driver for the CLIENT class. This function displays various messages to the Player logged into the CLIENT through the DCS World Messaging system.

Parameters:

• Message string is the text describing the message.
• MessageDuration number is the duration in seconds that the Message should be displayed.
• MessageId string is a text identifying the Message in the MessageQueue. The Message system overwrites Messages with the same MessageId
• MessageCategory string is the category of the message (the title).
• MessageInterval number is the interval in seconds between the display of the Message when the CLIENT is in the air.