Module hoggit.group

Returns the location of the first unit in a given group.

If the group is nil, this function returns nil.

Functions

HOGGIT.smokeAtGroup (grp, smokeColor) Starts a smoke beacon at the specified group's location
HOGGIT.CoordsForGroup (grp, position) Returns a string of coordinates in a format appropriate for the planes of the provided group.
HOGGIT.CoordForPlaneType (planeType, position) Given a plane type and position, return a string representing the position in a format useful for that planetype.


Functions

HOGGIT.smokeAtGroup (grp, smokeColor)
Starts a smoke beacon at the specified group's location

Parameters:

  • grp The group to smoke. Will be placed on or near the first unit.
  • smokeColor The trigger.smokeColor enum value to use. Defaults to White smoke
HOGGIT.CoordsForGroup (grp, position)
Returns a string of coordinates in a format appropriate for the planes of the provided group. i.e. if the group contains F/A-18Cs then we'll return Degrees Minutes Seconds format

Parameters:

  • grp The group the coordinates are going to be presented to
  • position The position (table of x,y,z) coordinates to be translated.

Returns:

    String containing the formatted coordinates. Returns an empty string if either grp or position are nil
HOGGIT.CoordForPlaneType (planeType, position)
Given a plane type and position, return a string representing the position in a format useful for that planetype.

Parameters:

  • planeType String indicating the DCS plane type. See Unit.getTypeName() in DCS Scripting docs.
  • position The position (table of x,y,z) coordinates to be translated

Returns:

    String of coordinates formatted so they can be useful for the given planeType
generated by LDoc 1.4.6 Last updated 2024-07-12 02:45:11