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

Protected Member Functions

void SetMeta (int id, SCR_NotificationDisplayData displayData)
int GetID ()
ENotificationReceiver GetNotificationReceiverType ()
float GetNotificationTimeLeft ()
bool UpdateNotificationData (float timeSlice)
string GetText ()
void SetNotificationTextEntries (string entry1=string.Empty, string entry2=string.Empty, string entry3=string.Empty, string entry4=string.Empty, string entry5=string.Empty, string entry6=string.Empty)
void GetNotificationTextEntries (out string entry1=string.Empty, out string entry2=string.Empty, out string entry3=string.Empty, out string entry4=string.Empty, out string entry5=string.Empty, out string entry6=string.Empty)
void SetFactionRelatedColor (ENotificationColor factionRelatedColor)
void SetFactionRelatedTextColor (ENotificationColor factionRelatedColor)
void SetSplitFactionRelatedColor (ENotificationColor factionRelatedColorLeft, ENotificationColor factionRelatedColorRight)
ENotificationColor GetFactionRelatedColor ()
ENotificationColor GetFactionRelatedTextColor ()
void GetSplitFactionRelatedColor (out ENotificationColor leftTextColor, out ENotificationColor rightTextColor)
SCR_NotificationDisplayData GetDisplayData ()
void GetPosition (out vector position)
void GetParams (out int param1, out int param2=0, out int param3=0, out int param4=0, out int param5=0, out int param6=0)
void Log ()
void SetPosition (vector position)
void SetParameters (ENotificationReceiver receiverType, int param1=0, int param2=0, int param3=0, int param4=0, int param5=0, int param6=0)

Static Protected Member Functions

static void Encode (SSnapSerializerBase snapshot, ScriptCtx hint, ScriptBitSerializer packet)
static bool Decode (ScriptBitSerializer packet, ScriptCtx hint, SSnapSerializerBase snapshot)
static bool SnapCompare (SSnapSerializerBase lhs, SSnapSerializerBase rhs, ScriptCtx hint)
static bool PropCompare (SCR_NotificationData prop, SSnapSerializerBase snapshot, ScriptCtx hint)
static bool Extract (SCR_NotificationData prop, ScriptCtx hint, SSnapSerializerBase snapshot)
static bool Inject (SSnapSerializerBase snapshot, ScriptCtx hint, SCR_NotificationData prop)

Protected Attributes

ENotification m_iID
float m_fNotificationTimeLeft = -1
int m_iPrevPositionUpdated = -1
string notificationEntry1
string notificationEntry2
string notificationEntry3
string notificationEntry4
string notificationEntry5
string notificationEntry6
bool m_bIsSplitNotification
ENotificationColor m_FactionRelatedColor = ENotificationColor.NEUTRAL
ENotificationColor m_FactionRelatedTextColor = ENotificationColor.NEUTRAL
ENotificationColor m_FactionRelatedTextLeftColor = ENotificationColor.NEUTRAL
ENotificationColor m_FactionRelatedTextRightColor = ENotificationColor.NEUTRAL
SCR_NotificationDisplayData m_DisplayData
int m_iParam1
int m_iParam2
int m_iParam3
int m_iParam4
int m_iParam5
int m_iParam6
vector m_vPosition = vector.Zero
ENotificationReceiver m_iNotificationReceiverType

Detailed Description

Saves data related to the notification system. Data saved: ENotification id, float m_fTime, notification string parameters, A link to SCR_NotificationDisplayData, m_FactionRelatedColor if applicable and ints to store data See specific SCR_NotificationDisplayData classes to know which parameters should be send

Definition at line 6 of file SCR_NotificationData.c.

Member Function Documentation

◆ Decode()

bool SCR_NotificationData::Decode ( ScriptBitSerializer packet,
ScriptCtx hint,
SSnapSerializerBase snapshot )
inlinestaticprotected

Definition at line 290 of file SCR_NotificationData.c.

◆ Encode()

void SCR_NotificationData::Encode ( SSnapSerializerBase snapshot,
ScriptCtx hint,
ScriptBitSerializer packet )
inlinestaticprotected

Definition at line 286 of file SCR_NotificationData.c.

◆ Extract()

bool SCR_NotificationData::Extract ( SCR_NotificationData prop,
ScriptCtx hint,
SSnapSerializerBase snapshot )
inlinestaticprotected

Definition at line 309 of file SCR_NotificationData.c.

◆ GetDisplayData()

SCR_NotificationDisplayData SCR_NotificationData::GetDisplayData ( )
inlineprotected

Get the specific linked SCR_NotificationDisplayData type to get display data and position

Returns
SCR_NotificationDisplayData DisplayData

Definition at line 244 of file SCR_NotificationData.c.

◆ GetFactionRelatedColor()

ENotificationColor SCR_NotificationData::GetFactionRelatedColor ( )
inlineprotected

Get the saved faction color. Used to set the color of notification that can have faction variant colors depending on the target of the notification. So friendly player died will have a diffrent color then enemy player died

Returns
m_factionColor

Definition at line 211 of file SCR_NotificationData.c.

◆ GetFactionRelatedTextColor()

ENotificationColor SCR_NotificationData::GetFactionRelatedTextColor ( )
inlineprotected

Get the saved faction text color. Used to set the color of notification that can have faction variant colors depending on the target of the notification. So friendly player died will have a diffrent color then enemy player died

Returns
faction related text color

Definition at line 222 of file SCR_NotificationData.c.

◆ GetID()

int SCR_NotificationData::GetID ( )
inlineprotected

Set notification ID

Returns
Notification ID

Definition at line 63 of file SCR_NotificationData.c.

◆ GetNotificationReceiverType()

ENotificationReceiver SCR_NotificationData::GetNotificationReceiverType ( )
inlineprotected

Get who recieves the notification and how, like local only, GM only, Local GM only

Returns
ENotificationReceiver which holds the notification receiver type

Definition at line 72 of file SCR_NotificationData.c.

◆ GetNotificationTextEntries()

void SCR_NotificationData::GetNotificationTextEntries ( out string entry1 = string.Empty,
out string entry2 = string.Empty,
out string entry3 = string.Empty,
out string entry4 = string.Empty,
out string entry5 = string.Empty,
out string entry6 = string.Empty )
inlineprotected

Set the notification entry texts

Parameters
outentry1
outentry2
outentry3
outentry4
outentry5
outentry6

Definition at line 160 of file SCR_NotificationData.c.

◆ GetNotificationTimeLeft()

float SCR_NotificationData::GetNotificationTimeLeft ( )
inlineprotected

Get how much time is left before notification data is deleted from SCR_NotificationsComponent array

Returns
Time in miliseconds

Definition at line 81 of file SCR_NotificationData.c.

◆ GetParams()

void SCR_NotificationData::GetParams ( out int param1,
out int param2 = 0,
out int param3 = 0,
out int param4 = 0,
out int param5 = 0,
out int param6 = 0 )
inlineprotected

Get parameters of the notification.

Parameters
[out]param1
[out]param2
[out]param3
[out]param4
[out]param5
[out]param5
[out]param6

Definition at line 268 of file SCR_NotificationData.c.

◆ GetPosition()

void SCR_NotificationData::GetPosition ( out vector position)
inlineprotected

Get position of the notification.

Parameters
[out]position

Definition at line 253 of file SCR_NotificationData.c.

◆ GetSplitFactionRelatedColor()

void SCR_NotificationData::GetSplitFactionRelatedColor ( out ENotificationColor leftTextColor,
out ENotificationColor rightTextColor )
inlineprotected

Get the saved faction text color. Used to set the color of notification that can have faction variant colors depending on the target of the notification. So friendly player died will have a diffrent color then enemy player died

Returns
faction related text color

Definition at line 234 of file SCR_NotificationData.c.

◆ GetText()

string SCR_NotificationData::GetText ( )
inlineprotected

Get the display text for the notification

Returns
string display text

Definition at line 113 of file SCR_NotificationData.c.

◆ Inject()

bool SCR_NotificationData::Inject ( SSnapSerializerBase snapshot,
ScriptCtx hint,
SCR_NotificationData prop )
inlinestaticprotected

Definition at line 321 of file SCR_NotificationData.c.

◆ Log()

void SCR_NotificationData::Log ( )
inlineprotected

Log information about the notification.

Definition at line 281 of file SCR_NotificationData.c.

◆ PropCompare()

bool SCR_NotificationData::PropCompare ( SCR_NotificationData prop,
SSnapSerializerBase snapshot,
ScriptCtx hint )
inlinestaticprotected

Definition at line 298 of file SCR_NotificationData.c.

◆ SetFactionRelatedColor()

void SCR_NotificationData::SetFactionRelatedColor ( ENotificationColor factionRelatedColor)
inlineprotected

Set the faction color. Faction color is used to set the color of notification that can have faction variant colors depending on the target of the notification. So friendly player died will have a diffrent color then enemy player died

Parameters
factionPositiveNegativeColorthe new faction color to set

Definition at line 176 of file SCR_NotificationData.c.

◆ SetFactionRelatedTextColor()

void SCR_NotificationData::SetFactionRelatedTextColor ( ENotificationColor factionRelatedColor)
inlineprotected

Set the faction color for text. Faction color is used to set the color of notification that can have faction variant colors depending on the target of the notification. So friendly player died will have a diffrent color then enemy player died

Parameters
factionPositiveNegativeColorthe new faction color to set for text

Definition at line 187 of file SCR_NotificationData.c.

◆ SetMeta()

void SCR_NotificationData::SetMeta ( int id,
SCR_NotificationDisplayData displayData )
inlineprotected

Set notification's meta data: Faction color and initial position data

Parameters
idNotification ID
notificationTextsaved text of notification
notificationTargettarget of notification for editor
locationtarget of notification for editor

Definition at line 37 of file SCR_NotificationData.c.

◆ SetNotificationTextEntries()

void SCR_NotificationData::SetNotificationTextEntries ( string entry1 = string.Empty,
string entry2 = string.Empty,
string entry3 = string.Empty,
string entry4 = string.Empty,
string entry5 = string.Empty,
string entry6 = string.Empty )
inlineprotected

Set the notification entry texts

Parameters
entry1
entry2
entry3
entry4
entry5
entry6

Definition at line 135 of file SCR_NotificationData.c.

◆ SetParameters()

void SCR_NotificationData::SetParameters ( ENotificationReceiver receiverType,
int param1 = 0,
int param2 = 0,
int param3 = 0,
int param4 = 0,
int param5 = 0,
int param6 = 0 )
inlineprotected

Sets the Parameters

Parameters
receiverType,ageneral type of who will will receive the notification such as: GM only, local only, etc
param1
param2
param3
param4
param5
param5
param6

Definition at line 354 of file SCR_NotificationData.c.

◆ SetPosition()

void SCR_NotificationData::SetPosition ( vector position)
inlineprotected

Set position of the notification.

Parameters
position

Definition at line 338 of file SCR_NotificationData.c.

◆ SetSplitFactionRelatedColor()

void SCR_NotificationData::SetSplitFactionRelatedColor ( ENotificationColor factionRelatedColorLeft,
ENotificationColor factionRelatedColorRight )
inlineprotected

Set the faction color for splitNotifications. Faction color is used to set the color of notification that can have faction variant colors depending on the targets (param1 and param2) of the notification. So friendly player died will have a diffrent color then enemy player died

Parameters
factionRelatedColorLeftthe new faction color to set for left text
factionRelatedColorRightthe new faction color to set for right text

Definition at line 199 of file SCR_NotificationData.c.

◆ SnapCompare()

bool SCR_NotificationData::SnapCompare ( SSnapSerializerBase lhs,
SSnapSerializerBase rhs,
ScriptCtx hint )
inlinestaticprotected

Definition at line 294 of file SCR_NotificationData.c.

◆ UpdateNotificationData()

bool SCR_NotificationData::UpdateNotificationData ( float timeSlice)
inlineprotected

Update the time left for the notification. It will be removed from the data in the Notification component once it reaches 0

Parameters
timeSliceamount removed from time left
Returns
returns true if the time left reaches 0 or less

Definition at line 91 of file SCR_NotificationData.c.

Member Data Documentation

◆ m_bIsSplitNotification

bool SCR_NotificationData::m_bIsSplitNotification
protected

Definition at line 13 of file SCR_NotificationData.c.

◆ m_DisplayData

SCR_NotificationDisplayData SCR_NotificationData::m_DisplayData
protected

Definition at line 18 of file SCR_NotificationData.c.

◆ m_FactionRelatedColor

ENotificationColor SCR_NotificationData::m_FactionRelatedColor = ENotificationColor.NEUTRAL
protected

Definition at line 14 of file SCR_NotificationData.c.

◆ m_FactionRelatedTextColor

ENotificationColor SCR_NotificationData::m_FactionRelatedTextColor = ENotificationColor.NEUTRAL
protected

Definition at line 15 of file SCR_NotificationData.c.

◆ m_FactionRelatedTextLeftColor

ENotificationColor SCR_NotificationData::m_FactionRelatedTextLeftColor = ENotificationColor.NEUTRAL
protected

Definition at line 16 of file SCR_NotificationData.c.

◆ m_FactionRelatedTextRightColor

ENotificationColor SCR_NotificationData::m_FactionRelatedTextRightColor = ENotificationColor.NEUTRAL
protected

Definition at line 17 of file SCR_NotificationData.c.

◆ m_fNotificationTimeLeft

float SCR_NotificationData::m_fNotificationTimeLeft = -1
protected

Definition at line 10 of file SCR_NotificationData.c.

◆ m_iID

ENotification SCR_NotificationData::m_iID
protected

Definition at line 9 of file SCR_NotificationData.c.

◆ m_iNotificationReceiverType

ENotificationReceiver SCR_NotificationData::m_iNotificationReceiverType
protected

Definition at line 28 of file SCR_NotificationData.c.

◆ m_iParam1

int SCR_NotificationData::m_iParam1
protected

Definition at line 21 of file SCR_NotificationData.c.

◆ m_iParam2

int SCR_NotificationData::m_iParam2
protected

Definition at line 22 of file SCR_NotificationData.c.

◆ m_iParam3

int SCR_NotificationData::m_iParam3
protected

Definition at line 23 of file SCR_NotificationData.c.

◆ m_iParam4

int SCR_NotificationData::m_iParam4
protected

Definition at line 24 of file SCR_NotificationData.c.

◆ m_iParam5

int SCR_NotificationData::m_iParam5
protected

Definition at line 25 of file SCR_NotificationData.c.

◆ m_iParam6

int SCR_NotificationData::m_iParam6
protected

Definition at line 26 of file SCR_NotificationData.c.

◆ m_iPrevPositionUpdated

int SCR_NotificationData::m_iPrevPositionUpdated = -1
protected

Definition at line 11 of file SCR_NotificationData.c.

◆ m_vPosition

vector SCR_NotificationData::m_vPosition = vector.Zero
protected

Definition at line 27 of file SCR_NotificationData.c.

◆ notificationEntry1

string SCR_NotificationData::notificationEntry1
protected

Definition at line 12 of file SCR_NotificationData.c.

◆ notificationEntry2

string SCR_NotificationData::notificationEntry2
protected

Definition at line 12 of file SCR_NotificationData.c.

◆ notificationEntry3

string SCR_NotificationData::notificationEntry3
protected

Definition at line 12 of file SCR_NotificationData.c.

◆ notificationEntry4

string SCR_NotificationData::notificationEntry4
protected

Definition at line 12 of file SCR_NotificationData.c.

◆ notificationEntry5

string SCR_NotificationData::notificationEntry5
protected

Definition at line 12 of file SCR_NotificationData.c.

◆ notificationEntry6

string SCR_NotificationData::notificationEntry6
protected

Definition at line 12 of file SCR_NotificationData.c.

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