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

Data Structures

class  PPERequesterBase
 

Functions

class PPERequesterBase GetCategoryMask ()
 mask for mass-handling methods like 'StopAllEffects'
 
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.
 
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)
 

Variables

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
 

Function Documentation

◆ ClearRequesterData()

protected void ClearRequesterData ( )

◆ DbgPrnt()

void DbgPrnt ( string  text)

◆ GetActiveRequestStructure()

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

◆ GetCategoryMask()

int GetCategoryMask ( )

mask for mass-handling methods like 'StopAllEffects'

◆ GetRequestData()

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)

◆ GetRequesterIDX()

int GetRequesterIDX ( )

Returns requester index.

◆ IsRequesterRunning()

bool IsRequesterRunning ( )

◆ OnStart()

override protected void OnStart ( Param  par = null)

Referenced by TimerBase::Run().

◆ OnStop()

protected void OnStop ( Param  par = null)

automatically resets all material parameters of this requester to defaults

◆ OnUpdate()

void OnUpdate ( float  delta)

◆ PPERequesterBase()

void PPERequesterBase ( int  requester_IDX)

◆ PrepareData()

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

◆ QueueValuesSend()

protected void QueueValuesSend ( )

Sets this requester to update in the manager.

◆ RelativizeValue()

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)

◆ SendCurrentValueData()

protected void SendCurrentValueData ( PPERequestParamDataBase  data)

◆ SetDefaultValuesAll()

protected void SetDefaultValuesAll ( )

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

◆ SetRequesterIDX()

void SetRequesterIDX ( int  idx)

automatically assigned by PPERequesterBank

◆ SetRequesterUpdating()

void SetRequesterUpdating ( bool  state)

Has to be set for the requester to be handled.

Referenced by PPERequester_GameplayBase::FadeOutEffect(), and PPERequester_GameplayBase::OnUpdate().

◆ SetTargetValueBool()

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

◆ SetTargetValueBoolDefault()

protected void SetTargetValueBoolDefault ( int  mat_id,
int  param_idx 
)

◆ SetTargetValueColor()

◆ SetTargetValueColorDefault()

protected void SetTargetValueColorDefault ( int  mat_id,
int  param_idx 
)

◆ SetTargetValueFloat()

◆ SetTargetValueFloatDefault()

protected void SetTargetValueFloatDefault ( int  mat_id,
int  param_idx 
)

◆ SetTargetValueInt()

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

◆ SetTargetValueIntDefault()

protected void SetTargetValueIntDefault ( int  mat_id,
int  param_idx 
)

◆ Start()

void Start ( Param  par = null)

◆ Stop()

void Stop ( Param  par = null)

Variable Documentation

◆ m_IDX

protected int m_IDX

◆ m_IsRunning

◆ m_RequestDataStructure

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

◆ m_Valid

protected bool m_Valid = false

◆ m_ValuesSent

protected bool m_ValuesSent