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

Protected Member Functions

void PPERequesterBase (int requester_IDX)
void ClearRequesterData ()
void DbgPrnt (string text)
map< int, ref map< int, ref PPERequestParamDataBase > > GetActiveRequestStructure ()
int GetCategoryMask ()
 mask for mass-handling methods like 'StopAllEffects'
PPERequestParamDataBase GetRequestData (int mat_id, int param_idx, int type)
 returns request data for specific parameter, or creates one if one does not exist in this request yet (singletons)
int GetRequesterIDX ()
 Returns requester index.
bool IsRequesterRunning ()
void OnStart (Param par=null)
void OnStop (Param par=null)
 automatically resets all material parameters of this requester to defaults
void OnUpdate (float delta)
PPERequestParamDataBase PrepareData (int mat_id, int param_idx, int type)
void QueueValuesSend ()
 Sets this requester to update in the manager.
float RelativizeValue (float value, int var_type, int mat_id, int param_id, bool relative)
 converts all values used to relative values (if not relative already)
void SendCurrentValueData (PPERequestParamDataBase data)
void SetDefaultValuesAll ()
 Sets all requested values to default, ignoring them in further calculations.
void SetRequesterIDX (int idx)
 automatically assigned by PPERequesterBank
void SetRequesterUpdating (bool state)
 Has to be set for the requester to be handled.
void SetTargetValueBool (int mat_id, int param_idx, bool val, int priority_layer, int operator=PPOperators.SET)
void SetTargetValueBoolDefault (int mat_id, int param_idx)
void SetTargetValueColor (int mat_id, int param_idx, array< float > val, int priority_layer, int operator=PPOperators.ADD_RELATIVE)
void SetTargetValueColorDefault (int mat_id, int param_idx)
void SetTargetValueFloat (int mat_id, int param_idx, bool relative, float val, int priority_layer, int operator=PPOperators.ADD_RELATIVE)
void SetTargetValueFloatDefault (int mat_id, int param_idx)
void SetTargetValueInt (int mat_id, int param_idx, bool relative, int val, int priority_layer, int operator=PPOperators.SET)
void SetTargetValueIntDefault (int mat_id, int param_idx)
void Start (Param par=null)
void Stop (Param par=null)

Protected Attributes

int m_IDX
bool m_IsRunning
ref map< int, ref map< int, ref PPERequestParamDataBase > > m_RequestDataStructure
bool m_Valid = false
bool m_ValuesSent

Private Member Functions

override int GetCategoryMask ()

Detailed Description

Definition at line 2 of file pperequestplatformsbase.c.

Constructor & Destructor Documentation

◆ PPERequesterBase()

void PPERequesterBase ( int requester_IDX)
inlineprotected

Definition at line 12 of file pperequestplatformsbase.c.

References m_IDX, m_IsRunning, m_RequestDataStructure, m_Valid, and m_ValuesSent.

Member Function Documentation

◆ ClearRequesterData()

void ClearRequesterData ( )
inlineprotected

Definition at line 324 of file pperequestplatformsbase.c.

References m_RequestDataStructure.

◆ DbgPrnt()

void DbgPrnt ( string text)
inlineprotected

Definition at line 424 of file pperequestplatformsbase.c.

◆ GetActiveRequestStructure()

map< int, ref map< int, ref PPERequestParamDataBase > > GetActiveRequestStructure ( )
inlineprotected

Definition at line 319 of file pperequestplatformsbase.c.

References m_RequestDataStructure.

Referenced by RemoveActiveRequestFromMaterials().

◆ GetCategoryMask() [1/2]

override int GetCategoryMask ( )
inlineprivate

Definition at line 444 of file pperequestplatformsbase.c.

◆ GetCategoryMask() [2/2]

int GetCategoryMask ( )
inlineprotected

mask for mass-handling methods like 'StopAllEffects'

Definition at line 71 of file pperequestplatformsbase.c.

◆ GetRequestData()

PPERequestParamDataBase GetRequestData ( int mat_id,
int param_idx,
int type )
inlineprotected

returns request data for specific parameter, or creates one if one does not exist in this request yet (singletons)

Definition at line 261 of file pperequestplatformsbase.c.

References Error(), m_RequestDataStructure, PPERequestParamDataBase::m_Requester, and PrepareData().

Referenced by SetTargetValueBool(), SetTargetValueBoolDefault(), SetTargetValueColor(), SetTargetValueColorDefault(), SetTargetValueFloat(), SetTargetValueFloatDefault(), SetTargetValueInt(), and SetTargetValueIntDefault().

◆ GetRequesterIDX()

int GetRequesterIDX ( )
inlineprotected

Returns requester index.

Definition at line 65 of file pperequestplatformsbase.c.

References m_IDX.

Referenced by RemoveActiveRequestFromMaterials().

◆ IsRequesterRunning()

bool IsRequesterRunning ( )
inlineprotected

Definition at line 53 of file pperequestplatformsbase.c.

References m_IsRunning.

Referenced by IsAnyRequesterRunning().

◆ OnStart()

void OnStart ( Param par = null)
inlineprotected

Definition at line 354 of file pperequestplatformsbase.c.

References SetRequesterUpdating().

Referenced by Start().

◆ OnStop()

void OnStop ( Param par = null)
inlineprotected

automatically resets all material parameters of this requester to defaults

Definition at line 360 of file pperequestplatformsbase.c.

References SetDefaultValuesAll(), and SetRequesterUpdating().

◆ OnUpdate()

void OnUpdate ( float delta)
inlineprotected

Definition at line 336 of file pperequestplatformsbase.c.

References Count, m_RequestDataStructure, m_ValuesSent, SendCurrentValueData(), and SetRequesterUpdating().

Referenced by ProcessRequesterUpdates().

◆ PrepareData()

PPERequestParamDataBase PrepareData ( int mat_id,
int param_idx,
int type )
inlineprotected

Definition at line 294 of file pperequestplatformsbase.c.

References m_IDX, PPERequestParamDataBool(), and PPERequestParamDataFloat().

Referenced by GetRequestData().

◆ QueueValuesSend()

void QueueValuesSend ( )
inlineprotected

Sets this requester to update in the manager.

Definition at line 253 of file pperequestplatformsbase.c.

References m_ValuesSent, and SetRequesterUpdating().

Referenced by SetTargetValueBool(), SetTargetValueBoolDefault(), SetTargetValueColor(), SetTargetValueColorDefault(), SetTargetValueFloat(), SetTargetValueFloatDefault(), SetTargetValueInt(), and SetTargetValueIntDefault().

◆ RelativizeValue()

float RelativizeValue ( float value,
int var_type,
int mat_id,
int param_id,
bool relative )
inlineprotected

converts all values used to relative values (if not relative already)

Definition at line 368 of file pperequestplatformsbase.c.

References Math::Clamp(), PPEManagerStatic::GetPPEManager(), and Math::InverseLerp().

Referenced by SetTargetValueFloat().

◆ SendCurrentValueData()

void SendCurrentValueData ( PPERequestParamDataBase data)
inlineprotected

Definition at line 329 of file pperequestplatformsbase.c.

References PPEManagerStatic::GetPPEManager().

Referenced by OnUpdate().

◆ SetDefaultValuesAll()

void SetDefaultValuesAll ( )
inlineprotected

Sets all requested values to default, ignoring them in further calculations.

Definition at line 388 of file pperequestplatformsbase.c.

References Count, PPERequestParamDataBase::GetMaterialID(), PPERequestParamDataBase::GetParameterID(), PPERequestParamDataBase::GetVarType(), PPERequestParamDataBase::IsDataActive(), m_RequestDataStructure, SetTargetValueBoolDefault(), SetTargetValueColorDefault(), SetTargetValueFloatDefault(), and SetTargetValueIntDefault().

Referenced by OnStop().

◆ SetRequesterIDX()

void SetRequesterIDX ( int idx)
inlineprotected

automatically assigned by PPERequesterBank

Definition at line 59 of file pperequestplatformsbase.c.

References m_IDX.

Referenced by Managed::RegisterRequester().

◆ SetRequesterUpdating()

void SetRequesterUpdating ( bool state)
inlineprotected

Has to be set for the requester to be handled.

Definition at line 23 of file pperequestplatformsbase.c.

References PPEManagerStatic::GetPPEManager(), Debug::Log(), and m_Valid.

Referenced by OnStart(), OnStop(), OnUpdate(), and QueueValuesSend().

◆ SetTargetValueBool()

void SetTargetValueBool ( int mat_id,
int param_idx,
bool val,
int priority_layer,
int operator = PPOperators.SET )
inlineprotected

Definition at line 78 of file pperequestplatformsbase.c.

References GetRequestData(), m_RequestDataStructure, PPERequestParamDataBool(), and QueueValuesSend().

◆ SetTargetValueBoolDefault()

void SetTargetValueBoolDefault ( int mat_id,
int param_idx )
inlineprotected

Definition at line 100 of file pperequestplatformsbase.c.

References GetRequestData(), m_RequestDataStructure, PPERequestParamDataBool(), and QueueValuesSend().

Referenced by SetDefaultValuesAll().

◆ SetTargetValueColor()

void SetTargetValueColor ( int mat_id,
int param_idx,
array< float > val,
int priority_layer,
int operator = PPOperators.ADD_RELATIVE )
inlineprotected

Definition at line 197 of file pperequestplatformsbase.c.

References GetRequestData(), m_RequestDataStructure, and QueueValuesSend().

◆ SetTargetValueColorDefault()

void SetTargetValueColorDefault ( int mat_id,
int param_idx )
inlineprotected

Definition at line 221 of file pperequestplatformsbase.c.

References GetRequestData(), m_RequestDataStructure, and QueueValuesSend().

Referenced by SetDefaultValuesAll().

◆ SetTargetValueFloat()

void SetTargetValueFloat ( int mat_id,
int param_idx,
bool relative,
float val,
int priority_layer,
int operator = PPOperators.ADD_RELATIVE )
inlineprotected

Definition at line 155 of file pperequestplatformsbase.c.

References GetRequestData(), m_RequestDataStructure, PPERequestParamDataFloat(), QueueValuesSend(), and RelativizeValue().

◆ SetTargetValueFloatDefault()

void SetTargetValueFloatDefault ( int mat_id,
int param_idx )
inlineprotected

Definition at line 178 of file pperequestplatformsbase.c.

References GetRequestData(), m_RequestDataStructure, PPERequestParamDataFloat(), and QueueValuesSend().

Referenced by SetDefaultValuesAll().

◆ SetTargetValueInt()

void SetTargetValueInt ( int mat_id,
int param_idx,
bool relative,
int val,
int priority_layer,
int operator = PPOperators.SET )
inlineprotected

Definition at line 117 of file pperequestplatformsbase.c.

References GetRequestData(), m_RequestDataStructure, and QueueValuesSend().

◆ SetTargetValueIntDefault()

void SetTargetValueIntDefault ( int mat_id,
int param_idx )
inlineprotected

Definition at line 138 of file pperequestplatformsbase.c.

References GetRequestData(), m_RequestDataStructure, and QueueValuesSend().

Referenced by SetDefaultValuesAll().

◆ Start()

void Start ( Param par = null)
inlineprotected

Definition at line 38 of file pperequestplatformsbase.c.

References m_IsRunning, and OnStart().

Referenced by HeadGear_Base::HandleAttachedToHead(), and ManBase::SetContaminatedEffectEx().

◆ Stop()

void Stop ( Param par = null)
inlineprotected

Definition at line 44 of file pperequestplatformsbase.c.

References m_IsRunning, m_RequestDataStructure, and OnStop().

Field Documentation

◆ m_IDX

int m_IDX
protected

Definition at line 6 of file pperequestplatformsbase.c.

Referenced by PPERequesterBase(), GetRequesterIDX(), PrepareData(), and SetRequesterIDX().

◆ m_IsRunning

bool m_IsRunning
protected

Definition at line 4 of file pperequestplatformsbase.c.

Referenced by PPERequesterBase(), IsRequesterRunning(), Start(), and Stop().

◆ m_RequestDataStructure

ref map<int,ref map<int,ref PPERequestParamDataBase> > m_RequestDataStructure
protected

Definition at line 10 of file pperequestplatformsbase.c.

Referenced by PPERequesterBase(), ClearRequesterData(), GetActiveRequestStructure(), GetRequestData(), OnUpdate(), SetDefaultValuesAll(), SetTargetValueBool(), SetTargetValueBoolDefault(), SetTargetValueColor(), SetTargetValueColorDefault(), SetTargetValueFloat(), SetTargetValueFloatDefault(), SetTargetValueInt(), SetTargetValueIntDefault(), and Stop().

◆ m_Valid

bool m_Valid = false
protected

Definition at line 8 of file pperequestplatformsbase.c.

Referenced by PPERequesterBase(), and SetRequesterUpdating().

◆ m_ValuesSent

bool m_ValuesSent
protected

Definition at line 5 of file pperequestplatformsbase.c.

Referenced by PPERequesterBase(), OnUpdate(), and QueueValuesSend().

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