Module UserFlag

Core (WIP) -- Manage user flags.

Management of DCS User Flags.

Author: FlightControl

Global(s)

USERFLAG

USERFLAG class, extends Base#BASE

Management of DCS User Flags.

Type USERFLAG

USERFLAG:Get(Number)

Get the userflag Number.
USERFLAG:Is(Number)

Check if the userflag has a value of Number.
USERFLAG:New(UserFlagName)

USERFLAG Constructor.
USERFLAG:Set(Number)

Set the userflag to a given Number.
USERFLAG.UserFlagName

Global(s)

#USERFLAG USERFLAG

USERFLAG class, extends Base#BASE

Management of DCS User Flags.

1. USERFLAG constructor

Type UserFlag

Type USERFLAG

Field(s)

USERFLAG:Get(Number)

Get the userflag Number.

Parameter

  • Number :

Return value

#number: Number The number value to be checked if it is the same as the userflag.

Usage:

  local BlueVictory = USERFLAG:New( "VictoryBlue" )
  local BlueVictoryValue = BlueVictory:Get() -- Get the UserFlag VictoryBlue value.
USERFLAG:Is(Number)

Check if the userflag has a value of Number.

Parameter

  • #number Number : The number value to be checked if it is the same as the userflag.

Return value

#boolean: true if the Number is the value of the userflag.

Usage:

  local BlueVictory = USERFLAG:New( "VictoryBlue" )
  if BlueVictory:Is( 1 ) then
    return "Blue has won"
  end
USERFLAG:New(UserFlagName)

USERFLAG Constructor.

Parameter

  • #string UserFlagName : The name of the userflag, which is a free text string.

Return value

#USERFLAG:

USERFLAG:Set(Number)

Set the userflag to a given Number.

Parameter

  • #number Number : The number value to be checked if it is the same as the userflag.

Return value

#USERFLAG: The userflag instance.

Usage:

  local BlueVictory = USERFLAG:New( "VictoryBlue" )
  BlueVictory:Set( 100 ) -- Set the UserFlag VictoryBlue to 100.
USERFLAG.UserFlagName