Module `Client`

CLIENT Classes

Global(s)

CLIENT
ClientGroupUnit

Type `CLIENT`

CLIENT.AddBriefing(string, self, ClientBriefing)	AddBriefing adds a briefing to a Client when a Player joins a Mission.
CLIENT:Alive(CallBack)	Checks for a client alive event and calls a function on a continuous basis.
CLIENT.AliveCheckFunction
CLIENT.ClassName
CLIENT.ClientAlive
CLIENT.ClientAlive2
CLIENT.ClientBriefingShown
CLIENT.ClientCallBack
CLIENT.ClientName
CLIENT:ClientPosition()	Returns the Position of the CLIENT.
CLIENT.ClientTransport
CLIENT:GetAltitude()	Returns the altitude of the CLIENT.
CLIENT:GetClientGroupDCSUnit()	Returns the DCSUnit of the CLIENT.
CLIENT:GetClientGroupID()
CLIENT:GetClientGroupName()
CLIENT:GetClientGroupUnit()	Returns the Unit of the CLIENT.
CLIENT:GetDCSGroup()	Return the DCSGroup of a Client.
CLIENT:GetPointVec2()	Returns the Point of the CLIENT.
CLIENT:GetUnit()
CLIENT:IsAlive(Returns)	Checks if client is alive and returns true or false.
CLIENT:IsTransport()	IsTransport returns if a Client is a transport.
CLIENT.Message(string, number, string, string, number, self, Message, MessageDuration, MessageId, MessageCategory, MessageInterval)	Message is the key Message driver for the CLIENT class.
CLIENT.Messages
CLIENT:New(ClientName, ClientBriefing)	Use this method to register new Clients within the MOF.
CLIENT.ONBOARDSIDE
CLIENT.Reset(string, self, ClientName)	Resets a CLIENT.
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:Transport()	Transport defines that the Client is a Transport.
CLIENT:_AliveCheckCallBack()
CLIENT._Menus
CLIENT._Tasks

Global(s)

#CLIENT CLIENT

ClientGroupUnit

Type `Client`

Type `CLIENT`

The CLIENT class

Field(s)

CLIENT.AddBriefing(string, self, ClientBriefing)

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

Parameters

string : ClientBriefing is the text defining the Mission briefing.
self :
ClientBriefing :

Return value

CLIENT

CLIENT:Alive(CallBack)

Checks for a client alive event and calls a function on a continuous basis.

Parameter

#function CallBack : Function.

CLIENT.AliveCheckFunction

#string CLIENT.ClassName

#boolean CLIENT.ClientAlive

#boolean CLIENT.ClientAlive2

#boolean CLIENT.ClientBriefingShown

CLIENT.ClientCallBack

CLIENT.ClientName

CLIENT:ClientPosition()

Returns the Position of the CLIENT.

Return value

DCSTypes#Position:

#boolean CLIENT.ClientTransport

CLIENT:GetAltitude()

Returns the altitude of the CLIENT.

Return value

DCSTypes#Distance:

CLIENT:GetClientGroupDCSUnit()

Returns the DCSUnit of the CLIENT.

Return value

DCSUnit

CLIENT:GetClientGroupID()

CLIENT:GetClientGroupName()

CLIENT:GetClientGroupUnit()

Returns the Unit of the CLIENT.

Return value

Unit#UNIT:

CLIENT:GetDCSGroup()

Return the DCSGroup of a Client.

This function is modified to deal with a couple of bugs in DCS 1.5.3

Return value

DCSGroup#Group:

CLIENT:GetPointVec2()

Returns the Point of the CLIENT.

Return value

DCSTypes#Vec2:

CLIENT:GetUnit()

CLIENT:IsAlive(Returns)

Checks if client is alive and returns true or false.

Parameter

#boolean Returns : true if client is alive.

CLIENT:IsTransport()

IsTransport returns if a Client is a transport.

Return value

bool

CLIENT.Message(string, number, string, string, number, self, 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

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

CLIENT.Messages

CLIENT:New(ClientName, ClientBriefing)

Use this method to register new Clients within the MOF.

Parameters

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

Return value

#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() )