Module Wrapper.Marker
Wrapper - Markers On the F10 map.
Main Features:
- Convenient handling of markers via multiple user API functions.
- Update text and position of marker easily via scripting.
- Delay creation and removal of markers via (optional) parameters.
- Retrieve data such as text and coordinate.
- Marker specific FSM events when a marker is added, removed or changed.
- Additional FSM events when marker text or position is changed.
Author: funkyfranky
Global(s)
Global MARKER |
Just because... |
Just because...
The MARKER Class Idea
The MARKER class simplifies creating, updating and removing of markers on the F10 map.
Create a Marker
-- Create a MARKER object at Batumi with a trivial text.
local Coordinate = AIRBASE:FindByName( "Batumi" ):GetCoordinate()
mymarker = MARKER:New( Coordinate, "I am Batumi Airfield" )
Now this does not show the marker yet. We still need to specify to whom it is shown. There are several options, i.e. show the marker to everyone, to a specific coalition only, or only to a specific group.
For Everyone
If the marker should be visible to everyone, you can use the :ToAll() function.
mymarker = MARKER:New( Coordinate, "I am Batumi Airfield" ):ToAll()
For a Coalition
If the maker should be visible to a specific coalition, you can use the :ToCoalition() function.
mymarker = MARKER:New( Coordinate , "I am Batumi Airfield" ):ToCoalition( coalition.side.BLUE )
This would show the marker only to the Blue coalition.
For a Group
mymarker = MARKER:New( Coordinate , "Target Location" ):ToGroup( tankGroup )
Removing a Marker
mymarker:Remove(60)
This removes the marker after 60 seconds
Updating a Marker
The marker text and coordinate can be updated easily as shown below.
However, note that updating involves to remove and recreate the marker if either text or its coordinate is changed. This is a DCS scripting engine limitation.
Update Text
If you created a marker "mymarker" as shown above, you can update the displayed test by
mymarker:UpdateText( "I am the new text at Batumi" )
The update can also be delayed by, e.g. 90 seconds, using
mymarker:UpdateText( "I am the new text at Batumi", 90 )
Update Coordinate
If you created a marker "mymarker" as shown above, you can update its coordinate on the F10 map by
mymarker:UpdateCoordinate( NewCoordinate )
The update can also be delayed by, e.g. 60 seconds, using
mymarker:UpdateCoordinate( NewCoordinate , 60 )
Retrieve Data
The important data as the displayed text and the coordinate of the marker can be retrieved easily.
Text
local text =mymarker:GetText()
env.info( "Marker Text = " .. text )
Coordinate
local Coordinate = mymarker:GetCoordinate()
env.info( "Marker Coordinate LL DSM = " .. Coordinate:ToStringLLDMS() )
FSM Events
Moose creates additional events, so called FSM event, when markers are added, changed, removed, and text or the coordinate is updated.
These events can be captured and used for processing via OnAfter functions as shown below.
Added
Changed
Removed
TextUpdate
CoordUpdate
Examples
Global _MARKERID |
Marker ID. |
Type(s)
| Fields and Methods inherited from MARKER | Description |
|---|---|
|
Triggers the FSM event "Added". |
|
|
Triggers the FSM event "Changed". |
|
|
Name of the class. |
|
|
Triggers the FSM event "CoordUpdate". |
|
|
Debug mode. Messages to all about status. |
|
|
Get position of the marker. |
|
|
Get text that is displayed in the marker panel. |
|
|
Check if marker is currently invisible on the F10 map. |
|
|
Check if marker is currently visible on the F10 map. |
|
|
Set message that is displayed on screen if the marker is added. |
|
|
Create a new MARKER class object. |
|
|
On after "Added" event user function. |
|
|
On after "Changed" event user function. |
|
|
On after "CoordUpdate" event user function. |
|
|
On after "Removed" event user function. |
|
|
On after "TextUpdate" event user function. |
|
|
Event function when a MARKER is added. |
|
|
Event function when a MARKER changed. |
|
|
Event function when a MARKER is removed. |
|
|
Marker is readonly. |
|
|
Marker is read and write. |
|
|
Refresh the marker. |
|
|
Remove a marker. |
|
|
Triggers the FSM event "Removed". |
|
|
Set text that is displayed in the marker panel. |
|
|
Triggers the FSM event "TextUpdate". |
|
|
Place marker visible for everyone. |
|
|
Place marker visible for the blue coalition only. |
|
|
Place marker visible for a specific coalition only. |
|
|
Place marker visible for a specific group only. |
|
|
Place marker visible for the neutral coalition only. |
|
|
Place marker visible for the blue coalition only. |
|
|
Update the coordinate where the marker is displayed. |
|
|
Update the text displayed on the mark panel. |
|
|
Triggers the delayed FSM event "Added". |
|
|
Triggers the delayed FSM event "Changed". |
|
|
Triggers the delayed FSM event "CoordUpdate". |
|
|
Triggers the delayed FSM event "Removed". |
|
|
Triggers the delayed FSM event "TextUpdate". |
|
|
Coalition to which the marker is displayed. |
|
|
Coordinate of the mark. |
|
|
Class id string for output to DCS log file. |
|
|
Message displayed when the mark is added. |
|
|
Marker ID. |
|
|
On after "Added" event. |
|
|
On after "Changed" event. |
|
|
On after "CoordUpdate" event. |
|
|
On after "Removed" event. |
|
|
On after "TextUpdate" event. |
|
|
Marker is read-only. |
|
|
Text displayed in the mark panel. |
|
|
Marker class version. |
| Fields and Methods inherited from FSM | Description |
|---|---|
|
Adds an End state. |
|
|
Set the default #FSM_PROCESS template with key ProcessName providing the ProcessClass and the process object when it is assigned to a Wrapper.Controllable by the task. |
|
|
Adds a score for the FSM to be achieved. |
|
MARKER:AddScoreProcess(From, Event, State, ScoreText, Score) |
Adds a score for the FSM_PROCESS to be achieved. |
|
Add a new transition rule to the FSM. |
|
|
Get current state. |
|
|
Returns the End states. |
|
|
Returns a table of the SubFSM rules defined within the FSM. |
|
|
Returns a table with the scores defined. |
|
|
Returns the start state of the FSM. |
|
|
Get current state. |
|
|
Returns a table with the Subs defined. |
|
|
Returns a table of the transition rules defined within the FSM. |
|
|
Check if FSM is in state. |
|
|
Load call backs. |
|
|
Creates a new FSM object. |
|
|
Sets the start state of the FSM. |
|
|
Add to map. |
|
|
Call handler. |
|
|
Create transition. |
|
|
Delayed transition. |
|
|
Event map. |
|
|
Go sub. |
|
|
Handler. |
|
|
Is end state. |
|
|
Sub maps. |
|
|
Check if can do an event. |
|
|
Check if cannot do an event. |
|
|
Check if FSM is in state. |
|
Marker class.
Field(s)
Name of the class.
Debug mode. Messages to all about status.
Coalition to which the marker is displayed.
Class id string for output to DCS log file.
Message displayed when the mark is added.
Marker ID.
Marker is read-only.
Text displayed in the mark panel.
Marker class version.
Function(s)
Triggers the FSM event "Added".
Triggers the FSM event "Changed".
Triggers the FSM event "CoordUpdate".
Get position of the marker.
Get text that is displayed in the marker panel.
Defined in:
MARKER
Return value:
#string:
Marker text.
Check if marker is currently invisible on the F10 map.
Defined in:
MARKER
Return value:
Check if marker is currently visible on the F10 map.
Defined in:
MARKER
Return value:
#boolean:
True if the marker is currently visible.
Set message that is displayed on screen if the marker is added.
Defined in:
MARKER
Parameter:
#string Text
Message displayed when the marker is added.
Return value:
self
Create a new MARKER class object.
Defined in:
MARKER
Parameters:
Core.Point#COORDINATE Coordinate
Coordinate where to place the marker.
#string Text
Text displayed on the mark panel.
Return value:
self
On after "Added" event user function.
Defined in:
MARKER
Parameters:
#string From
From state.
#string Event
Event.
#string To
To state.
Core.Event#EVENTDATA EventData
Event data table.
On after "Changed" event user function.
Defined in:
MARKER
Parameters:
#string From
From state.
#string Event
Event.
#string To
To state.
Core.Event#EVENTDATA EventData
Event data table.
On after "CoordUpdate" event user function.
Defined in:
MARKER
Parameters:
#string From
From state.
#string Event
Event.
#string To
To state.
Core.Point#COORDINATE Coordinate
The updated Coordinate.
On after "Removed" event user function.
Defined in:
MARKER
Parameters:
#string From
From state.
#string Event
Event.
#string To
To state.
Core.Event#EVENTDATA EventData
Event data table.
On after "TextUpdate" event user function.
Defined in:
MARKER
Parameters:
#string From
From state.
#string Event
Event.
#string To
To state.
#string Text
The new text.
Event function when a MARKER is added.
Event function when a MARKER changed.
Event function when a MARKER is removed.
Marker is readonly.
Text cannot be changed and marker cannot be removed. The will not update the marker in the game, Call MARKER:Refresh to update state.
Marker is read and write.
Text cannot be changed and marker cannot be removed. The will not update the marker in the game, Call MARKER:Refresh to update state.
Refresh the marker.
Defined in:
MARKER
Parameter:
#number Delay
(Optional) Delay in seconds, before the marker is created.
Return value:
self
Remove a marker.
Defined in:
MARKER
Parameter:
#number Delay
(Optional) Delay in seconds, before the marker is removed.
Return value:
self
Triggers the FSM event "Removed".
Set text that is displayed in the marker panel.
Note this does not show the marker.
Defined in:
MARKER
Parameter:
#string Text
Marker text. Default is an empty string "".
Return value:
self
Triggers the FSM event "TextUpdate".
Defined in:
MARKER
Parameter:
#string Text
The new text.
Place marker visible for everyone.
Defined in:
MARKER
Parameter:
#number Delay
(Optional) Delay in seconds, before the marker is created.
Return value:
self
Place marker visible for the blue coalition only.
Defined in:
MARKER
Parameter:
#number Delay
(Optional) Delay in seconds, before the marker is created.
Return value:
self
Place marker visible for a specific coalition only.
Defined in:
MARKER
Parameters:
#number Coalition
Coalition 1=Red, 2=Blue, 0=Neutral. See coalition.side.RED.
#number Delay
(Optional) Delay in seconds, before the marker is created.
Return value:
self
Place marker visible for a specific group only.
Defined in:
MARKER
Parameters:
Wrapper.Group#GROUP Group
The group to which the marker is displayed.
#number Delay
(Optional) Delay in seconds, before the marker is created.
Return value:
self
Place marker visible for the neutral coalition only.
Defined in:
MARKER
Parameter:
#number Delay
(Optional) Delay in seconds, before the marker is created.
Return value:
self
Place marker visible for the blue coalition only.
Defined in:
MARKER
Parameter:
#number Delay
(Optional) Delay in seconds, before the marker is created.
Return value:
self
Update the coordinate where the marker is displayed.
Defined in:
MARKER
Parameters:
Core.Point#COORDINATE Coordinate
The new coordinate.
#number Delay
(Optional) Delay in seconds, before the marker is created.
Return value:
self
Update the text displayed on the mark panel.
Defined in:
MARKER
Parameters:
#string Text
Updated text.
#number Delay
(Optional) Delay in seconds, before the marker is created.
Return value:
self
Triggers the delayed FSM event "Added".
Triggers the delayed FSM event "Changed".
Triggers the delayed FSM event "CoordUpdate".
Triggers the delayed FSM event "Removed".
Triggers the delayed FSM event "TextUpdate".
Defined in:
MARKER
Parameter:
#string Text
The new text.
On after "Added" event.
Defined in:
MARKER
Parameters:
#string From
From state.
#string Event
Event.
#string To
To state.
Core.Event#EVENTDATA EventData
Event data table.
On after "Changed" event.
Defined in:
MARKER
Parameters:
#string From
From state.
#string Event
Event.
#string To
To state.
Core.Event#EVENTDATA EventData
Event data table.
On after "CoordUpdate" event.
Defined in:
MARKER
Parameters:
#string From
From state.
#string Event
Event.
#string To
To state.
Core.Point#COORDINATE Coordinate
The updated coordinates.
On after "Removed" event.
Defined in:
MARKER
Parameters:
#string From
From state.
#string Event
Event.
#string To
To state.
Core.Event#EVENTDATA EventData
Event data table.
On after "TextUpdate" event.
Defined in:
MARKER
Parameters:
#string From
From state.
#string Event
Event.
#string To
To state.
#string Text
The updated text, displayed in the mark panel.
Field(s)
Name of the class.
Debug mode. Messages to all about status.
Coalition to which the marker is displayed.
Class id string for output to DCS log file.
Message displayed when the mark is added.
Marker ID.
Marker is read-only.
Text displayed in the mark panel.
Marker class version.
Function(s)
Adds an End state.
Set the default #FSM_PROCESS template with key ProcessName providing the ProcessClass and the process object when it is assigned to a Wrapper.Controllable by the task.
Defined in:
Parameters:
#table From
Can contain a string indicating the From state or a table of strings containing multiple From states.
#string Event
The Event name.
Core.Fsm#FSM_PROCESS Process
An sub-process FSM.
#table ReturnEvents
A table indicating for which returned events of the SubFSM which Event must be triggered in the FSM.
Return value:
The SubFSM.
Adds a score for the FSM to be achieved.
Defined in:
Parameters:
#string State
is the state of the process when the score needs to be given. (See the relevant state descriptions of the process).
#string ScoreText
is a text describing the score that is given according the status.
#number Score
is a number providing the score of the status.
Return value:
#FSM:
self
Adds a score for the FSM_PROCESS to be achieved.
Defined in:
Parameters:
#string From
is the From State of the main process.
#string Event
is the Event of the main process.
#string State
is the state of the process when the score needs to be given. (See the relevant state descriptions of the process).
#string ScoreText
is a text describing the score that is given according the status.
#number Score
is a number providing the score of the status.
Return value:
#FSM:
self
Add a new transition rule to the FSM.
A transition rule defines when and if the FSM can transition from a state towards another state upon a triggered event.
Defined in:
Parameters:
#table From
Can contain a string indicating the From state or a table of strings containing multiple From states.
#string Event
The Event name.
#string To
The To state.
Get current state.
Returns the End states.
Returns a table of the SubFSM rules defined within the FSM.
Returns a table with the scores defined.
Returns the start state of the FSM.
Get current state.
Returns a table with the Subs defined.
Returns a table of the transition rules defined within the FSM.
Check if FSM is in state.
Defined in:
Parameter:
#string State
State name.
Return value:
#boolean:
If true, FSM is in this state.
Load call backs.
Sets the start state of the FSM.
Add to map.
Call handler.
Defined in:
Parameters:
#string step
Step "onafter", "onbefore", "onenter", "onleave".
#string trigger
Trigger.
#table params
Parameters.
#string EventName
Event name.
Return value:
Value.
Create transition.
Defined in:
Parameter:
#string EventName
Event name.
Return value:
#function:
Function.
Delayed transition.
Defined in:
Parameter:
#string EventName
Event name.
Return value:
#function:
Function.
Event map.
Go sub.
Defined in:
Parameters:
#string ParentFrom
Parent from state.
#string ParentEvent
Parent event name.
Return value:
#table:
Subs.
Handler.
Is end state.
Defined in:
Parameter:
#string Current
Current state name.
Return values:
#table:
FSM parent.
#string:
Event name.
Sub maps.
Check if can do an event.
Defined in:
Parameter:
#string e
Event name.
Return values:
#boolean:
If true, FSM can do the event.
#string:
To state.
Check if cannot do an event.
Defined in:
Parameter:
#string e
Event name.
Return value:
#boolean:
If true, FSM cannot do the event.
Check if FSM is in state.
Defined in:
Parameters:
#string State
State name.
state
Return value:
#boolean:
If true, FSM is in this state.