PC Stable Documentation
 
All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Loading...
Searching...
No Matches
PPERequesterBase Class Reference

Private Member Functions

void PPERequesterBase (int requester_IDX)
 
void SetRequesterUpdating (bool state)
 Has to be set for the requester to be handled.
 
void Start (Param par=null)
 
void Stop (Param par=null)
 
bool IsRequesterRunning ()
 
void SetRequesterIDX (int idx)
 automatically assigned by PPERequesterBank
 
int GetRequesterIDX ()
 Returns requester index.
 
int GetCategoryMask ()
 mask for mass-handling methods like 'StopAllEffects'
 
protected void SetTargetValueBool (int mat_id, int param_idx, bool val, int priority_layer, int operator=PPOperators.SET)
 
protected void SetTargetValueBoolDefault (int mat_id, int param_idx)
 
protected void SetTargetValueInt (int mat_id, int param_idx, bool relative, int val, int priority_layer, int operator=PPOperators.SET)
 
protected void SetTargetValueIntDefault (int mat_id, int param_idx)
 
protected void SetTargetValueFloat (int mat_id, int param_idx, bool relative, float val, int priority_layer, int operator=PPOperators.ADD_RELATIVE)
 
protected void SetTargetValueFloatDefault (int mat_id, int param_idx)
 
protected void SetTargetValueColor (int mat_id, int param_idx, array< float > val, int priority_layer, int operator=PPOperators.ADD_RELATIVE)
 
protected void SetTargetValueColorDefault (int mat_id, int param_idx)
 
protected void QueueValuesSend ()
 Sets this requester to update in the manager.
 
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)
 
protected PPERequestParamDataBase PrepareData (int mat_id, int param_idx, int type)
 
map< int, ref map< int, ref PPERequestParamDataBase > > GetActiveRequestStructure ()
 
protected void ClearRequesterData ()
 
protected void SendCurrentValueData (PPERequestParamDataBase data)
 
void OnUpdate (float delta)
 
protected void OnStart (Param par=null)
 
protected void OnStop (Param par=null)
 automatically resets all material parameters of this requester to defaults
 
protected 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)
 
protected void SetDefaultValuesAll ()
 Sets all requested values to default, ignoring them in further calculations.
 
void DbgPrnt (string text)
 
override int GetCategoryMask ()
 

Private Attributes

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

Constructor & Destructor Documentation

◆ PPERequesterBase()

void PPERequesterBase ( int  requester_IDX)
inlineprivate

Member Function Documentation

◆ ClearRequesterData()

protected void ClearRequesterData ( )
inlineprivate

◆ DbgPrnt()

void DbgPrnt ( string  text)
inlineprivate

◆ GetActiveRequestStructure()

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

◆ GetCategoryMask() [1/2]

int GetCategoryMask ( )
inlineprivate

mask for mass-handling methods like 'StopAllEffects'

◆ GetCategoryMask() [2/2]

override int GetCategoryMask ( )
inlineprivate

◆ GetRequestData()

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

◆ GetRequesterIDX()

int GetRequesterIDX ( )
inlineprivate

Returns requester index.

References m_IDX.

Referenced by RemoveActiveRequestFromMaterials().

◆ IsRequesterRunning()

bool IsRequesterRunning ( )
inlineprivate

References m_IsRunning.

Referenced by IsAnyRequesterRunning().

◆ OnStart()

protected void OnStart ( Param  par = null)
inlineprivate

References SetRequesterUpdating().

Referenced by Start().

◆ OnStop()

protected void OnStop ( Param  par = null)
inlineprivate

automatically resets all material parameters of this requester to defaults

References SetDefaultValuesAll(), and SetRequesterUpdating().

◆ OnUpdate()

void OnUpdate ( float  delta)
inlineprivate

◆ PrepareData()

protected PPERequestParamDataBase PrepareData ( int  mat_id,
int  param_idx,
int  type 
)
inlineprivate

◆ QueueValuesSend()

◆ RelativizeValue()

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

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

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

Referenced by SetTargetValueFloat().

◆ SendCurrentValueData()

protected void SendCurrentValueData ( PPERequestParamDataBase  data)
inlineprivate

References PPEManagerStatic::GetPPEManager().

Referenced by OnUpdate().

◆ SetDefaultValuesAll()

◆ SetRequesterIDX()

void SetRequesterIDX ( int  idx)
inlineprivate

automatically assigned by PPERequesterBank

References m_IDX.

Referenced by Managed::RegisterRequester().

◆ SetRequesterUpdating()

void SetRequesterUpdating ( bool  state)
inlineprivate

Has to be set for the requester to be handled.

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

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

◆ SetTargetValueBool()

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

◆ SetTargetValueBoolDefault()

protected void SetTargetValueBoolDefault ( int  mat_id,
int  param_idx 
)
inlineprivate

◆ SetTargetValueColor()

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

◆ SetTargetValueColorDefault()

protected void SetTargetValueColorDefault ( int  mat_id,
int  param_idx 
)
inlineprivate

◆ SetTargetValueFloat()

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

◆ SetTargetValueFloatDefault()

protected void SetTargetValueFloatDefault ( int  mat_id,
int  param_idx 
)
inlineprivate

◆ SetTargetValueInt()

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

◆ SetTargetValueIntDefault()

protected void SetTargetValueIntDefault ( int  mat_id,
int  param_idx 
)
inlineprivate

◆ Start()

void Start ( Param  par = null)
inlineprivate

References m_IsRunning, and OnStart().

Referenced by ManBase::SetContaminatedEffectEx().

◆ Stop()

void Stop ( Param  par = null)
inlineprivate

Field Documentation

◆ m_IDX

protected int m_IDX
private

◆ m_IsRunning

protected bool m_IsRunning
private

◆ m_RequestDataStructure

◆ m_Valid

protected bool m_Valid = false
private

◆ m_ValuesSent

protected bool m_ValuesSent
private

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