Arma Reforger Explorer 1.7.0.54
Arma Reforger Code Explorer by Zeroy - Thanks to MisterOutofTime
Loading...
Searching...
No Matches
SCR_MapMarkerBase Class Reference

Protected Member Functions

Widget GetRootWidget ()
SCR_EMapMarkerType GetType ()
void SetType (SCR_EMapMarkerType type)
int GetMarkerID ()
void SetMarkerID (int id)
int GetMarkerConfigID ()
void SetMarkerConfigID (int id)
int GetMarkerOwnerID ()
void SetMarkerOwnerID (int playerID)
int GetFlags ()
void SetFlags (int flags)
int GetMarkerFactionFlags ()
 Get faction flags representing indices of factions within FactionManager prefab.
void AddMarkerFactionFlags (int flags)
 Add faction index to flags which you can acquire by calling GetFactionIndex().
void SetMarkerFactionFlags (int flags)
 Set faction flags directly without converting the faction indices.
bool IsFaction (int factionID)
 Check whether the marker is one of the defined list of factions.
void GetWorldPos (out int pos[2])
void SetWorldPos (int posX, int posY)
int GetRotation ()
void SetRotation (int angle)
int GetColorEntry ()
int GetIconEntry ()
void SetColorEntry (int colorEntry)
void SetIconEntry (int iconEntry)
string GetCustomText ()
void SetCustomText (string text)
WorldTimestamp GetTimestamp ()
void SetTimestamp (WorldTimestamp timestamp)
void SetTimestampVisibility (bool isVisible)
bool IsTimestampVisible ()
void SetServerDisabled (bool state)
 Disable marker UI display on server -> for dedicated servers(no UI) or hosted server enemy faction.
void SetCanBeRemovedByOwner (bool state)
 Disable posibility to remove marker from map by owner.
bool CanBeRemovedByOwner ()
void SetUpdateDisabled (bool state)
 Disable marker update based on visibility on screen, overriden by m_bIsBlocked.
void SetBlocked (bool state)
 Sets if marker is blocked (this changes visibility).
bool GetBlocked ()
 Gets if marker is blocked (this changes visibility).
void SetVisible (bool state)
 Used for temporary reasons such as hiding original marker during edit, not for filtering visiblity.
void SetDragged (bool state)
 Set dragged state.
SCR_MapMarkerWidgetComponent GetMarkerComponent ()
bool TestVisibleFrame (vector visibleMin, vector visibleMax)
 Test whether the marker is visible on screen.
void RequestProfanityFilter ()
 Requests profanity filtering for the text of this marker.
void OnProfanityFilteredCallback (array< string > texts)
void OnCreateMarker (bool skipProfanityFilter=false)
void OnDelete ()
void OnMapClosed (MapConfiguration config)
void OnMapLayerChanged (int layerID)
void LayerChangeLogic (int layerID)
bool OnUpdate (vector visibleMin=vector.Zero, vector visibleMax=vector.Zero)
 Called from SCR_MapMarkerManagerComponent.

Static Protected Member Functions

static bool Extract (SCR_MapMarkerBase instance, ScriptCtx ctx, SSnapSerializerBase snapshot)
static bool Inject (SSnapSerializerBase snapshot, ScriptCtx ctx, SCR_MapMarkerBase instance)
static void Encode (SSnapSerializerBase snapshot, ScriptCtx ctx, ScriptBitSerializer packet)
static bool Decode (ScriptBitSerializer packet, ScriptCtx ctx, SSnapSerializerBase snapshot)
static bool SnapCompare (SSnapSerializerBase lhs, SSnapSerializerBase rhs, ScriptCtx ctx)
static bool PropCompare (SCR_MapMarkerBase instance, SSnapSerializerBase snapshot, ScriptCtx ctx)

Protected Attributes

const int SERIALIZED_BYTES = 34
SCR_EMapMarkerType m_eType
int m_iMarkerID = -1
int m_iConfigID = -1
int m_iMarkerOwnerID = -1
int m_iFlags
int m_iPosWorldX
int m_iPosWorldY
int m_iFactionFlags
int m_iColorEntry
int m_iIconEntry
int m_iRotation
string m_sCustomText
WorldTimestamp m_Timestamp
bool m_bIsTimestampVisible
bool m_bIsServerSideDisabled
bool m_bCanBeRemovedByOwner = true
bool m_bTestVisibleFrame = true
bool m_bIsUpdateDisabled
bool m_bIsDragged
bool m_bIsBlocked
int m_iScreenX
int m_iScreenY
SCR_MapMarkerEntryConfig m_ConfigEntry
SCR_MapEntity m_MapEntity
ref Widget m_wRoot
SCR_MapMarkerWidgetComponent m_MarkerWidgetComp
ref Color m_Color

Detailed Description

Map marker object base class Created through SCR_MapMarkerManagerComponent API

Definition at line 3 of file SCR_MapMarkerBase.c.

Member Function Documentation

◆ AddMarkerFactionFlags()

void SCR_MapMarkerBase::AddMarkerFactionFlags ( int flags)
inlineprotected

Add faction index to flags which you can acquire by calling GetFactionIndex().

Definition at line 115 of file SCR_MapMarkerBase.c.

◆ CanBeRemovedByOwner()

bool SCR_MapMarkerBase::CanBeRemovedByOwner ( )
inlineprotected

Definition at line 244 of file SCR_MapMarkerBase.c.

◆ Decode()

bool SCR_MapMarkerBase::Decode ( ScriptBitSerializer packet,
ScriptCtx ctx,
SSnapSerializerBase snapshot )
inlinestaticprotected

Definition at line 481 of file SCR_MapMarkerBase.c.

◆ Encode()

void SCR_MapMarkerBase::Encode ( SSnapSerializerBase snapshot,
ScriptCtx ctx,
ScriptBitSerializer packet )
inlinestaticprotected

Definition at line 472 of file SCR_MapMarkerBase.c.

◆ Extract()

bool SCR_MapMarkerBase::Extract ( SCR_MapMarkerBase instance,
ScriptCtx ctx,
SSnapSerializerBase snapshot )
inlinestaticprotected

Definition at line 432 of file SCR_MapMarkerBase.c.

◆ GetBlocked()

bool SCR_MapMarkerBase::GetBlocked ( )
inlineprotected

Gets if marker is blocked (this changes visibility).

Definition at line 271 of file SCR_MapMarkerBase.c.

◆ GetColorEntry()

int SCR_MapMarkerBase::GetColorEntry ( )
inlineprotected

Definition at line 168 of file SCR_MapMarkerBase.c.

◆ GetCustomText()

string SCR_MapMarkerBase::GetCustomText ( )
inlineprotected

Definition at line 192 of file SCR_MapMarkerBase.c.

◆ GetFlags()

int SCR_MapMarkerBase::GetFlags ( )
inlineprotected

Definition at line 95 of file SCR_MapMarkerBase.c.

◆ GetIconEntry()

int SCR_MapMarkerBase::GetIconEntry ( )
inlineprotected

Definition at line 174 of file SCR_MapMarkerBase.c.

◆ GetMarkerComponent()

SCR_MapMarkerWidgetComponent SCR_MapMarkerBase::GetMarkerComponent ( )
inlineprotected

Definition at line 292 of file SCR_MapMarkerBase.c.

◆ GetMarkerConfigID()

int SCR_MapMarkerBase::GetMarkerConfigID ( )
inlineprotected

Definition at line 71 of file SCR_MapMarkerBase.c.

◆ GetMarkerFactionFlags()

int SCR_MapMarkerBase::GetMarkerFactionFlags ( )
inlineprotected

Get faction flags representing indices of factions within FactionManager prefab.

Definition at line 108 of file SCR_MapMarkerBase.c.

◆ GetMarkerID()

int SCR_MapMarkerBase::GetMarkerID ( )
inlineprotected

Definition at line 59 of file SCR_MapMarkerBase.c.

◆ GetMarkerOwnerID()

int SCR_MapMarkerBase::GetMarkerOwnerID ( )
inlineprotected

Definition at line 83 of file SCR_MapMarkerBase.c.

◆ GetRootWidget()

Widget SCR_MapMarkerBase::GetRootWidget ( )
inlineprotected

Definition at line 41 of file SCR_MapMarkerBase.c.

◆ GetRotation()

int SCR_MapMarkerBase::GetRotation ( )
inlineprotected

Definition at line 156 of file SCR_MapMarkerBase.c.

◆ GetTimestamp()

WorldTimestamp SCR_MapMarkerBase::GetTimestamp ( )
inlineprotected
Returns
int timestamp when the marker was created

Definition at line 205 of file SCR_MapMarkerBase.c.

◆ GetType()

SCR_EMapMarkerType SCR_MapMarkerBase::GetType ( )
inlineprotected

Definition at line 47 of file SCR_MapMarkerBase.c.

◆ GetWorldPos()

void SCR_MapMarkerBase::GetWorldPos ( out int pos[2])
inlineprotected

Definition at line 142 of file SCR_MapMarkerBase.c.

◆ Inject()

bool SCR_MapMarkerBase::Inject ( SSnapSerializerBase snapshot,
ScriptCtx ctx,
SCR_MapMarkerBase instance )
inlinestaticprotected

Definition at line 452 of file SCR_MapMarkerBase.c.

◆ IsFaction()

bool SCR_MapMarkerBase::IsFaction ( int factionID)
inlineprotected

Check whether the marker is one of the defined list of factions.

Definition at line 134 of file SCR_MapMarkerBase.c.

◆ IsTimestampVisible()

bool SCR_MapMarkerBase::IsTimestampVisible ( )
inlineprotected

Definition at line 224 of file SCR_MapMarkerBase.c.

◆ LayerChangeLogic()

void SCR_MapMarkerBase::LayerChangeLogic ( int layerID)
inlineprotected

Definition at line 403 of file SCR_MapMarkerBase.c.

◆ OnCreateMarker()

void SCR_MapMarkerBase::OnCreateMarker ( bool skipProfanityFilter = false)
inlineprotected

Fetch marker definition from config & create widget

Parameters
[in]skipProfanityFilterdetermines whether the marker text should be checked for profanity

Definition at line 344 of file SCR_MapMarkerBase.c.

◆ OnDelete()

void SCR_MapMarkerBase::OnDelete ( )
inlineprotected

Definition at line 380 of file SCR_MapMarkerBase.c.

◆ OnMapClosed()

void SCR_MapMarkerBase::OnMapClosed ( MapConfiguration config)
inlineprotected

Definition at line 387 of file SCR_MapMarkerBase.c.

◆ OnMapLayerChanged()

void SCR_MapMarkerBase::OnMapLayerChanged ( int layerID)
inlineprotected

Definition at line 394 of file SCR_MapMarkerBase.c.

◆ OnProfanityFilteredCallback()

void SCR_MapMarkerBase::OnProfanityFilteredCallback ( array< string > texts)
inlineprotected

Definition at line 331 of file SCR_MapMarkerBase.c.

◆ OnUpdate()

bool SCR_MapMarkerBase::OnUpdate ( vector visibleMin = vector.Zero,
vector visibleMax = vector.Zero )
inlineprotected

Called from SCR_MapMarkerManagerComponent.

Definition at line 411 of file SCR_MapMarkerBase.c.

◆ PropCompare()

bool SCR_MapMarkerBase::PropCompare ( SCR_MapMarkerBase instance,
SSnapSerializerBase snapshot,
ScriptCtx ctx )
inlinestaticprotected

Definition at line 499 of file SCR_MapMarkerBase.c.

◆ RequestProfanityFilter()

void SCR_MapMarkerBase::RequestProfanityFilter ( )
inlineprotected

Requests profanity filtering for the text of this marker.

Definition at line 317 of file SCR_MapMarkerBase.c.

◆ SetBlocked()

void SCR_MapMarkerBase::SetBlocked ( bool state)
inlineprotected

Sets if marker is blocked (this changes visibility).

Definition at line 264 of file SCR_MapMarkerBase.c.

◆ SetCanBeRemovedByOwner()

void SCR_MapMarkerBase::SetCanBeRemovedByOwner ( bool state)
inlineprotected

Disable posibility to remove marker from map by owner.

Definition at line 238 of file SCR_MapMarkerBase.c.

◆ SetColorEntry()

void SCR_MapMarkerBase::SetColorEntry ( int colorEntry)
inlineprotected

Definition at line 180 of file SCR_MapMarkerBase.c.

◆ SetCustomText()

void SCR_MapMarkerBase::SetCustomText ( string text)
inlineprotected

Definition at line 198 of file SCR_MapMarkerBase.c.

◆ SetDragged()

void SCR_MapMarkerBase::SetDragged ( bool state)
inlineprotected

Set dragged state.

Definition at line 286 of file SCR_MapMarkerBase.c.

◆ SetFlags()

void SCR_MapMarkerBase::SetFlags ( int flags)
inlineprotected

Definition at line 101 of file SCR_MapMarkerBase.c.

◆ SetIconEntry()

void SCR_MapMarkerBase::SetIconEntry ( int iconEntry)
inlineprotected

Definition at line 186 of file SCR_MapMarkerBase.c.

◆ SetMarkerConfigID()

void SCR_MapMarkerBase::SetMarkerConfigID ( int id)
inlineprotected

Definition at line 77 of file SCR_MapMarkerBase.c.

◆ SetMarkerFactionFlags()

void SCR_MapMarkerBase::SetMarkerFactionFlags ( int flags)
inlineprotected

Set faction flags directly without converting the faction indices.

Definition at line 127 of file SCR_MapMarkerBase.c.

◆ SetMarkerID()

void SCR_MapMarkerBase::SetMarkerID ( int id)
inlineprotected

Definition at line 65 of file SCR_MapMarkerBase.c.

◆ SetMarkerOwnerID()

void SCR_MapMarkerBase::SetMarkerOwnerID ( int playerID)
inlineprotected

Definition at line 89 of file SCR_MapMarkerBase.c.

◆ SetRotation()

void SCR_MapMarkerBase::SetRotation ( int angle)
inlineprotected

Definition at line 162 of file SCR_MapMarkerBase.c.

◆ SetServerDisabled()

void SCR_MapMarkerBase::SetServerDisabled ( bool state)
inlineprotected

Disable marker UI display on server -> for dedicated servers(no UI) or hosted server enemy faction.

Definition at line 231 of file SCR_MapMarkerBase.c.

◆ SetTimestamp()

void SCR_MapMarkerBase::SetTimestamp ( WorldTimestamp timestamp)
inlineprotected
Parameters
[in]timestampwhen the marker was created

Definition at line 212 of file SCR_MapMarkerBase.c.

◆ SetTimestampVisibility()

void SCR_MapMarkerBase::SetTimestampVisibility ( bool isVisible)
inlineprotected

Definition at line 218 of file SCR_MapMarkerBase.c.

◆ SetType()

void SCR_MapMarkerBase::SetType ( SCR_EMapMarkerType type)
inlineprotected

Definition at line 53 of file SCR_MapMarkerBase.c.

◆ SetUpdateDisabled()

void SCR_MapMarkerBase::SetUpdateDisabled ( bool state)
inlineprotected

Disable marker update based on visibility on screen, overriden by m_bIsBlocked.

Definition at line 251 of file SCR_MapMarkerBase.c.

◆ SetVisible()

void SCR_MapMarkerBase::SetVisible ( bool state)
inlineprotected

Used for temporary reasons such as hiding original marker during edit, not for filtering visiblity.

Definition at line 278 of file SCR_MapMarkerBase.c.

◆ SetWorldPos()

void SCR_MapMarkerBase::SetWorldPos ( int posX,
int posY )
inlineprotected

Definition at line 149 of file SCR_MapMarkerBase.c.

◆ SnapCompare()

bool SCR_MapMarkerBase::SnapCompare ( SSnapSerializerBase lhs,
SSnapSerializerBase rhs,
ScriptCtx ctx )
inlinestaticprotected

Definition at line 491 of file SCR_MapMarkerBase.c.

◆ TestVisibleFrame()

bool SCR_MapMarkerBase::TestVisibleFrame ( vector visibleMin,
vector visibleMax )
inlineprotected

Test whether the marker is visible on screen.

Definition at line 299 of file SCR_MapMarkerBase.c.

Member Data Documentation

◆ m_bCanBeRemovedByOwner

bool SCR_MapMarkerBase::m_bCanBeRemovedByOwner = true
protected

Definition at line 25 of file SCR_MapMarkerBase.c.

◆ m_bIsBlocked

bool SCR_MapMarkerBase::m_bIsBlocked
protected

Definition at line 31 of file SCR_MapMarkerBase.c.

◆ m_bIsDragged

bool SCR_MapMarkerBase::m_bIsDragged
protected

Definition at line 30 of file SCR_MapMarkerBase.c.

◆ m_bIsServerSideDisabled

bool SCR_MapMarkerBase::m_bIsServerSideDisabled
protected

Definition at line 24 of file SCR_MapMarkerBase.c.

◆ m_bIsTimestampVisible

bool SCR_MapMarkerBase::m_bIsTimestampVisible
protected

Definition at line 21 of file SCR_MapMarkerBase.c.

◆ m_bIsUpdateDisabled

bool SCR_MapMarkerBase::m_bIsUpdateDisabled
protected

Definition at line 29 of file SCR_MapMarkerBase.c.

◆ m_bTestVisibleFrame

bool SCR_MapMarkerBase::m_bTestVisibleFrame = true
protected

Definition at line 28 of file SCR_MapMarkerBase.c.

◆ m_Color

ref Color SCR_MapMarkerBase::m_Color
protected

Definition at line 38 of file SCR_MapMarkerBase.c.

◆ m_ConfigEntry

SCR_MapMarkerEntryConfig SCR_MapMarkerBase::m_ConfigEntry
protected

Definition at line 34 of file SCR_MapMarkerBase.c.

◆ m_eType

SCR_EMapMarkerType SCR_MapMarkerBase::m_eType
protected

Definition at line 8 of file SCR_MapMarkerBase.c.

◆ m_iColorEntry

int SCR_MapMarkerBase::m_iColorEntry
protected

Definition at line 16 of file SCR_MapMarkerBase.c.

◆ m_iConfigID

int SCR_MapMarkerBase::m_iConfigID = -1
protected

Definition at line 10 of file SCR_MapMarkerBase.c.

◆ m_iFactionFlags

int SCR_MapMarkerBase::m_iFactionFlags
protected

Definition at line 15 of file SCR_MapMarkerBase.c.

◆ m_iFlags

int SCR_MapMarkerBase::m_iFlags
protected

Definition at line 12 of file SCR_MapMarkerBase.c.

◆ m_iIconEntry

int SCR_MapMarkerBase::m_iIconEntry
protected

Definition at line 17 of file SCR_MapMarkerBase.c.

◆ m_iMarkerID

int SCR_MapMarkerBase::m_iMarkerID = -1
protected

Definition at line 9 of file SCR_MapMarkerBase.c.

◆ m_iMarkerOwnerID

int SCR_MapMarkerBase::m_iMarkerOwnerID = -1
protected

Definition at line 11 of file SCR_MapMarkerBase.c.

◆ m_iPosWorldX

int SCR_MapMarkerBase::m_iPosWorldX
protected

Definition at line 13 of file SCR_MapMarkerBase.c.

◆ m_iPosWorldY

int SCR_MapMarkerBase::m_iPosWorldY
protected

Definition at line 14 of file SCR_MapMarkerBase.c.

◆ m_iRotation

int SCR_MapMarkerBase::m_iRotation
protected

Definition at line 18 of file SCR_MapMarkerBase.c.

◆ m_iScreenX

int SCR_MapMarkerBase::m_iScreenX
protected

Definition at line 32 of file SCR_MapMarkerBase.c.

◆ m_iScreenY

int SCR_MapMarkerBase::m_iScreenY
protected

Definition at line 33 of file SCR_MapMarkerBase.c.

◆ m_MapEntity

SCR_MapEntity SCR_MapMarkerBase::m_MapEntity
protected

Definition at line 35 of file SCR_MapMarkerBase.c.

◆ m_MarkerWidgetComp

SCR_MapMarkerWidgetComponent SCR_MapMarkerBase::m_MarkerWidgetComp
protected

Definition at line 37 of file SCR_MapMarkerBase.c.

◆ m_sCustomText

string SCR_MapMarkerBase::m_sCustomText
protected

Definition at line 19 of file SCR_MapMarkerBase.c.

◆ m_Timestamp

WorldTimestamp SCR_MapMarkerBase::m_Timestamp
protected

Definition at line 20 of file SCR_MapMarkerBase.c.

◆ m_wRoot

ref Widget SCR_MapMarkerBase::m_wRoot
protected

Definition at line 36 of file SCR_MapMarkerBase.c.

◆ SERIALIZED_BYTES

const int SCR_MapMarkerBase::SERIALIZED_BYTES = 34
protected

Definition at line 5 of file SCR_MapMarkerBase.c.

The documentation for this class was generated from the following file: