dcsex.env.Zone

Zone class.

Contents

  1. Description
  2. Metamethods
    1. zone:__init(zonetbl)
  3. Methods
    1. zone:getZones(zonelist, logger)
    2. zone:getPoint()
    3. zone:getProperty(name)
    4. zone:getPropertyBoolean(name)
    5. zone:getPropertyFloat(name, min, max)
    6. zone:getPropertyInt(name, min, max)

Description

Class that represents a zone table as defined in a mission table.

Metamethods

zone:__init(zonetbl)

Parameters

zonetbl

Methods

zone:getZones(zonelist, logger)

Parameters

zonelist
the list of zone definitions, from the DCS env.mission table this would be env.mission.triggers.zones
logger
reference

Returns

  • a list of Zone objects

zone:getPoint()

Returns

  • dcsex.vector.Vec2

zone:getProperty(name)

Parameters

name
the property name to look up

Returns

  • value or nil if the property doesn’t exist

zone:getPropertyBoolean(name)

Parameters

name
the property name to look up

Returns

  • boolean

zone:getPropertyFloat(name, min, max)

Parameters

name
the property name to look up
min
minimum numerical value
max
maximum numerical value

Returns

  • number clamped between min and max

zone:getPropertyInt(name, min, max)

Parameters

name
the property name to look up
min
minimum numerical value
max
maximum numerical value

Returns

  • number clamped between min and max