GameplayEffectWidgets_base Class Reference

grouped gameplay effect widgets and their handling More...

Protected Member Functions
void	GameplayEffectWidgets ()
void	~GameplayEffectWidgets ()
void	Init ()
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	InitLayouts ()
void	InitWidgetSets ()
void	RegisterLayouts (string path, array< int > types)
	Registers new layout and ties effect IDs to it.
	TranslateIDToType (int typeID)
override void	RegisterGameplayEffectData (int id, Param p)
void	InitWidgetSet (int type, bool updating=false, int user_id_override=-1)
	InitWidgetSet.
bool	CreateHandledClass (typename handled_type, array< ref Widget > input, int type, int user_override)
array< int >	CompileEffectListing ()
	returns all vanilla effects, nested in a vanilla layout. If using different layouts for custom effects, please register and link separately
void	UpdateVisibility ()
override void	AddActiveEffects (array< int > effects)
override void	RemoveActiveEffects (array< int > effects)
override void	StopAllEffects ()
override bool	IsAnyEffectRunning ()
override void	AddSuspendRequest (int request_id)
override void	RemoveSuspendRequest (int request_id)
override void	ClearSuspendRequests ()
override int	GetSuspendRequestCount ()
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.
void	CalculateValues (int type=-1, float timeSlice=0, Param p=null, int handle=-1)
	Only one calculation per unique WidgetSet.
void	ProcessWidgetUpdate (Widget w, int type, float timeSlice=0, Param p=null, int handle=-1)
void	CalculateBreathEffect (float timeSlice=0, int type=-1, Param p=null)
void	UpdateBreathEffect (ImageWidget w)
void	CalculateOccluderEffect (int type, float timeSlice, Param p, int handle)
void	UpdateOccluderEffect (ImageWidget w, int type, float timeSlice, Param p, int handle)
void	CalculateFlashbangEffect (int type, float timeSlice, Param p, int handle)
void	UpdateFlashbangEffect (ImageWidget w)
void	HandleWidgetRoot (float timeSlice=0, Param p=null, int handle=-1)
override void	Update (float timeSlice)
	Generic update, called on frame from the player.
override void	OnVoiceEvent (float breathing_resistance01)

Protected Attributes
ref Widget	m_Root
ref map< int, ref Widget >	m_Layouts
ref set< ref Widget >	m_UniqueLayouts
ref GameplayEffectDataMap	m_WidgetDataMap
ref set< int >	m_RunningEffects
ref set< int >	m_RunningEffectsPrevious
ref array< int >	m_UpdatingEffects
ref array< ref Widget >	m_UpdatedWidgetsCheck
ref array< int >	m_UpdatedWidgetSetsCheck
ref set< int >	m_SuspendRequests
ref map< int, typename >	m_IDToTypeMap
float	m_TimeProgBreath
float	m_BreathMultStamina
float	m_BreathResidue
const int	WIDGETSET_BREATH = 100
int	m_BreathColor
float	m_BreathAlphaVal
float	m_FlashbangCoverAlphaVal
const float	BREATH_HDR_MIN = 0.005
const float	BREATH_HDR_MAX = 1.0
const float	BREATH_COLOR_MULT_MIN = 0.5
const float	BREATH_COLOR_MULT_MAX = 0.8

Detailed Description

grouped gameplay effect widgets and their handling

Definition at line 6 of file gameplayeffectwidgets.c.

Constructor & Destructor Documentation

~GameplayEffectWidgets()

void GameplayEffectWidgets_base::~GameplayEffectWidgets ( )

protected

Definition at line 54 of file gameplayeffectwidgets.c.

Member Function Documentation

AddActiveEffects()

override void GameplayEffectWidgets_base::AddActiveEffects ( array< int > effects )

protected

Definition at line 300 of file gameplayeffectwidgets.c.

AddSuspendRequest()

override void GameplayEffectWidgets_base::AddSuspendRequest ( int request_id )

protected

Definition at line 371 of file gameplayeffectwidgets.c.

CalculateBreathEffect()

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

protected

Definition at line 557 of file gameplayeffectwidgets.c.

CalculateFlashbangEffect()

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

protected

Definition at line 595 of file gameplayeffectwidgets.c.

CalculateOccluderEffect()

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

protected

Definition at line 584 of file gameplayeffectwidgets.c.

CalculateValues()

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

protected

Only one calculation per unique WidgetSet.

Definition at line 470 of file gameplayeffectwidgets.c.

ClearSuspendRequests()

override void GameplayEffectWidgets_base::ClearSuspendRequests ( )

protected

Definition at line 387 of file gameplayeffectwidgets.c.

CompileEffectListing()

array< int > GameplayEffectWidgets_base::CompileEffectListing ( )

protected

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.

CreateHandledClass()

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

protected

Definition at line 201 of file gameplayeffectwidgets.c.

GameplayEffectWidgets()

void GameplayEffectWidgets_base::GameplayEffectWidgets ( )

protected

Definition at line 32 of file gameplayeffectwidgets.c.

GetSuspendRequestCount()

override int GameplayEffectWidgets_base::GetSuspendRequestCount ( )

protected

Definition at line 393 of file gameplayeffectwidgets.c.

HandleWidgetRoot()

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

protected

Definition at line 615 of file gameplayeffectwidgets.c.

Init()

void GameplayEffectWidgets_base::Init ( )

protected

Definition at line 66 of file gameplayeffectwidgets.c.

InitLayouts()

void GameplayEffectWidgets_base::InitLayouts ( )

protected

Definition at line 79 of file gameplayeffectwidgets.c.

InitWidgetSet()

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

protected

InitWidgetSet.

Parameters

type	int ID of effect widget type
updating	bool Marks widgets for 'PlayerBase.EOnFrame' updating
user_id_override	int UserID of a widget to be used instead (allows multiple types to use single widget) InitWidgetSet(EffectWidgetsTypes.MASK_BREATH,true,BREATH);

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.

InitWidgetSets()

void GameplayEffectWidgets_base::InitWidgetSets ( )

protected

Definition at line 85 of file gameplayeffectwidgets.c.

IsAnyEffectRunning()

override bool GameplayEffectWidgets_base::IsAnyEffectRunning ( )

protected

Definition at line 366 of file gameplayeffectwidgets.c.

OnVoiceEvent()

override void GameplayEffectWidgets_base::OnVoiceEvent ( float breathing_resistance01 )

protected

Definition at line 664 of file gameplayeffectwidgets.c.

PairIDToTypes()

void GameplayEffectWidgets_base::PairIDToTypes ( )

protected

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.

ProcessWidgetUpdate()

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

protected

Definition at line 512 of file gameplayeffectwidgets.c.

RegisterGameplayEffectData()

override void GameplayEffectWidgets_base::RegisterGameplayEffectData ( int id, Param p )

protected

Definition at line 126 of file gameplayeffectwidgets.c.

RegisterLayouts()

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

protected

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.

RemoveActiveEffects()

override void GameplayEffectWidgets_base::RemoveActiveEffects ( array< int > effects )

protected

Definition at line 320 of file gameplayeffectwidgets.c.

RemoveSuspendRequest()

override void GameplayEffectWidgets_base::RemoveSuspendRequest ( int request_id )

protected

Definition at line 377 of file gameplayeffectwidgets.c.

StopAllEffects()

override void GameplayEffectWidgets_base::StopAllEffects ( )

protected

Definition at line 346 of file gameplayeffectwidgets.c.

TranslateIDToType()

GameplayEffectWidgets_base::TranslateIDToType ( int typeID )

protected

Definition at line 121 of file gameplayeffectwidgets.c.

Update()

override void GameplayEffectWidgets_base::Update ( float timeSlice )

protected

Generic update, called on frame from the player.

Definition at line 634 of file gameplayeffectwidgets.c.

UpdateBreathEffect()

void GameplayEffectWidgets_base::UpdateBreathEffect ( ImageWidget w )

protected

Definition at line 575 of file gameplayeffectwidgets.c.

UpdateFlashbangEffect()

void GameplayEffectWidgets_base::UpdateFlashbangEffect ( ImageWidget w )

protected

Definition at line 607 of file gameplayeffectwidgets.c.

UpdateOccluderEffect()

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

protected

Definition at line 588 of file gameplayeffectwidgets.c.

UpdateVisibility()

void GameplayEffectWidgets_base::UpdateVisibility ( )

protected

Definition at line 232 of file gameplayeffectwidgets.c.

UpdateWidgets()

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

protected

Usually called in course of an OnFrame update, can be manually called from elsewhere with parameters.

Definition at line 399 of file gameplayeffectwidgets.c.

Member Data Documentation

BREATH_COLOR_MULT_MAX

const float GameplayEffectWidgets_base::BREATH_COLOR_MULT_MAX = 0.8

protected

Definition at line 552 of file gameplayeffectwidgets.c.

BREATH_COLOR_MULT_MIN

const float GameplayEffectWidgets_base::BREATH_COLOR_MULT_MIN = 0.5

protected

Definition at line 551 of file gameplayeffectwidgets.c.

BREATH_HDR_MAX

const float GameplayEffectWidgets_base::BREATH_HDR_MAX = 1.0

protected

Definition at line 550 of file gameplayeffectwidgets.c.

BREATH_HDR_MIN

const float GameplayEffectWidgets_base::BREATH_HDR_MIN = 0.005

protected

Definition at line 549 of file gameplayeffectwidgets.c.

m_BreathAlphaVal

float GameplayEffectWidgets_base::m_BreathAlphaVal

protected

Definition at line 29 of file gameplayeffectwidgets.c.

m_BreathColor

int GameplayEffectWidgets_base::m_BreathColor

protected

Definition at line 28 of file gameplayeffectwidgets.c.

m_BreathMultStamina

float GameplayEffectWidgets_base::m_BreathMultStamina

protected

Definition at line 21 of file gameplayeffectwidgets.c.

m_BreathResidue

float GameplayEffectWidgets_base::m_BreathResidue

protected

Definition at line 22 of file gameplayeffectwidgets.c.

m_FlashbangCoverAlphaVal

float GameplayEffectWidgets_base::m_FlashbangCoverAlphaVal

protected

Definition at line 30 of file gameplayeffectwidgets.c.

m_IDToTypeMap

ref map<int,typename> GameplayEffectWidgets_base::m_IDToTypeMap

protected

Definition at line 18 of file gameplayeffectwidgets.c.

m_Layouts

ref map<int,ref Widget> GameplayEffectWidgets_base::m_Layouts

protected

Definition at line 9 of file gameplayeffectwidgets.c.

m_Root

ref Widget GameplayEffectWidgets_base::m_Root

protected

Definition at line 8 of file gameplayeffectwidgets.c.

m_RunningEffects

ref set<int> GameplayEffectWidgets_base::m_RunningEffects

protected

Definition at line 12 of file gameplayeffectwidgets.c.

m_RunningEffectsPrevious

ref set<int> GameplayEffectWidgets_base::m_RunningEffectsPrevious

protected

Definition at line 13 of file gameplayeffectwidgets.c.

m_SuspendRequests

ref set<int> GameplayEffectWidgets_base::m_SuspendRequests

protected

Definition at line 17 of file gameplayeffectwidgets.c.

m_TimeProgBreath

float GameplayEffectWidgets_base::m_TimeProgBreath

protected

Definition at line 20 of file gameplayeffectwidgets.c.

m_UniqueLayouts

ref set<ref Widget> GameplayEffectWidgets_base::m_UniqueLayouts

protected

Definition at line 10 of file gameplayeffectwidgets.c.

m_UpdatedWidgetsCheck

ref array<ref Widget> GameplayEffectWidgets_base::m_UpdatedWidgetsCheck

protected

Definition at line 15 of file gameplayeffectwidgets.c.

m_UpdatedWidgetSetsCheck

ref array<int> GameplayEffectWidgets_base::m_UpdatedWidgetSetsCheck

protected

Definition at line 16 of file gameplayeffectwidgets.c.

m_UpdatingEffects

ref array<int> GameplayEffectWidgets_base::m_UpdatingEffects

protected

Definition at line 14 of file gameplayeffectwidgets.c.

m_WidgetDataMap

ref GameplayEffectDataMap GameplayEffectWidgets_base::m_WidgetDataMap

protected

Definition at line 11 of file gameplayeffectwidgets.c.

WIDGETSET_BREATH

const int GameplayEffectWidgets_base::WIDGETSET_BREATH = 100

protected

Definition at line 25 of file gameplayeffectwidgets.c.

---

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

• Daten/5_mission/mission/gameplayeffectwidgets/gameplayeffectwidgets.c