Module CargoUnit

Cargo -- Management of single cargo logistics, which are based on a Unit object.


Banner Image


Demo Missions

YouTube Playlist


Author: FlightControl

Contributions:


Global(s)

CARGO_UNIT

CARGO_UNIT class, extends #CARGO_REPRESENTABLE

The CARGO_UNIT class defines a cargo that is represented by a UNIT object within the simulator, and can be transported by a carrier.

Type CARGO_UNIT

CARGO_UNIT.CargoCarrier
CARGO_UNIT.CargoInAir
CARGO_UNIT.CargoObject
CARGO_UNIT:GetTransportationMethod()

Get the transportation method of the Cargo.

CARGO_UNIT:New(CargoUnit, Type, Name, Weight, LoadRadius, NearRadius)

CARGO_UNIT Constructor.

CARGO_UNIT.OnUnLoadedCallBack
CARGO_UNIT.RunCount
CARGO_UNIT:onafterBoard(Event, From, To, CargoCarrier, NearRadius, ...)

Board Event.

CARGO_UNIT:onafterBoarding(Event, From, To, CargoCarrier, NearRadius, ...)

Boarding Event.

CARGO_UNIT:onafterUnBoarding(Event, From, To, ToPointVec2, NearRadius)

UnBoard Event.

CARGO_UNIT:onenterBoarding(Event, From, To, CargoCarrier, NearRadius, ...)

Enter Boarding State.

CARGO_UNIT:onenterLoaded(Event, From, To, CargoCarrier)

Loaded State.

CARGO_UNIT:onenterUnBoarding(Event, From, To, ToPointVec2, NearRadius)

Enter UnBoarding State.

CARGO_UNIT:onenterUnLoaded(Event, From, To, Core, ToPointVec2)

Enter UnLoaded State.

CARGO_UNIT:onleaveUnBoarding(Event, From, To, ToPointVec2, NearRadius)

Leave UnBoarding State.

Global(s)

#CARGO_UNIT CARGO_UNIT

CARGO_UNIT class, extends #CARGO_REPRESENTABLE

The CARGO_UNIT class defines a cargo that is represented by a UNIT object within the simulator, and can be transported by a carrier.

Use the event functions as described above to Load, UnLoad, Board, UnBoard the CARGO_UNIT objects to and from carriers.


Type CargoUnit

Type CARGO_UNIT

Extends Cargo.Cargo#CARGO_REPRESENTABLE

Models CARGO in the form of units, which can be boarded, unboarded, loaded, unloaded.

Field(s)

CARGO_UNIT.CargoCarrier
CARGO_UNIT.CargoInAir
CARGO_UNIT.CargoObject
CARGO_UNIT:GetTransportationMethod()

Get the transportation method of the Cargo.

Return value

#string: The transportation method of the Cargo.

CARGO_UNIT:New(CargoUnit, Type, Name, Weight, LoadRadius, NearRadius)

CARGO_UNIT Constructor.

Parameters

  • Wrapper.Unit#UNIT CargoUnit :

  • #string Type :

  • #string Name :

  • #number Weight :

  • #number LoadRadius : (optional)

  • #number NearRadius : (optional)

Return value

#CARGO_UNIT:

CARGO_UNIT.OnUnLoadedCallBack
#number CARGO_UNIT.RunCount
CARGO_UNIT:onafterBoard(Event, From, To, CargoCarrier, NearRadius, ...)

Board Event.

Parameters

  • #string Event :

  • #string From :

  • #string To :

  • CargoCarrier :

  • NearRadius :

  • ... :

CARGO_UNIT:onafterBoarding(Event, From, To, CargoCarrier, NearRadius, ...)

Boarding Event.

Parameters

  • #string Event :

  • #string From :

  • #string To :

  • Wrapper.Client#CLIENT CargoCarrier :

  • #number NearRadius :

  • ... :

CARGO_UNIT:onafterUnBoarding(Event, From, To, ToPointVec2, NearRadius)

UnBoard Event.

Parameters

CARGO_UNIT:onenterBoarding(Event, From, To, CargoCarrier, NearRadius, ...)

Enter Boarding State.

Parameters

  • #string Event :

  • #string From :

  • #string To :

  • Wrapper.Unit#UNIT CargoCarrier :

  • NearRadius :

  • ... :

CARGO_UNIT:onenterLoaded(Event, From, To, CargoCarrier)

Loaded State.

Parameters

CARGO_UNIT:onenterUnBoarding(Event, From, To, ToPointVec2, NearRadius)

Enter UnBoarding State.

Parameters

CARGO_UNIT:onenterUnLoaded(Event, From, To, Core, ToPointVec2)

Enter UnLoaded State.

Parameters

  • #string Event :

  • #string From :

  • #string To :

  • Core : Point#POINT_VEC2

  • ToPointVec2 :

CARGO_UNIT:onleaveUnBoarding(Event, From, To, ToPointVec2, NearRadius)

Leave UnBoarding State.

Parameters