Dayz Build 1.29.163047, Scripts Rev. 123548
Dayz Code Explorer by Zeroy
Loading...
Searching...
No Matches
GameplayEffectWidgets_base Class Reference

grouped gameplay effect widgets and their handling More...

Protected Member Functions

void ~GameplayEffectWidgets ()
override void AddActiveEffects (array< int > effects)
override void AddSuspendRequest (int request_id)
void CalculateBreathEffect (float timeSlice=0, int type=-1, Param p=null)
void CalculateFlashbangEffect (int type, float timeSlice, Param p, int handle)
void CalculateOccluderEffect (int type, float timeSlice, Param p, int handle)
void CalculateValues (int type=-1, float timeSlice=0, Param p=null, int handle=-1)
 Only one calculation per unique WidgetSet.
override void ClearSuspendRequests ()
array< intCompileEffectListing ()
 returns all vanilla effects, nested in a vanilla layout. If using different layouts for custom effects, please register and link separately
bool CreateHandledClass (typename handled_type, array< ref Widget > input, int type, int user_override)
void GameplayEffectWidgets ()
override int GetSuspendRequestCount ()
void HandleWidgetRoot (float timeSlice=0, Param p=null, int handle=-1)
void Init ()
void InitLayouts ()
void InitWidgetSet (int type, bool updating=false, int user_id_override=-1)
 InitWidgetSet.
void InitWidgetSets ()
override bool IsAnyEffectRunning ()
override void OnVoiceEvent (float breathing_resistance01)
void PairIDToTypes ()
 Links types to unique handler types, if needed. Vanilla stuff was already handled in the generic update, left that as it was. (naming!).
void ProcessWidgetUpdate (Widget w, int type, float timeSlice=0, Param p=null, int handle=-1)
override void RegisterGameplayEffectData (int id, Param p)
void RegisterLayouts (string path, array< int > types)
 Registers new layout and ties effect IDs to it.
override void RemoveActiveEffects (array< int > effects)
override void RemoveSuspendRequest (int request_id)
override void StopAllEffects ()
 TranslateIDToType (int typeID)
override void Update (float timeSlice)
 Generic update, called on frame from the player.
void UpdateBreathEffect (ImageWidget w)
void UpdateFlashbangEffect (ImageWidget w)
void UpdateOccluderEffect (ImageWidget w, int type, float timeSlice, Param p, int handle)
void UpdateVisibility ()
override void UpdateWidgets (int type=-1, float timeSlice=0, Param p=null, int handle=-1)
 Usually called in course of an OnFrame update, can be manually called from elsewhere with parameters.

Protected Attributes

const float BREATH_COLOR_MULT_MAX = 0.8
const float BREATH_COLOR_MULT_MIN = 0.5
const float BREATH_HDR_MAX = 1.0
const float BREATH_HDR_MIN = 0.005
float m_BreathAlphaVal
int m_BreathColor
float m_BreathMultStamina
float m_BreathResidue
float m_FlashbangCoverAlphaVal
ref map< int, typenamem_IDToTypeMap
ref map< int, ref Widgetm_Layouts
ref Widget m_Root
ref set< intm_RunningEffects
ref set< intm_RunningEffectsPrevious
ref set< intm_SuspendRequests
float m_TimeProgBreath
ref set< ref Widgetm_UniqueLayouts
ref array< ref Widgetm_UpdatedWidgetsCheck
ref array< intm_UpdatedWidgetSetsCheck
ref array< intm_UpdatingEffects
ref GameplayEffectDataMap m_WidgetDataMap
const int WIDGETSET_BREATH = 100

Detailed Description

grouped gameplay effect widgets and their handling

Definition at line 6 of file gameplayeffectwidgets.c.

Constructor & Destructor Documentation

◆ ~GameplayEffectWidgets()

void ~GameplayEffectWidgets ( )
inlineprotected

Definition at line 54 of file gameplayeffectwidgets.c.

References m_Layouts.

Member Function Documentation

◆ AddActiveEffects()

override void AddActiveEffects ( array< int > effects)
inlineprotected

◆ AddSuspendRequest()

override void AddSuspendRequest ( int request_id)
inlineprotected

Definition at line 371 of file gameplayeffectwidgets.c.

References m_SuspendRequests, and UpdateVisibility().

◆ CalculateBreathEffect()

void CalculateBreathEffect ( float timeSlice = 0,
int type = -1,
Param p = null )
inlineprotected

◆ CalculateFlashbangEffect()

void CalculateFlashbangEffect ( int type,
float timeSlice,
Param p,
int handle )
inlineprotected

Definition at line 595 of file gameplayeffectwidgets.c.

References m_FlashbangCoverAlphaVal.

Referenced by CalculateValues().

◆ CalculateOccluderEffect()

void CalculateOccluderEffect ( int type,
float timeSlice,
Param p,
int handle )
inlineprotected

Definition at line 584 of file gameplayeffectwidgets.c.

Referenced by CalculateValues().

◆ CalculateValues()

void CalculateValues ( int type = -1,
float timeSlice = 0,
Param p = null,
int handle = -1 )
inlineprotected

Only one calculation per unique WidgetSet.

Definition at line 470 of file gameplayeffectwidgets.c.

References CalculateBreathEffect(), CalculateFlashbangEffect(), CalculateOccluderEffect(), m_UpdatedWidgetSetsCheck, and m_WidgetDataMap.

Referenced by UpdateWidgets().

◆ ClearSuspendRequests()

override void ClearSuspendRequests ( )
inlineprotected

Definition at line 387 of file gameplayeffectwidgets.c.

References m_SuspendRequests, and UpdateVisibility().

◆ CompileEffectListing()

array< int > CompileEffectListing ( )
inlineprotected

returns all vanilla effects, nested in a vanilla layout. If using different layouts for custom effects, please register and link separately

Definition at line 214 of file gameplayeffectwidgets.c.

Referenced by InitLayouts().

◆ CreateHandledClass()

bool CreateHandledClass ( typename handled_type ,
array< ref Widget > input,
int type,
int user_override )
inlineprotected

Definition at line 201 of file gameplayeffectwidgets.c.

References GameplayEffectsData::Init(), m_Layouts, and m_WidgetDataMap.

Referenced by InitWidgetSet().

◆ GameplayEffectWidgets()

◆ GetSuspendRequestCount()

override int GetSuspendRequestCount ( )
inlineprotected

Definition at line 393 of file gameplayeffectwidgets.c.

References m_SuspendRequests.

◆ HandleWidgetRoot()

void HandleWidgetRoot ( float timeSlice = 0,
Param p = null,
int handle = -1 )
inlineprotected

Definition at line 615 of file gameplayeffectwidgets.c.

References Math::Clamp(), and m_Root.

Referenced by UpdateWidgets().

◆ Init()

void Init ( )
inlineprotected

Definition at line 66 of file gameplayeffectwidgets.c.

References InitLayouts(), InitWidgetSets(), and PairIDToTypes().

Referenced by GameplayEffectWidgets().

◆ InitLayouts()

void InitLayouts ( )
inlineprotected

Definition at line 79 of file gameplayeffectwidgets.c.

References CompileEffectListing(), and RegisterLayouts().

Referenced by Init().

◆ InitWidgetSet()

void InitWidgetSet ( int type,
bool updating = false,
int user_id_override = -1 )
inlineprotected

InitWidgetSet.

Parameters
typeint ID of effect widget type
updatingbool Marks widgets for 'PlayerBase.EOnFrame' updating
user_id_overrideint UserID of a widget to be used instead (allows multiple types to use single widget)
InitWidgetSet(EffectWidgetsTypes.MASK_BREATH,true,BREATH);
void InitWidgetSet(int type, bool updating=false, int user_id_override=-1)
InitWidgetSet.
Note
All child widgets MUST be of the same type if special functionality is required (ImageWidget etc.)

Definition at line 144 of file gameplayeffectwidgets.c.

References CreateHandledClass(), GameplayEffectsDataImage(), m_Layouts, m_UpdatingEffects, m_WidgetDataMap, Print(), and TranslateIDToType().

Referenced by InitWidgetSets().

◆ InitWidgetSets()

void InitWidgetSets ( )
inlineprotected

Definition at line 85 of file gameplayeffectwidgets.c.

References InitWidgetSet(), and WIDGETSET_BREATH.

Referenced by Init().

◆ IsAnyEffectRunning()

override bool IsAnyEffectRunning ( )
inlineprotected

Definition at line 366 of file gameplayeffectwidgets.c.

References m_RunningEffects.

Referenced by StopAllEffects().

◆ OnVoiceEvent()

override void OnVoiceEvent ( float breathing_resistance01)
inlineprotected

Definition at line 664 of file gameplayeffectwidgets.c.

References Math::Clamp(), Math::Lerp(), and m_BreathResidue.

◆ PairIDToTypes()

void PairIDToTypes ( )
inlineprotected

Links types to unique handler types, if needed. Vanilla stuff was already handled in the generic update, left that as it was. (naming!).

Definition at line 74 of file gameplayeffectwidgets.c.

References m_IDToTypeMap.

Referenced by Init().

◆ ProcessWidgetUpdate()

void ProcessWidgetUpdate ( Widget w,
int type,
float timeSlice = 0,
Param p = null,
int handle = -1 )
inlineprotected

◆ RegisterGameplayEffectData()

override void RegisterGameplayEffectData ( int id,
Param p )
inlineprotected

◆ RegisterLayouts()

void RegisterLayouts ( string path,
array< int > types )
inlineprotected

Registers new layout and ties effect IDs to it.

Note
Order of layout creation matters, they get layered on top of each other. Within a single layout, widget priorities govern the widget order.

Definition at line 110 of file gameplayeffectwidgets.c.

References g_Game, m_Layouts, m_Root, m_UniqueLayouts, and path.

Referenced by InitLayouts().

◆ RemoveActiveEffects()

override void RemoveActiveEffects ( array< int > effects)
inlineprotected

◆ RemoveSuspendRequest()

override void RemoveSuspendRequest ( int request_id)
inlineprotected

Definition at line 377 of file gameplayeffectwidgets.c.

References m_SuspendRequests, and UpdateVisibility().

◆ StopAllEffects()

override void StopAllEffects ( )
inlineprotected

◆ TranslateIDToType()

TranslateIDToType ( int typeID)
inlineprotected

Definition at line 121 of file gameplayeffectwidgets.c.

References m_IDToTypeMap.

Referenced by InitWidgetSet().

◆ Update()

override void Update ( float timeSlice)
inlineprotected

Generic update, called on frame from the player.

Definition at line 634 of file gameplayeffectwidgets.c.

References m_SuspendRequests, and UpdateWidgets().

◆ UpdateBreathEffect()

void UpdateBreathEffect ( ImageWidget w)
inlineprotected

Definition at line 575 of file gameplayeffectwidgets.c.

References m_BreathAlphaVal, and m_BreathColor.

Referenced by ProcessWidgetUpdate().

◆ UpdateFlashbangEffect()

void UpdateFlashbangEffect ( ImageWidget w)
inlineprotected

Definition at line 607 of file gameplayeffectwidgets.c.

References m_FlashbangCoverAlphaVal.

Referenced by ProcessWidgetUpdate().

◆ UpdateOccluderEffect()

void UpdateOccluderEffect ( ImageWidget w,
int type,
float timeSlice,
Param p,
int handle )
inlineprotected

Definition at line 588 of file gameplayeffectwidgets.c.

Referenced by ProcessWidgetUpdate().

◆ UpdateVisibility()

◆ UpdateWidgets()

override void UpdateWidgets ( int type = -1,
float timeSlice = 0,
Param p = null,
int handle = -1 )
inlineprotected

Field Documentation

◆ BREATH_COLOR_MULT_MAX

const float BREATH_COLOR_MULT_MAX = 0.8
protected

Definition at line 552 of file gameplayeffectwidgets.c.

Referenced by CalculateBreathEffect().

◆ BREATH_COLOR_MULT_MIN

const float BREATH_COLOR_MULT_MIN = 0.5
protected

Definition at line 551 of file gameplayeffectwidgets.c.

Referenced by CalculateBreathEffect().

◆ BREATH_HDR_MAX

const float BREATH_HDR_MAX = 1.0
protected

Definition at line 550 of file gameplayeffectwidgets.c.

Referenced by CalculateBreathEffect().

◆ BREATH_HDR_MIN

const float BREATH_HDR_MIN = 0.005
protected

Definition at line 549 of file gameplayeffectwidgets.c.

Referenced by CalculateBreathEffect().

◆ m_BreathAlphaVal

float m_BreathAlphaVal
protected

Definition at line 29 of file gameplayeffectwidgets.c.

Referenced by CalculateBreathEffect(), and UpdateBreathEffect().

◆ m_BreathColor

int m_BreathColor
protected

Definition at line 28 of file gameplayeffectwidgets.c.

Referenced by CalculateBreathEffect(), and UpdateBreathEffect().

◆ m_BreathMultStamina

float m_BreathMultStamina
protected

Definition at line 21 of file gameplayeffectwidgets.c.

Referenced by GameplayEffectWidgets().

◆ m_BreathResidue

float m_BreathResidue
protected

Definition at line 22 of file gameplayeffectwidgets.c.

Referenced by CalculateBreathEffect(), and OnVoiceEvent().

◆ m_FlashbangCoverAlphaVal

float m_FlashbangCoverAlphaVal
protected

Definition at line 30 of file gameplayeffectwidgets.c.

Referenced by CalculateFlashbangEffect(), and UpdateFlashbangEffect().

◆ m_IDToTypeMap

ref map<int,typename> m_IDToTypeMap
protected

Definition at line 18 of file gameplayeffectwidgets.c.

Referenced by GameplayEffectWidgets(), PairIDToTypes(), and TranslateIDToType().

◆ m_Layouts

ref map<int,ref Widget> m_Layouts
protected

◆ m_Root

◆ m_RunningEffects

◆ m_RunningEffectsPrevious

ref set<int> m_RunningEffectsPrevious
protected

◆ m_SuspendRequests

◆ m_TimeProgBreath

float m_TimeProgBreath
protected

Definition at line 20 of file gameplayeffectwidgets.c.

Referenced by GameplayEffectWidgets().

◆ m_UniqueLayouts

ref set<ref Widget> m_UniqueLayouts
protected

Definition at line 10 of file gameplayeffectwidgets.c.

Referenced by GameplayEffectWidgets(), and RegisterLayouts().

◆ m_UpdatedWidgetsCheck

ref array<ref Widget> m_UpdatedWidgetsCheck
protected

Definition at line 15 of file gameplayeffectwidgets.c.

Referenced by GameplayEffectWidgets(), and UpdateWidgets().

◆ m_UpdatedWidgetSetsCheck

ref array<int> m_UpdatedWidgetSetsCheck
protected

Definition at line 16 of file gameplayeffectwidgets.c.

Referenced by CalculateValues(), GameplayEffectWidgets(), and UpdateWidgets().

◆ m_UpdatingEffects

ref array<int> m_UpdatingEffects
protected

Definition at line 14 of file gameplayeffectwidgets.c.

Referenced by GameplayEffectWidgets(), InitWidgetSet(), and UpdateWidgets().

◆ m_WidgetDataMap

◆ WIDGETSET_BREATH

const int WIDGETSET_BREATH = 100
protected

Definition at line 25 of file gameplayeffectwidgets.c.

Referenced by InitWidgetSets().


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