Skip to content

Random air traffic

Generates random air traffic (RAT) based on a template group. Yams will spawn no more than the desired number of groups. It will schedule a check every 60 seconds to ensure there is enough aircraft in the sky.

For best results, set the template group to late activation to supress it from being spawned on startup. This saves a bit of CPU processing for you.

Info

This function is a convenience over the generator:spawn function it is basically an opinionated wrapper. If you want more control, check out the generator module.

Example

local rat = yams.random_air_traffic
local positions = {

}
rat                             -- configure the RAT
    :using_group("RAAF F18C")   -- tell it the name of the group to use for the traffic
    :no_more_than(10)           -- configure the maximum number of groups in the air
    :start_from_air(4500)        -- (Optional) tell the RAT to start planes at a specific altitude
    :init()

random_air_traffic:with_rules_of_engagement

By default, air traffic will have zero aggression and will land at the first sign of trouble. It's primary use case is for modelling civilian air traffic.

This behaviour may be adjusted with this function to observe different rules_of_engagement & reaction_to_threat. This applies to every aircraft. If you wish to use the behaviour set in the aircraft template, use yams.enums.rules_of_engagement.inherit.

Example

local rat = yams.random_air_traffic
local weapons_free = yams.enums.rules_of_engagement.WEAPONS_FREE
local evade_fire = yams.enums.reaction_to_threat.EVADE_FIRE
rat
    :with_name("Iranian Combat Air Patrol")
    :using_group("IRANAF-CAP")
    :no_more_than(5)
    :start_in_air(4500)
    :with_rules_of_engagement(weapons_free)
    :with_reaction_to_threat(evade_fire)
    :init()

random_air_traffic:with_reaction_to_threat

Example

yams.random_air_traffic:with_reaction_to_threat(rtt)

random_air_traffic:with_name

Gives this random air traffic a name to identify it by, which is displayed in logs

random_air_traffic:using_template

Use a group_name to find a late activated template group for use in random air traffic generation

random_air_traffic:no_more_than

Set the maximum number of aircraft spawned for random air traffic

random_air_traffic:from_pool_of

Example

yams.random_air_traffic:from_pool_of(count)

random_air_traffic:start_in_air

Tells all traffic to be spawned in the air at a given altitude

random_air_traffic:get_airbase_positions_for

Example

yams.random_air_traffic:get_airbase_positions_for(coalition)

random_air_traffic:start

Final call in the random_air_traffic fluent API. Use this to start random air traffic using the parameters set by previous calls.