Arma Reforger Explorer 1.7.0.54
Arma Reforger Code Explorer by Zeroy - Thanks to MisterOutofTime
Loading...
Searching...
No Matches
SCR_MapMarkerManagerComponent.c File Reference

Go to the source code of this file.

Classes

class  SCR_MapMarkerManagerComponentClass

Functions

SCR_MapMarkerManagerComponentClass SCR_BaseGameModeComponentClass Attribute ("{720E8E61D7692172}Configs/Map/MapMarkerConfig.conf", UIWidgets.ResourceNamePicker)] protected ResourceName m_sMarkerCfgPath
SCR_MapMarkerConfig GetMarkerConfig ()
array< SCR_MapMarkerBase > GetStaticMarkers ()
array< SCR_MapMarkerBase > GetDisabledMarkers ()
array< SCR_MapMarkerEntity > GetDynamicMarkers ()
SCR_MapMarkerBase GetMarkerByWidget (Widget w)
SCR_MapMarkerBase GetStaticMarkerByID (int markerID)
SCR_MapMarkerBase GetDisabledMarkerByID (int markerID)
SCR_MapMarkerEntity GetDynamicMarkerByTarget (SCR_EMapMarkerType type, IEntity target)
void InsertStaticMarkerByType (SCR_EMapMarkerType type, int worldX, int worldY, bool isLocal, int configId=-1, int factionFlags=0, bool isServerMarker=false)
 SPAWN/REMOVE API.
void InsertStaticMarker (SCR_MapMarkerBase marker, bool isLocal, bool isServerMarker=false)
SCR_MapMarkerBase PrepareMilitaryMarker (EMilitarySymbolIdentity faction, EMilitarySymbolDimension dimension, EMilitarySymbolIcon typeFlags)
SCR_MapMarkerEntity InsertDynamicMarker (SCR_EMapMarkerType type, IEntity entity, int configId=-1)
void RemoveStaticMarker (SCR_MapMarkerBase marker)
void RemoveDynamicMarker (notnull SCR_MapMarkerEntity ent)
void AssignMarkerUID (SCR_MapMarkerBase marker)
void HandleStreamOut (SCR_MapMarkerEntity marker, PlayerController pController, bool state)
void SetMarkerStreamRules (notnull SCR_MapMarkerEntity marker)
void SetStreamRulesForPlayer (int playerID)
void EnableUpdate (bool state)
bool FindMarkerSyncComponent ()
void SetStaticMarkerDisabled (notnull SCR_MapMarkerBase marker, bool state)
void RegisterDynamicMarker (SCR_MapMarkerEntity markerEnt)
void UnregisterDynamicMarker (SCR_MapMarkerEntity markerEnt)
void ConnectToMarkerManagerSystem ()
void DisconnectFromMarkerManagerSystem ()
void Update (float timeSlice)
void OnAddSynchedMarker (SCR_MapMarkerBase marker)
void OnRemoveSynchedMarker (int markerID)
void OnAskAddStaticMarker (SCR_MapMarkerBase markerData)
void OnAskRemoveStaticMarker (int markerID)
void RPC_DoAddStaticMarker (SCR_MapMarkerBase markerData)
void RPC_DoRemoveStaticMarker (int markerID)
void OnPlayerFactionChanged_S (int playerID, SCR_PlayerFactionAffiliationComponent playerComponent, Faction faction)
void OnMapPanEnd (float x, float y)
void CheckMarkersUserRestrictions ()
void OnMapOpen (MapConfiguration mapConfig)
SocialComponent GetSocialComponent ()
SCR_ScriptProfanityFilterRequestCallback RequestProfanityFilter (string text)
SCR_ScriptProfanityFilterRequestCallback RequestProfanityFilter (notnull array< string > textsToFilter)
void OnFilteredCallback (array< string > texts)
override void OnPlayerDisconnected (int playerId, KickCauseCode cause, int timeout)
bool RplSave (ScriptBitWriter writer)
bool RplLoad (ScriptBitReader reader)
void RegisterLocalController (notnull PlayerController playerController)
void RemoveMarkersOfOtherFactions (int factionIndexOfPlayer, notnull inout array< ref SCR_MapMarkerBase > markers)
void OnPlayerFactionChanged (notnull FactionAffiliationComponent owner, Faction previousFaction, Faction newFaction)
void EOnInit (IEntity owner)
override void OnPostInit (IEntity owner)
 Editable Mine.
void ~SCR_MapMarkerManagerComponent ()

Variables

ref array< ref SCR_MapMarkerBase > m_aStaticMarkers = {}
ref array< ref SCR_MapMarkerBase > m_aDisabledMarkers = {}
ref array< SCR_MapMarkerEntity > m_aDynamicMarkers = {}
ref array< ref SCR_ScriptProfanityFilterRequestCallback > m_aProfanityCallbacks = {}
int m_iID
vector m_vVisibleFrameMin
vector m_vVisibleFrameMax
SCR_MapEntity m_MapEntity
SCR_MapMarkerSyncComponent m_MarkerSyncComp
ref SCR_MapMarkerConfig m_MarkerCfg

Function Documentation

◆ AssignMarkerUID()

void AssignMarkerUID ( SCR_MapMarkerBase marker)
protected

Definition at line 301 of file SCR_MapMarkerManagerComponent.c.

◆ Attribute()

SCR_MapMarkerManagerComponentClass SCR_BaseGameModeComponentClass Attribute ( "{720E8E61D7692172}Configs/Map/MapMarkerConfig.conf" ,
UIWidgets. ResourceNamePicker )

Map marker manager, keeps array of markers and takes care of synchronization Attached to GameMode entity

◆ CheckMarkersUserRestrictions()

void CheckMarkersUserRestrictions ( )
protected

Definition at line 631 of file SCR_MapMarkerManagerComponent.c.

◆ ConnectToMarkerManagerSystem()

void ConnectToMarkerManagerSystem ( )
protected

Definition at line 447 of file SCR_MapMarkerManagerComponent.c.

◆ DisconnectFromMarkerManagerSystem()

void DisconnectFromMarkerManagerSystem ( )
protected

Definition at line 458 of file SCR_MapMarkerManagerComponent.c.

◆ EnableUpdate()

void EnableUpdate ( bool state)
protected

Set manager to run UI updates for markers

Parameters
[in]state

Definition at line 375 of file SCR_MapMarkerManagerComponent.c.

◆ FindMarkerSyncComponent()

bool FindMarkerSyncComponent ( )
protected

Definition at line 384 of file SCR_MapMarkerManagerComponent.c.

◆ GetDisabledMarkerByID()

SCR_MapMarkerBase GetDisabledMarkerByID ( int markerID)
protected
Parameters
[in]markerID
Returns

Definition at line 110 of file SCR_MapMarkerManagerComponent.c.

◆ GetDisabledMarkers()

array< SCR_MapMarkerBase > GetDisabledMarkers ( )
protected
Returns

Definition at line 61 of file SCR_MapMarkerManagerComponent.c.

◆ GetDynamicMarkerByTarget()

SCR_MapMarkerEntity GetDynamicMarkerByTarget ( SCR_EMapMarkerType type,
IEntity target )
protected
Parameters
[in]type
[in]target
Returns

Definition at line 125 of file SCR_MapMarkerManagerComponent.c.

◆ GetDynamicMarkers()

array< SCR_MapMarkerEntity > GetDynamicMarkers ( )
protected
Returns

Definition at line 74 of file SCR_MapMarkerManagerComponent.c.

◆ GetMarkerByWidget()

SCR_MapMarkerBase GetMarkerByWidget ( Widget w)
protected
Parameters
[in]w
Returns

Definition at line 82 of file SCR_MapMarkerManagerComponent.c.

◆ GetMarkerConfig()

SCR_MapMarkerConfig GetMarkerConfig ( )
protected
Returns

Definition at line 41 of file SCR_MapMarkerManagerComponent.c.

◆ GetSocialComponent()

SocialComponent GetSocialComponent ( )
protected

Definition at line 666 of file SCR_MapMarkerManagerComponent.c.

◆ GetStaticMarkerByID()

SCR_MapMarkerBase GetStaticMarkerByID ( int markerID)
protected
Parameters
[in]markerID
Returns

Definition at line 96 of file SCR_MapMarkerManagerComponent.c.

◆ GetStaticMarkers()

array< SCR_MapMarkerBase > GetStaticMarkers ( )
protected
Returns

Definition at line 48 of file SCR_MapMarkerManagerComponent.c.

◆ HandleStreamOut()

void HandleStreamOut ( SCR_MapMarkerEntity marker,
PlayerController pController,
bool state )
protected

Enable stream out of specific marker for target identity

Parameters
[in]markeris the subject marker
[in]pControllerPlayerController is the subject player's controller
[in]statesets target state of stream out -> enabled if true, meaning that replication will stream out the subject

Definition at line 319 of file SCR_MapMarkerManagerComponent.c.

◆ InsertDynamicMarker()

SCR_MapMarkerEntity InsertDynamicMarker ( SCR_EMapMarkerType type,
IEntity entity,
int configId = -1 )
protected

Authority only

Parameters
[in]type
[in]entity
[in]configId
Returns

Definition at line 235 of file SCR_MapMarkerManagerComponent.c.

◆ InsertStaticMarker()

void InsertStaticMarker ( SCR_MapMarkerBase marker,
bool isLocal,
bool isServerMarker = false )
protected

Insert customized static marker

Parameters
[in]markeris the subject
[in]isLocaldetermines whether the marker is synchronised to other players or local
[in]isServerMarkerdetermines whether the marker is spawned by server and should not count towards marker limits (different from server-client spawning his own markers)

Definition at line 169 of file SCR_MapMarkerManagerComponent.c.

◆ InsertStaticMarkerByType()

void InsertStaticMarkerByType ( SCR_EMapMarkerType type,
int worldX,
int worldY,
bool isLocal,
int configId = -1,
int factionFlags = 0,
bool isServerMarker = false )
protected

SPAWN/REMOVE API.

Insert predefined type of static marker

Parameters
[in]typeis primary marker type
[in]worldXis x world poosition
[in]worldYis y world poosition
[in]isLocaldetermiens whether the marker will be created client side only or synchronized to other eligible players
[in]configIdis secondary marker ID used to select a predefined subtype
[in]factionFLagsdetermine which factions are able to see the marker, 0 for everyone

Definition at line 148 of file SCR_MapMarkerManagerComponent.c.

◆ OnAddSynchedMarker()

void OnAddSynchedMarker ( SCR_MapMarkerBase marker)
protected

RPC result of marker add broadcast Is an event and should NOT be called directly, it is only public since server needs to call it from SCR_MapMarkerSyncComponent

Parameters
[in]marker

Definition at line 518 of file SCR_MapMarkerManagerComponent.c.

◆ OnAskAddStaticMarker()

void OnAskAddStaticMarker ( SCR_MapMarkerBase markerData)
protected

Server side call from sync component for RPC marker add broadcast

Parameters
[in]markerData

Definition at line 580 of file SCR_MapMarkerManagerComponent.c.

◆ OnAskRemoveStaticMarker()

void OnAskRemoveStaticMarker ( int markerID)
protected

Server side call from sync component for RPC marker remove broadcast

Parameters
[in]markerID

Definition at line 588 of file SCR_MapMarkerManagerComponent.c.

◆ OnFilteredCallback()

void OnFilteredCallback ( array< string > texts)
protected

Definition at line 707 of file SCR_MapMarkerManagerComponent.c.

◆ OnMapOpen()

void OnMapOpen ( MapConfiguration mapConfig)
protected

Definition at line 651 of file SCR_MapMarkerManagerComponent.c.

◆ OnMapPanEnd()

void OnMapPanEnd ( float x,
float y )
protected

Definition at line 618 of file SCR_MapMarkerManagerComponent.c.

◆ OnPlayerDisconnected()

override void OnPlayerDisconnected ( int playerId,
KickCauseCode cause,
int timeout )
protected

Called after a player is disconnected.

Parameters
[in]playerIdPlayerId of disconnected player.
[in]causeReason player disconnected
[in]timeoutTimeout for when players are allowed to connect again. -1 means Ban without an assigned timeout

What happens when a player disconnects.

Parameters
[in]playerIDis a unique player identifier that defines which player has disconnected.
[in]cause
[in]timeout

Definition at line 740 of file SCR_MapMarkerManagerComponent.c.

◆ OnPlayerFactionChanged()

void OnPlayerFactionChanged ( notnull FactionAffiliationComponent owner,
Faction previousFaction,
Faction newFaction )
protected

Definition at line 905 of file SCR_MapMarkerManagerComponent.c.

◆ OnPlayerFactionChanged_S()

void OnPlayerFactionChanged_S ( int playerID,
SCR_PlayerFactionAffiliationComponent playerComponent,
Faction faction )
protected

Faction manager event -> server only

Parameters
[in]playerID
[in]playerComponent
[in]faction

Definition at line 612 of file SCR_MapMarkerManagerComponent.c.

◆ OnRemoveSynchedMarker()

void OnRemoveSynchedMarker ( int markerID)
protected

RPC result of marker remove broadcast Is an event and should NOT be called directly, it is only public since server needs to call it from SCR_MapMaprkerSyncComponent

Parameters
[in]markerID

Definition at line 558 of file SCR_MapMarkerManagerComponent.c.

◆ PrepareMilitaryMarker()

SCR_MapMarkerBase PrepareMilitaryMarker ( EMilitarySymbolIdentity faction,
EMilitarySymbolDimension dimension,
EMilitarySymbolIcon typeFlags )
protected

Prepare military marker based on existing configure attributes within marker config

Parameters
[in]faction
[in]dimension
[in]typeFlags
Returns
military marker with set symbol parameters for network synchronisation

Definition at line 206 of file SCR_MapMarkerManagerComponent.c.

◆ RegisterDynamicMarker()

void RegisterDynamicMarker ( SCR_MapMarkerEntity markerEnt)
protected

Registers the marker within manager, called by the marker entity

Parameters
[in]markerEnt

Definition at line 431 of file SCR_MapMarkerManagerComponent.c.

◆ RegisterLocalController()

void RegisterLocalController ( notnull PlayerController playerController)
protected

run on proxy only, adds listener to faction affiliation change of player controller when ready

Parameters
[in]playerController

Definition at line 880 of file SCR_MapMarkerManagerComponent.c.

◆ RemoveDynamicMarker()

void RemoveDynamicMarker ( notnull SCR_MapMarkerEntity ent)
protected

Authority only

Parameters
[in]ent

Definition at line 292 of file SCR_MapMarkerManagerComponent.c.

◆ RemoveMarkersOfOtherFactions()

void RemoveMarkersOfOtherFactions ( int factionIndexOfPlayer,
notnull inout array< ref SCR_MapMarkerBase > markers )
protected

Definition at line 889 of file SCR_MapMarkerManagerComponent.c.

◆ RemoveStaticMarker()

void RemoveStaticMarker ( SCR_MapMarkerBase marker)
protected

Remove a static marker

Parameters
[in]marker

Definition at line 259 of file SCR_MapMarkerManagerComponent.c.

◆ RequestProfanityFilter() [1/2]

SCR_ScriptProfanityFilterRequestCallback RequestProfanityFilter ( notnull array< string > textsToFilter)
protected

Profanity filter processing that is intended to do multiple strings at once

Parameters
[in]textsToFilter

Definition at line 691 of file SCR_MapMarkerManagerComponent.c.

◆ RequestProfanityFilter() [2/2]

SCR_ScriptProfanityFilterRequestCallback RequestProfanityFilter ( string text)
protected

Definition at line 680 of file SCR_MapMarkerManagerComponent.c.

◆ RPC_DoAddStaticMarker()

void RPC_DoAddStaticMarker ( SCR_MapMarkerBase markerData)
protected

Definition at line 595 of file SCR_MapMarkerManagerComponent.c.

◆ RPC_DoRemoveStaticMarker()

void RPC_DoRemoveStaticMarker ( int markerID)
protected

Definition at line 602 of file SCR_MapMarkerManagerComponent.c.

◆ RplLoad()

bool RplLoad ( ScriptBitReader reader)
protected

Definition at line 813 of file SCR_MapMarkerManagerComponent.c.

◆ RplSave()

bool RplSave ( ScriptBitWriter writer)
protected

Definition at line 752 of file SCR_MapMarkerManagerComponent.c.

◆ SetMarkerStreamRules()

void SetMarkerStreamRules ( notnull SCR_MapMarkerEntity marker)
protected

Network streaming rules for the marker Authority only -> Called when marker faction is assigned

Parameters
[in]marker

Definition at line 339 of file SCR_MapMarkerManagerComponent.c.

◆ SetStaticMarkerDisabled()

void SetStaticMarkerDisabled ( notnull SCR_MapMarkerBase marker,
bool state )
protected

Enable/disable static marker

Parameters
[in]marker
[in]state

Definition at line 401 of file SCR_MapMarkerManagerComponent.c.

◆ SetStreamRulesForPlayer()

void SetStreamRulesForPlayer ( int playerID)
protected

Network streaming rules of all markers of player Authority only -> Set when player is spawned

Parameters
[in]playerID

Definition at line 359 of file SCR_MapMarkerManagerComponent.c.

◆ UnregisterDynamicMarker()

void UnregisterDynamicMarker ( SCR_MapMarkerEntity markerEnt)
protected

Unregisters the marker within manager, called by the marker entity

Parameters
[in]markerEnt

Definition at line 440 of file SCR_MapMarkerManagerComponent.c.

◆ Update()

void Update ( float timeSlice)
protected
Parameters
[in]timeSlice

Definition at line 469 of file SCR_MapMarkerManagerComponent.c.

◆ ~SCR_MapMarkerManagerComponent()

void ~SCR_MapMarkerManagerComponent ( )
protected

Definition at line 961 of file SCR_MapMarkerManagerComponent.c.

Variable Documentation

◆ m_aDisabledMarkers

ref array<ref SCR_MapMarkerBase> m_aDisabledMarkers = {}
protected

Definition at line 16 of file SCR_MapMarkerManagerComponent.c.

◆ m_aDynamicMarkers

ref array<SCR_MapMarkerEntity> m_aDynamicMarkers = {}
protected

Definition at line 17 of file SCR_MapMarkerManagerComponent.c.

◆ m_aProfanityCallbacks

ref array<ref SCR_ScriptProfanityFilterRequestCallback> m_aProfanityCallbacks = {}
protected

Definition at line 19 of file SCR_MapMarkerManagerComponent.c.

◆ m_aStaticMarkers

ref array<ref SCR_MapMarkerBase> m_aStaticMarkers = {}
protected

Definition at line 15 of file SCR_MapMarkerManagerComponent.c.

◆ m_iID

int m_iID
protected

Definition at line 21 of file SCR_MapMarkerManagerComponent.c.

◆ m_MapEntity

SCR_MapEntity m_MapEntity
protected

Definition at line 24 of file SCR_MapMarkerManagerComponent.c.

◆ m_MarkerCfg

ref SCR_MapMarkerConfig m_MarkerCfg
protected

Definition at line 26 of file SCR_MapMarkerManagerComponent.c.

◆ m_MarkerSyncComp

SCR_MapMarkerSyncComponent m_MarkerSyncComp
protected

Definition at line 25 of file SCR_MapMarkerManagerComponent.c.

◆ m_vVisibleFrameMax

vector m_vVisibleFrameMax
protected

Definition at line 23 of file SCR_MapMarkerManagerComponent.c.

◆ m_vVisibleFrameMin

vector m_vVisibleFrameMin
protected

Definition at line 22 of file SCR_MapMarkerManagerComponent.c.