From 6b08f6aaaca1204dcf0ab51da4e26cd68a975027 Mon Sep 17 00:00:00 2001
From: funkyfranky StateMachine callback function StateMachine callback function StateMachine callback function 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. 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. -- The Set of Units in the detected area. -- The Set of Units in the detected area. Creates a new MESSAGE object. Creates a new MESSAGE object of a certain type. Sends a MESSAGE to a Client Group. Sends a MESSAGE to a Coalition. Sends a MESSAGE to a Group. Sends a MESSAGE to the Red Coalition. 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. Note that the Group needs to be defined within the ME with the skillset "Client" or "Player". Sends a MESSAGE to a Coalition. Sends a MESSAGE to a Group. Message 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 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. #string:
+Heading text. #number: Return velocity text of the COORDINATE. #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. #string:
+Velocity text. Mark to Group #number:
+The resulting Mark ID which is a number. Set the heading of the coordinate, if applicable. Set the velocity of the COORDINATE. #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). 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. 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. 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 #number: Sets the SETTINGS Message Display Timing of a MessageType
-
ACT_ACCOUNT_DEADS:onafterEvent(ProcessClient, Task, From, Event, To, EventData)
+ ACT_ACCOUNT_DEADS:onafterEvent(ProcessUnit, Task, From, Event, To, EventData)
-
ACT_ACCOUNT_DEADS:onenterAccountForOther(ProcessClient, Task, From, Event, To, EventData)
+ ACT_ACCOUNT_DEADS:onenterAccountForOther(ProcessUnit, Task, From, Event, To, EventData)
-
ACT_ACCOUNT_DEADS:onenterAccountForPlayer(ProcessClient, Task, From, Event, To, EventData)
+ ACT_ACCOUNT_DEADS:onenterAccountForPlayer(ProcessUnit, Task, From, Event, To, EventData)
@@ -444,7 +444,7 @@ There are 2 moments when state transition methods will be called by the state ma
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 :
-
+ COMMANDCENTER:MessageToGroup(Message, TaskGroup, Name)
+ COMMANDCENTER:MessageToGroup(Message, TaskGroup)
+
+
+ COMMANDCENTER:MessageTypeToCoalition(Message, MessageType)
+
+
+
+
COMMANDCENTER:MessageTypeToGroup(Message, TaskGroup, MessageType)
+
+
@@ -591,7 +603,7 @@ true if in WWII mode.
- Wrapper.Group#GROUP TaskGroup :
+
+ Parameters
+
+#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.
+
Parameters
+
+
@@ -849,8 +915,6 @@ The name before the #-mark indicating the class of the Reference Zones.
#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.Type
- listType
-
diff --git a/docs/Documentation/Designate.html b/docs/Documentation/Designate.html
index acd9d1911..8ecc57ea8 100644
--- a/docs/Documentation/Designate.html
+++ b/docs/Documentation/Designate.html
@@ -1097,7 +1097,7 @@ function below will use the range 1-7 just in case
sring
DETECTION_BASE.DetectedItem.Set
-
-
DETECTION_BASE.DetectedItem.ThreatLevel
-
-
@@ -4058,7 +4052,7 @@ Return false to cancel Transition.
+
-
-
diff --git a/docs/Documentation/Message.html b/docs/Documentation/Message.html
index d88a100d0..ec6d862bc 100644
--- a/docs/Documentation/Message.html
+++ b/docs/Documentation/Message.html
@@ -129,9 +129,27 @@
Type
MESSAGE
+
+
+
+ MESSAGE.MessageCategory
+
+
+
+
+
+ MESSAGE.MessageDuration
+
+
+
+
+ MESSAGE:New(MessageText, MessageDuration, MessageCategory)
+
+
MESSAGE:NewType(MessageText, MessageType)
+
+
@@ -153,13 +171,13 @@
-
MESSAGE:ToClient(Client)
+ MESSAGE:ToClient(Client, Settings)
-
MESSAGE:ToCoalition(CoalitionSide)
+ MESSAGE:ToCoalition(CoalitionSide, Settings)
@@ -171,7 +189,7 @@
-
+ MESSAGE:ToGroup(Group)
+ MESSAGE:ToGroup(Group, Settings)
@@ -180,6 +198,46 @@
MESSAGE:ToRed()
+
+
+ MESSAGE.Type
+
+
+
+ Type
+ MESSAGE.Type
+
@@ -250,6 +308,33 @@ To send messages, you need to use the To functions.
+
+ MESSAGE.Type.Briefing
+
+
+
+
+
+ MESSAGE.Type.Detailed
+
+
+
+
+
+ MESSAGE.Type.Information
+
+
+
+
+
+ MESSAGE.Type.Overview
+
+
+
+
+
MESSAGE.Type.Update
+
+
+
+
+
+
+ Parameters
+
+
+ #string MessageText :
+is the text of the Message.#MESSAGE.Type MessageType :
+The type of the message.Return value
+
+
+
+
+ Usage:
+
+
+ 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 )
+
+ Parameter
+ Parameters
Wrapper.Client#CLIENT Client :
is the Group of the Client. Settings : Return value
@@ -430,20 +564,25 @@ MessageClient2:ToClient( ClientGroup )
Parameter
+ Parameters
CoalitionSide :
needs to be filled out by the defined structure of the standard scripting engine coalition.side. Settings : Return value
@@ -498,20 +637,25 @@ needs to be filled out by the defined structure of the standard scripting engine
Parameter
+ Parameters
Wrapper.Group#GROUP Group :
is the Group. Settings : Return value
@@ -546,6 +690,96 @@ or
MessageRED = MESSAGE:New( "To the RED Players: You receive a penalty because you've killed one of your own units", "Penalty", 25, "Score" )
MessageRED:ToRed()
+
+
+
+ Type
+
+MESSAGE.TypeField(s)
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/Documentation/Mission.html b/docs/Documentation/Mission.html
index 97e6fddff..9fc977939 100644
--- a/docs/Documentation/Mission.html
+++ b/docs/Documentation/Mission.html
@@ -619,7 +619,7 @@
@@ -2731,30 +2731,23 @@ The delay in seconds.
MISSION:onenterCOMPLETED(From, Event, To)
-
+
Parameters
diff --git a/docs/Documentation/Point.html b/docs/Documentation/Point.html
index 0126c087e..496131c9a 100644
--- a/docs/Documentation/Point.html
+++ b/docs/Documentation/Point.html
@@ -268,12 +268,30 @@
From : #string From : Event : #string Event : To : #string To : COORDINATE:GetDistanceText(Distance, Settings)
+
+
+ COORDINATE:GetHeading()
+
+
+
+
COORDINATE:GetHeadingText(Settings)
+
+
+ COORDINATE:GetLandHeight()
+
+
COORDINATE:GetMovingText(Settings)
+
+
@@ -304,6 +322,24 @@
+ COORDINATE:GetVec3()
+
+
+ COORDINATE:GetVelocity()
+
+
+
+
+ COORDINATE:GetVelocityText(Settings)
+
+
+
+
COORDINATE.Heading
+
+
@@ -340,6 +376,12 @@
+ COORDINATE:MarkToCoalitionRed(MarkText)
+
+
COORDINATE:MarkToGroup(MarkText, MarkGroup)
+
+
@@ -369,7 +411,13 @@
+ COORDINATE:SetHeading(Heading)
-
+
+
+
COORDINATE:SetVelocity(Velocity)
+
+
@@ -480,6 +528,12 @@
+ COORDINATE:Translate(Distance, Angle)
+
+
COORDINATE.Velocity
+
+
@@ -1572,6 +1626,50 @@ The distance text expressed in the units of measurement.
+
+ Return value
+
+
+
+ Parameter
+
+
+ Settings : Return value
+
+
+
+
+
Parameter
+
+
+ Settings : Return value
+
+
@@ -1701,6 +1825,64 @@ The Vec2 format coordinate.
+
+
+ Return value
+
+
+
+ Parameter
+
+
+ Settings : Return value
+
+
+
@@ -1874,6 +2056,44 @@ The resulting Mark ID which is a number.
+ Parameters
+
+
+ #string MarkText :
+Free format text that shows the marking clarification.Wrapper.Group#GROUP MarkGroup :
+The Group that receives the mark.Return value
+
+Usage:
+
+
+ local TargetCoord = TargetGroup:GetCoordinate()
+ local MarkGroup = GROUP:FindByName( "AttackGroup" )
+ local MarkID = TargetCoord:MarkToGroup( "This is a target for the attack group", AttackGroup )
+
+ Parameter
@@ -2023,6 +2243,28 @@ The ID of the mark to be removed.
+ Parameter
+
+
+#string Velocity :
+Velocity in meters per second.
+
+
@@ -3139,6 +3395,7 @@ The y coordinate.
POSITIONABLE:GetMessageText(Message, Name)
+
+
POSITIONABLE:GetMessageType(Message, MessageType, Name)
+
+
@@ -402,6 +408,18 @@
+ POSITIONABLE:MessageToSetGroup(Message, Duration, MessageSetGroup, Name)
+
+
+ POSITIONABLE:MessageTypeToCoalition(Message, MessageType, MessageCoalition)
+
+
+
+
POSITIONABLE:MessageTypeToGroup(Message, MessageType, MessageGroup, Name)
+
+
@@ -912,6 +930,45 @@ The message text
+
+
Parameters
+
+
+ #string Message :
+The message textCore.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.Return value
+
+
+
+
@@ -1685,6 +1742,86 @@ The SET_GROUP collection receiving the message.
+ Parameters
+
+
+#string Message :
+The message textCore.Message#MESSAGE.Type MessageType :
+The message type that determines the duration.Dcs.DCScoalition#coalition MessageCoalition :
+The Coalition receiving the message.
+
+ Parameters
+
+
+#string Message :
+The message textCore.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.
+
@@ -809,7 +809,7 @@ self
Wrapper.Controllable#CONTROLLABLE Controllable : Wrapper.Unit#UNIT Controllable :
Wrapper.Controllable#CONTROLLABLE ProcessUnit : Wrapper.Unit#UNIT ProcessUnit :
Wrapper.Controllable#CONTROLLABLE ProcessUnit : Wrapper.Unit#UNIT ProcessUnit :
@@ -1172,7 +1172,7 @@ The Range to consider the arrival. Default is 10000 meters.
Wrapper.Controllable#CONTROLLABLE ProcessUnit : Wrapper.Unit#UNIT ProcessUnit :
Wrapper.Controllable#CONTROLLABLE ProcessUnit : Wrapper.Unit#UNIT ProcessUnit :
@@ -1478,7 +1478,7 @@ The Zone object where to route to.
Wrapper.Controllable#CONTROLLABLE ProcessUnit : Wrapper.Unit#UNIT ProcessUnit :
Wrapper.Controllable#CONTROLLABLE ProcessUnit : Wrapper.Unit#UNIT ProcessUnit :
diff --git a/docs/Documentation/Set.html b/docs/Documentation/Set.html
index 5ea5133ca..815665856 100644
--- a/docs/Documentation/Set.html
+++ b/docs/Documentation/Set.html
@@ -1027,12 +1027,24 @@ mission designer to add a dedicated method
Wrapper.Controllable#CONTROLLABLE ProcessUnit : Wrapper.Unit#UNIT ProcessUnit :
+
+
SET_UNIT:GetCoordinate()
+
+
+ SET_UNIT:GetFirst()
+
+
SET_UNIT:GetHeading()
+
+
@@ -1057,6 +1069,12 @@ mission designer to add a dedicated method
+ SET_UNIT:GetUnitTypesText()
+
+
SET_UNIT:GetVelocity()
+
+
@@ -5022,6 +5040,24 @@ self
+
+ Return value
+
+
+
+ Return value
+
+
+
+ Return value
+
+
+
SETTINGS:GetMGRS_Accuracy()
+
+
SETTINGS:GetMessageTime(MessageType)
+
+
@@ -296,6 +302,12 @@
+ SETTINGS:MenuGroupMWSystem(PlayerUnit, PlayerGroup, PlayerName, MW)
+
+
+
SETTINGS:MenuGroupMessageTimingsSystem(PlayerUnit, PlayerGroup, PlayerName, MessageType, MessageTime)
+
+
@@ -314,6 +326,18 @@
+ SETTINGS:MenuMWSystem(MenuGroup, RootMenu, MW)
+
+
+
+ SETTINGS:MenuMessageTimingsSystem(MenuGroup, RootMenu, MessageType, MessageTime)
+
+
+
+
+
SETTINGS.MessageTypeTimings
+
+
@@ -410,6 +434,12 @@
+ SETTINGS:SetMGRS_Accuracy(MGRS_Accuracy)
+
+
SETTINGS:SetMessageTime(MessageType, MessageTime)
+
+
@@ -576,6 +606,33 @@
-
+
Parameter
+
+
+ Core.Message#MESSAGE MessageType :
+The type of the message.Return value
+
+
@@ -1001,6 +1058,47 @@ true if metric.
+ Parameters
+
+
+ PlayerUnit : PlayerGroup : PlayerName : MessageType : MessageTime :
+
+
+
+ Parameters
+
+
+ MenuGroup : RootMenu : MessageType : MessageTime :
+
@@ -1406,6 +1553,34 @@ true if metric.
+ Parameters
+
+
+Core.Message#MESSAGE MessageType :
+The type of the message.#number MessageTime :
+The display time duration in seconds of the MessageType.
+
SPAWN:_TranslateRotate(SpawnIndex, SpawnRootX, SpawnRootY, SpawnX, SpawnY, SpawnAngle)
-
-
-
@@ -2739,9 +2733,6 @@ when nothing was spawned.SPAWN.uncontrolled
-
-
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.