FlightControl-Master/MOOSE
1
0
Fork 0
mirror of https://github.com/FlightControl-Master/MOOSE.git synced 2025-10-29 16:58:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

Changed documentation for Marker.lua and MarkerOps_Base.lua (#1891)

Browse Source
This commit is contained in:
grandpaSam
2023-01-28 00:02:15 -08:00
committed by GitHub
parent c20927b6d7
commit c0442fca68
2 changed files with 12 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
Moose Development/Moose/Core/MarkerOps_Base.lua
View File

@@ -5,6 +5,12 @@
-- * Create an easy way to tap into markers added to the F10 map by users. -- * Create an easy way to tap into markers added to the F10 map by users.
-- * Recognize own tag and list of keywords. -- * Recognize own tag and list of keywords.
-- * Matched keywords are handed down to functions. -- * Matched keywords are handed down to functions.
-- ##Listen for your tag
-- myMarker = MARKEROPS_BASE:New("tag", {}, false)
-- function myMarker:OnAfterMarkChanged(From, Event, To, Text, Keywords, Coord, idx)
--
-- end
-- Make sure to use the "MarkChanged" event as "MarkAdded" comes in right after the user places a blank marker and your callback will never be called.
-- --
-- === -- ===
-- --

14
Moose Development/Moose/Wrapper/Marker.lua
View File

@@ -58,18 +58,16 @@
-- If the maker should be visible to a specific coalition, you can use the :ToCoalition() function. -- 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 ) -- mymarker = MARKER:New( Coordinate , "I am Batumi Airfield" ):ToCoalition( coalition.side.BLUE )
-- --
-- ### To Blue Coalition
--
-- ### To Red Coalition
--
-- This would show the marker only to the Blue coalition. -- This would show the marker only to the Blue coalition.
-- --
-- ## For a Group -- ## For a Group
-- --
-- mymarker = MARKER:New( Coordinate , "Target Location" ):ToGroup( tankGroup )
-- --
-- # Removing a Marker -- # Removing a Marker
-- -- mymarker:Remove(60)
-- This removes the marker after 60 seconds
-- --
-- # Updating a Marker -- # Updating a Marker
-- --
@@ -305,7 +303,7 @@ end
-- User API Functions -- User API Functions
------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
--- Marker is readonly. Text cannot be changed and marker cannot be 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.
-- @param #MARKER self -- @param #MARKER self
-- @return #MARKER self -- @return #MARKER self
function MARKER:ReadOnly() function MARKER:ReadOnly()
@@ -315,7 +313,7 @@ function MARKER:ReadOnly()
return self return self
end end
--- Marker is readonly. Text cannot be changed and marker cannot be removed. --- 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.
-- @param #MARKER self -- @param #MARKER self
-- @return #MARKER self -- @return #MARKER self
function MARKER:ReadWrite() function MARKER:ReadWrite()