diff --git a/.gitignore b/.gitignore index 135102f04..ec71258a4 100644 --- a/.gitignore +++ b/.gitignore @@ -221,3 +221,4 @@ _gsdata_/ .gitattributes .gitignore Moose Test Missions/MOOSE_Test_Template.miz +*.html diff --git a/docs/Documentation/Account.html b/docs/Documentation/Account.html index 24ae8f028..67a542954 100644 --- a/docs/Documentation/Account.html +++ b/docs/Documentation/Account.html @@ -245,19 +245,19 @@
StateMachine callback function
StateMachine callback function
StateMachine callback function
Wrapper.Controllable#CONTROLLABLE ProcessUnit :
Wrapper.Unit#UNIT ProcessUnit :
Wrapper.Controllable#CONTROLLABLE ProcessUnit :
Wrapper.Unit#UNIT ProcessUnit :
Wrapper.Controllable#CONTROLLABLE ProcessUnit :
Wrapper.Unit#UNIT ProcessUnit :
Wrapper.Client#CLIENT ProcessClient :
Wrapper.Unit#UNIT ProcessUnit :
Wrapper.Client#CLIENT ProcessClient :
Wrapper.Unit#UNIT ProcessUnit :
Wrapper.Client#CLIENT ProcessClient :
Wrapper.Unit#UNIT ProcessUnit :
Wrapper.Controllable#CONTROLLABLE ProcessUnit :
Wrapper.Unit#UNIT ProcessUnit :
Wrapper.Controllable#CONTROLLABLE ProcessUnit :
Wrapper.Unit#UNIT ProcessUnit :
Wrapper.Controllable#CONTROLLABLE ProcessUnit :
Wrapper.Unit#UNIT ProcessUnit :
Wrapper.Controllable#CONTROLLABLE ProcessUnit :
Wrapper.Unit#UNIT ProcessUnit :
Send a CC message to a GROUP.
+Send a CC message of a specified type to the coalition of the CC.
+Send a CC message of a specified type to a GROUP.
Wrapper.Group#GROUP TaskGroup :
Send a CC message of a specified type to the coalition of the CC.
+ +#sring Name :
-(optional) The name of the Group used as a prefix for the message to the Group. If not provided, there will be nothing shown.
#string Message :
+The message.
Core.Message#MESSAGE.MessageType MessageType :
+The type of the message, resulting in automatic time duration and prefix of the message.
Send a CC message of a specified type to a GROUP.
+ +#string Message :
Wrapper.Group#GROUP TaskGroup :
Core.Message#MESSAGE.MessageType MessageType :
+The type of the message, resulting in automatic time duration and prefix of the message.
listsring-- The Set of Units in the detected area.
--- The Set of Units in the detected area.
- -MESSAGE| MESSAGE.MessageCategory | ++ + | +|||
| MESSAGE.MessageDuration | ++ + | +|||
| MESSAGE:New(MessageText, MessageDuration, MessageCategory) |
Creates a new MESSAGE object. + |
+ |||
| MESSAGE:NewType(MessageText, MessageType) | +
+ Creates a new MESSAGE object of a certain type. |
|||
| MESSAGE:ToClient(Client) | +MESSAGE:ToClient(Client, Settings) |
Sends a MESSAGE to a Client Group. |
||
| MESSAGE:ToCoalition(CoalitionSide) | +MESSAGE:ToCoalition(CoalitionSide, Settings) |
Sends a MESSAGE to a Coalition. |
@@ -171,7 +189,7 @@
||
| MESSAGE:ToGroup(Group) | +MESSAGE:ToGroup(Group, Settings) |
Sends a MESSAGE to a Group. |
@@ -180,6 +198,46 @@
MESSAGE:ToRed() |
Sends a MESSAGE to the Red Coalition. + |
+
| MESSAGE.Type | ++ + | +
MESSAGE.Type| MESSAGE.Type.Briefing | ++ + | +
| MESSAGE.Type.Detailed | ++ + | +
| MESSAGE.Type.Information | ++ + | +
| MESSAGE.Type.Overview | ++ + | +
| MESSAGE.Type.Update | ++ |
Creates a new MESSAGE object of a certain type.
+ + +Note that these MESSAGE objects are not yet displayed on the display panel. +You must use the functions ToClient or ToCoalition or ToAll to send these Messages to the respective recipients. +The message display times are automatically defined based on the timing settings in the Settings menu.
+ +#string MessageText :
+is the text of the Message.
#MESSAGE.Type MessageType :
+The type of the message.
MessageAll = MESSAGE:NewType( "To all Players: BLUE has won! Each player of BLUE wins 50 points!", MESSAGE.Type.Information )
+ MessageRED = MESSAGE:NewType( "To the RED Players: You receive a penalty because you've killed one of your own units", MESSAGE.Type.Information )
+ MessageClient1 = MESSAGE:NewType( "Congratulations, you've just hit a target", MESSAGE.Type.Update )
+ MessageClient2 = MESSAGE:NewType( "Congratulations, you've just killed a target", MESSAGE.Type.Update )
+
+Note that the Group needs to be defined within the ME with the skillset "Client" or "Player".
-Wrapper.Client#CLIENT Client :
is the Group of the Client.
Settings :
Sends a MESSAGE to a Coalition.
- CoalitionSide :
needs to be filled out by the defined structure of the standard scripting engine coalition.side.
Settings :
Sends a MESSAGE to a Group.
-Wrapper.Group#GROUP Group :
is the Group.
Settings :
MESSAGE.TypeMessage Types
+ +FSM function for a MISSION
FSM function for a MISSION - @param #MISSION self - @param #string From - @param #string Event - @param #string To
+FSM function for a MISSION
From :
#string From :
Event :
#string Event :
To :
#string To :
Provides a distance text expressed in the units of measurement.
+Get the heading of the coordinate, if applicable.
+Return the heading text of the COORDINATE.
Return the height of the land at the coordinate.
+Return velocity text of the COORDINATE.
Return the coordinates of the COORDINATE in Vec3 format.
+Return the velocity of the COORDINATE.
+Return the velocity text of the COORDINATE.
+Mark to Red Coalition
+Mark to Group
Set the heading of the coordinate, if applicable.
+Set the velocity of the COORDINATE.
Add a Distance in meters from the COORDINATE orthonormal plane, with the given angle, and calculate the new COORDINATE.
+Get the heading of the coordinate, if applicable.
+ +#number: +or nil
+ +Return the heading text of the COORDINATE.
+ + Settings :
#string: +Heading text.
+ +#number:
+ +Return velocity text of the COORDINATE.
+ + Settings :
#string:
+ +Dcs.DCSTypes#Vec3: The Vec3 format coordinate.
+ +Return the velocity of the COORDINATE.
+ +#number: +Velocity in meters per second.
+ +Return the velocity text of the COORDINATE.
+ + Settings :
#string: +Velocity text.
+ +Mark to Group
+ +#string MarkText :
+Free format text that shows the marking clarification.
Wrapper.Group#GROUP MarkGroup :
+The Group that receives the mark.
#number: +The resulting Mark ID which is a number.
+ + local TargetCoord = TargetGroup:GetCoordinate()
+ local MarkGroup = GROUP:FindByName( "AttackGroup" )
+ local MarkID = TargetCoord:MarkToGroup( "This is a target for the attack group", AttackGroup )
+
+Set the heading of the coordinate, if applicable.
Set the velocity of the COORDINATE.
+ +#string Velocity :
+Velocity in meters per second.
#COORDINATE: The new calculated COORDINATE.
+Returns the message text with the callsign embedded (if there is one).
+Returns a message of a specified type with the callsign embedded (if there is one).
Send a message to a Set#SET_GROUP.
+Send a message to a coalition.
+Send a message of a message type to a Group.
#string: The message text
+ + +Returns a message of a specified type with the callsign embedded (if there is one).
+ +#string Message :
+The message text
Core.Message#MESSAGE MessageType :
+MessageType The message type.
#string Name :
+(optional) The Name of the sender. If not provided, the Name is the type of the Positionable.
Send a message to a coalition.
+ + +The message will appear in the message area. The message will begin with the callsign of the group and the type of the first unit sending the message.
+ +#string Message :
+The message text
Core.Message#MESSAGE.Type MessageType :
+The message type that determines the duration.
Dcs.DCScoalition#coalition MessageCoalition :
+The Coalition receiving the message.
Send a message of a message type to a Group.
+ + +The message will appear in the message area. The message will begin with the callsign of the group and the type of the first unit sending the message.
+ +#string Message :
+The message text
Core.Message#MESSAGE.Type MessageType :
+The message type that determines the duration.
Wrapper.Group#GROUP MessageGroup :
+The GROUP object receiving the message.
#string Name :
+(optional) The Name of the sender. If not provided, the Name is the type of the Positionable.
Wrapper.Controllable#CONTROLLABLE Controllable :
Wrapper.Unit#UNIT Controllable :
Wrapper.Controllable#CONTROLLABLE ProcessUnit :
Wrapper.Unit#UNIT ProcessUnit :
Wrapper.Controllable#CONTROLLABLE ProcessUnit :
Wrapper.Unit#UNIT ProcessUnit :
Wrapper.Controllable#CONTROLLABLE ProcessUnit :
Wrapper.Unit#UNIT ProcessUnit :
Wrapper.Controllable#CONTROLLABLE ProcessUnit :
Wrapper.Unit#UNIT ProcessUnit :
Wrapper.Controllable#CONTROLLABLE ProcessUnit :
Wrapper.Unit#UNIT ProcessUnit :
Wrapper.Controllable#CONTROLLABLE ProcessUnit :
Wrapper.Unit#UNIT ProcessUnit :
Wrapper.Controllable#CONTROLLABLE ProcessUnit :
Wrapper.Unit#UNIT ProcessUnit :
Iterate the SET_UNIT sorted *per Threat Level and call an interator function for each alive UNIT, providing the UNIT and optional parameters.
+Get the center coordinate of the SET_UNIT.
Get the first unit from the set.
+Get the average heading of the SET_UNIT.
Returns a comma separated string of the unit types with a count in the Set.
+Get the maximum velocity of the SET_UNIT.
Get the center coordinate of the SET_UNIT.
+ +Core.Point#COORDINATE: +The center coordinate of all the units in the set, including heading in degrees and speed in mps in case of moving units.
+ +Get the average heading of the SET_UNIT.
+ +#number: +Heading Heading in degrees and speed in mps in case of moving units.
+ +Get the maximum velocity of the SET_UNIT.
+ +#number: +The speed in mps in case of moving units.
+ +Gets the SETTINGS MGRS accuracy.
+Gets the SETTINGS Message Display Timing of a MessageType
Sets the SETTINGS MGRS accuracy.
+Sets the SETTINGS Message Display Timing of a MessageType
#number:
+ + +Gets the SETTINGS Message Display Timing of a MessageType
+ +Core.Message#MESSAGE MessageType :
+The type of the message.
#number:
+ + PlayerUnit :
PlayerGroup :
PlayerName :
MessageType :
MessageTime :
MenuGroup :
RootMenu :
MessageType :
MessageTime :
Sets the SETTINGS Message Display Timing of a MessageType
+ +Core.Message#MESSAGE MessageType :
+The type of the message.
#number MessageTime :
+The display time duration in seconds of the MessageType.
Overwrite unit names by default with group name.
-When the first Spawn executes, all the Groups need to be made visible before start.
+Flag that indicates if all the Groups of the SpawnGroup need to be visible when Spawned.