Map marker object base class Created through SCR_MapMarkerManagerComponent API.
More...
|
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) |
|
Map marker object base class Created through SCR_MapMarkerManagerComponent API.
◆ AddMarkerFactionFlags()
void SCR_MapMarkerBase.AddMarkerFactionFlags |
( |
int | flags | ) |
|
Add faction index to flags which you can acquire by calling GetFactionIndex()
◆ CanBeRemovedByOwner()
bool SCR_MapMarkerBase.CanBeRemovedByOwner |
( |
| ) |
|
◆ Decode()
static bool SCR_MapMarkerBase.Decode |
( |
ScriptBitSerializer | packet, |
|
|
ScriptCtx | ctx, |
|
|
SSnapSerializerBase | snapshot ) |
|
static |
◆ Encode()
static void SCR_MapMarkerBase.Encode |
( |
SSnapSerializerBase | snapshot, |
|
|
ScriptCtx | ctx, |
|
|
ScriptBitSerializer | packet ) |
|
static |
◆ Extract()
static bool SCR_MapMarkerBase.Extract |
( |
SCR_MapMarkerBase | instance, |
|
|
ScriptCtx | ctx, |
|
|
SSnapSerializerBase | snapshot ) |
|
static |
◆ GetColorEntry()
int SCR_MapMarkerBase.GetColorEntry |
( |
| ) |
|
◆ GetCustomText()
string SCR_MapMarkerBase.GetCustomText |
( |
| ) |
|
◆ GetFlags()
int SCR_MapMarkerBase.GetFlags |
( |
| ) |
|
◆ GetIconEntry()
int SCR_MapMarkerBase.GetIconEntry |
( |
| ) |
|
◆ GetMarkerComponent()
◆ GetMarkerConfigID()
int SCR_MapMarkerBase.GetMarkerConfigID |
( |
| ) |
|
◆ GetMarkerFactionFlags()
int SCR_MapMarkerBase.GetMarkerFactionFlags |
( |
| ) |
|
Get faction flags representing indices of factions within FactionManager prefab.
◆ GetMarkerID()
int SCR_MapMarkerBase.GetMarkerID |
( |
| ) |
|
◆ GetMarkerOwnerID()
int SCR_MapMarkerBase.GetMarkerOwnerID |
( |
| ) |
|
◆ GetRootWidget()
Widget SCR_MapMarkerBase.GetRootWidget |
( |
| ) |
|
◆ GetRotation()
int SCR_MapMarkerBase.GetRotation |
( |
| ) |
|
◆ GetType()
SCR_EMapMarkerType SCR_MapMarkerBase.GetType |
( |
| ) |
|
◆ GetWorldPos()
void SCR_MapMarkerBase.GetWorldPos |
( |
out int | pos[2] | ) |
|
◆ Inject()
static bool SCR_MapMarkerBase.Inject |
( |
SSnapSerializerBase | snapshot, |
|
|
ScriptCtx | ctx, |
|
|
SCR_MapMarkerBase | instance ) |
|
static |
◆ IsFaction()
bool SCR_MapMarkerBase.IsFaction |
( |
int | factionID | ) |
|
Check whether the marker is one of the defined list of factions.
◆ LayerChangeLogic()
void SCR_MapMarkerBase.LayerChangeLogic |
( |
int | layerID | ) |
|
◆ OnCreateMarker()
void SCR_MapMarkerBase.OnCreateMarker |
( |
bool | skipProfanityFilter = false | ) |
|
Fetch marker definition from config & create widget.
- Parameters
-
[in] | skipProfanityFilter | determines whether the marker text should be checked for profanity |
◆ OnDelete()
void SCR_MapMarkerBase.OnDelete |
( |
| ) |
|
◆ OnMapClosed()
◆ OnMapLayerChanged()
void SCR_MapMarkerBase.OnMapLayerChanged |
( |
int | layerID | ) |
|
|
protected |
◆ OnProfanityFilteredCallback()
void SCR_MapMarkerBase.OnProfanityFilteredCallback |
( |
array< string > | texts | ) |
|
|
protected |
◆ OnUpdate()
bool SCR_MapMarkerBase.OnUpdate |
( |
vector | visibleMin = vector::Zero, |
|
|
vector | visibleMax = vector::Zero ) |
◆ PropCompare()
static bool SCR_MapMarkerBase.PropCompare |
( |
SCR_MapMarkerBase | instance, |
|
|
SSnapSerializerBase | snapshot, |
|
|
ScriptCtx | ctx ) |
|
static |
◆ RequestProfanityFilter()
void SCR_MapMarkerBase.RequestProfanityFilter |
( |
| ) |
|
Requests profanity filtering for the text of this marker.
◆ SetBlocked()
void SCR_MapMarkerBase.SetBlocked |
( |
bool | state | ) |
|
Sets if marker is blocked (this changes visibility)
◆ SetCanBeRemovedByOwner()
void SCR_MapMarkerBase.SetCanBeRemovedByOwner |
( |
bool | state | ) |
|
Disable posibility to remove marker from map by owner.
◆ SetColorEntry()
void SCR_MapMarkerBase.SetColorEntry |
( |
int | colorEntry | ) |
|
◆ SetCustomText()
void SCR_MapMarkerBase.SetCustomText |
( |
string | text | ) |
|
◆ SetDragged()
void SCR_MapMarkerBase.SetDragged |
( |
bool | state | ) |
|
◆ SetFlags()
void SCR_MapMarkerBase.SetFlags |
( |
int | flags | ) |
|
◆ SetIconEntry()
void SCR_MapMarkerBase.SetIconEntry |
( |
int | iconEntry | ) |
|
◆ SetMarkerConfigID()
void SCR_MapMarkerBase.SetMarkerConfigID |
( |
int | id | ) |
|
◆ SetMarkerFactionFlags()
void SCR_MapMarkerBase.SetMarkerFactionFlags |
( |
int | flags | ) |
|
Set faction flags directly without converting the faction indices.
◆ SetMarkerID()
void SCR_MapMarkerBase.SetMarkerID |
( |
int | id | ) |
|
◆ SetMarkerOwnerID()
void SCR_MapMarkerBase.SetMarkerOwnerID |
( |
int | playerID | ) |
|
◆ SetRotation()
void SCR_MapMarkerBase.SetRotation |
( |
int | angle | ) |
|
◆ SetServerDisabled()
void SCR_MapMarkerBase.SetServerDisabled |
( |
bool | state | ) |
|
Disable marker UI display on server -> for dedicated servers(no UI) or hosted server enemy faction.
◆ SetType()
void SCR_MapMarkerBase.SetType |
( |
SCR_EMapMarkerType | type | ) |
|
◆ SetUpdateDisabled()
void SCR_MapMarkerBase.SetUpdateDisabled |
( |
bool | state | ) |
|
Disable marker update based on visibility on screen, overriden by m_bIsBlocked.
◆ SetVisible()
void SCR_MapMarkerBase.SetVisible |
( |
bool | state | ) |
|
Used for temporary reasons such as hiding original marker during edit, not for filtering visiblity.
◆ SetWorldPos()
void SCR_MapMarkerBase.SetWorldPos |
( |
int | posX, |
|
|
int | posY ) |
◆ SnapCompare()
static bool SCR_MapMarkerBase.SnapCompare |
( |
SSnapSerializerBase | lhs, |
|
|
SSnapSerializerBase | rhs, |
|
|
ScriptCtx | ctx ) |
|
static |
◆ TestVisibleFrame()
bool SCR_MapMarkerBase.TestVisibleFrame |
( |
vector | visibleMin, |
|
|
vector | visibleMax ) |
Test whether the marker is visible on screen.
◆ m_bCanBeRemovedByOwner
bool SCR_MapMarkerBase.m_bCanBeRemovedByOwner = true |
|
protected |
◆ m_bIsBlocked
bool SCR_MapMarkerBase.m_bIsBlocked |
|
protected |
◆ m_bIsDragged
bool SCR_MapMarkerBase.m_bIsDragged |
|
protected |
◆ m_bIsServerSideDisabled
bool SCR_MapMarkerBase.m_bIsServerSideDisabled |
|
protected |
◆ m_bIsUpdateDisabled
bool SCR_MapMarkerBase.m_bIsUpdateDisabled |
|
protected |
◆ m_bTestVisibleFrame
bool SCR_MapMarkerBase.m_bTestVisibleFrame = true |
|
protected |
◆ m_Color
ref Color SCR_MapMarkerBase.m_Color |
|
protected |
◆ m_ConfigEntry
◆ m_eType
SCR_EMapMarkerType SCR_MapMarkerBase.m_eType |
|
protected |
◆ m_iColorEntry
int SCR_MapMarkerBase.m_iColorEntry |
|
protected |
◆ m_iConfigID
int SCR_MapMarkerBase.m_iConfigID = -1 |
|
protected |
◆ m_iFactionFlags
int SCR_MapMarkerBase.m_iFactionFlags |
|
protected |
◆ m_iFlags
int SCR_MapMarkerBase.m_iFlags |
|
protected |
◆ m_iIconEntry
int SCR_MapMarkerBase.m_iIconEntry |
|
protected |
◆ m_iMarkerID
int SCR_MapMarkerBase.m_iMarkerID = -1 |
|
protected |
◆ m_iMarkerOwnerID
int SCR_MapMarkerBase.m_iMarkerOwnerID = -1 |
|
protected |
◆ m_iPosWorldX
int SCR_MapMarkerBase.m_iPosWorldX |
|
protected |
◆ m_iPosWorldY
int SCR_MapMarkerBase.m_iPosWorldY |
|
protected |
◆ m_iRotation
int SCR_MapMarkerBase.m_iRotation |
|
protected |
◆ m_iScreenX
int SCR_MapMarkerBase.m_iScreenX |
|
protected |
◆ m_iScreenY
int SCR_MapMarkerBase.m_iScreenY |
|
protected |
◆ m_MapEntity
◆ m_MarkerWidgetComp
◆ m_sCustomText
string SCR_MapMarkerBase.m_sCustomText |
|
protected |
◆ m_wRoot
ref Widget SCR_MapMarkerBase.m_wRoot |
|
protected |
◆ SERIALIZED_BYTES
const int SCR_MapMarkerBase.SERIALIZED_BYTES = 34 |
|
staticprotected |
The documentation for this interface was generated from the following file:
- Game/Map/Markers/Objects/SCR_MapMarkerBase.c