Param Class Reference

Base Param Class with no parameters. Used as general purpose parameter overloaded with Param1 to Param4 templates. More...

Inheritance diagram for Param:

Collaboration diagram for Param:

Private Member Functions
bool	Serialize (Serializer ctx)
bool	Deserializer (Serializer ctx)
void	Param1 (T1 p1)
override bool	Serialize (Serializer ctx)
override bool	Deserializer (Serializer ctx)
void	Param2 (T1 p1, T2 p2)
override bool	Serialize (Serializer ctx)
override bool	Deserializer (Serializer ctx)
void	Param3 (T1 p1, T2 p2, T3 p3)
override bool	Serialize (Serializer ctx)
override bool	Deserializer (Serializer ctx)
void	Param4 (T1 p1, T2 p2, T3 p3, T4 p4)
override bool	Serialize (Serializer ctx)
override bool	Deserializer (Serializer ctx)
void	Param5 (T1 p1, T2 p2, T3 p3, T4 p4, T5 p5)
override bool	Serialize (Serializer ctx)
override bool	Deserializer (Serializer ctx)
void	Param6 (T1 p1, T2 p2, T3 p3, T4 p4, T5 p5, T6 p6)
override bool	Serialize (Serializer ctx)
override bool	Deserializer (Serializer ctx)
Private Member Functions inherited from Managed
void	IntroSceneCharacter ()
void	~IntroSceneCharacter ()
bool	IsDefaultCharacter ()
void	SetToDefaultCharacter ()
void	SetCharacterID (int char_id)
int	GetCharacterID ()
PlayerBase	GetCharacterObj ()
TStringArray	GetCharGenderList ()
TStringArray	GetCharList (ECharGender gender)
TStringArray	GetCharShirtsList ()
TStringArray	GetCharPantsList ()
TStringArray	GetCharShoesList ()
void	SetCharacterGender (ECharGender gender)
bool	IsCharacterFemale ()
ECharGender	GetCharacterGender ()
vector	GetPosition ()
int	GetNextCharacterID ()
int	GetPrevCharacterID ()
void	CreateNewCharacterRandom ()
void	CreateNewCharacterById (int character_id)
void	CreateNewCharacterByName (string character_name, bool randomize_equip=true)
void	CreateDefaultCharacter ()
void	GetLastPlayedServer (int characterID, out string address, out string name, out int port)
void	CreateNewCharacter ()
void	LoadCharacterData (vector char_pos, vector char_rot, bool default_char=false)
	Generates random equip for the new IntroSceneCharacter, whatever is defined in 'cfgCharacterCreation'.
void	CharacterUnload ()
void	CharacterLoad (int character_id, vector char_pos, vector char_rot)
void	SetupPlayerName (bool new_name)
void	SetAttachment (string type, int slot)
string	GetCharacterNameById (int char_id)
string	GetCharacterName ()
void	SaveCharName (string name)
void	SaveDefaultCharacter ()
void	TransferValues (PlayerBase player)
void	Init ()
void	OnScheduledTick (float deltatime)
void	CheckValues ()
float	GetBlood ()
float	GetHealth ()
void	CheckHealth ()
void	CheckBlood ()
void	SendInitValues ()
	Sends values on object creation.
void	SendValue (int value_type, float value)
void	ReceiveValue (int value_type, float value)
void	OnRPC (ParamsReadContext ctx)
void	ShowDebugValues (bool show)
void	BleedingIndicator (int source_ID, int severity, GameplayEffectsDataBleeding parent)
void	InitIndicator (vector position)
void	StopIndicator (bool instant=false)
void	StartRunningDrops ()
bool	IsRunningDrops ()
	Are any drops currently being animated?
void	TrySpawnNextDrop ()
void	ResetSequence ()
void	ResetIndicator ()
void	Update (float timeSlice)
bool	GetEndNow ()
int	GetSeverity ()
void	GameplayEffectsData (array< ref Widget > input, int type, int user_override=-1)
void	Init (array< ref Widget > input, int type, Widget layout_root, int user_override=-1)
array< ref Widget >	GetWidgetSet ()
int	GetWidgetSetType ()
int	GetWidgetSetID ()
bool	HasDefinedHandle ()
	Returns 'true' if this class contains update info.
bool	DataInitialized ()
void	UpdateVisibility (bool state)
void	RegisterData (Param p)
void	Update (float timeSlice=0, Param p=null, int handle=-1)
void	ForceStop ()

Private Attributes
T1	param1
T2	param2
T3	param3
T4	param4
T5	param5
T6	param6
Private Attributes inherited from Managed
int	m_CharacterId
string	m_CharacterType
MenuData	m_CharacterDta
PlayerBase	m_CharacterObj
vector	m_CharacterPos
vector	m_CharacterRot
ref TStringArray	m_CharGenderList = new TStringArray
ref TStringArray	m_CharShirtList = new TStringArray
ref TStringArray	m_CharPantsList = new TStringArray
ref TStringArray	m_CharShoesList = new TStringArray
ref map< ECharGender, ref array< string > >	m_Characters = new map<ECharGender, ref array<string>>
ECharGender	m_CharGender
bool	m_InitialSyncSent
bool	m_Initialized
bool	m_Terminating = false
bool	m_EndNow = false
bool	m_IsRunning = false
int	m_DropSpawnsQueued
int	m_ActiveDropsCount
int	m_Severity
int	m_SourceID
GameplayEffectsDataBleeding	m_ParentMetaData
array< float >	m_DropProbabilityArray
float	m_AverageFrequency
float	m_SequenceTick
float	m_SequenceDuration
float	m_TimeElapsedTotal
float	m_TimeElapsedSequence
float	m_LastDropSpawnTime
float	m_DropSpawnMinDelay
float	m_DropSpawnMaxDelay
int	m_CurrentDropProbabilityStep
int	m_DropProbabilityRollsCount
vector	m_BasePosition
ref set< ref BleedingIndicatorDropData >	m_ActiveDrops
ref set< int >	m_CleanupQueue
ref array< ref Widget >	m_WidgetArray
int	m_Type
int	m_WidgetSetIdentifier
Widget	m_LayoutRoot

Detailed Description

Base Param Class with no parameters. Used as general purpose parameter overloaded with Param1 to Param4 templates.

Param Class Template with six parameters.

Param Class Template with five parameters.

Param Class Template with four parameters.
usage:

Param Class Template with three parameters.
usage:

Param Class Template with two parameters.
usage:

Param Class Template with one parameter.
usage:

Param paramA = new Param1<int>(55);
Param paramB = new Param1<string>("Hello");

Param param = new Param2<float, string>(3.14, "Pi");

Param param = new Param3<float, string, bool>(2.89, "Lala", true);

Param param = new Param4<int, bool, float, string>(100, false, 79.9, "Test");

Definition at line 11 of file param.c.

Member Function Documentation

Deserializer() [1/7]

bool Param::Deserializer ( Serializer ctx )

inlineprivate

Definition at line 18 of file param.c.

  {
    return false;
  }

Deserializer() [2/7]

override bool Param::Deserializer ( Serializer ctx )

inlineprivate

Definition at line 46 of file param.c.

  {
    return ctx.Read(param1);
  }

References Serializer::Read().

Deserializer() [3/7]

override bool Param::Deserializer ( Serializer ctx )

inlineprivate

Definition at line 75 of file param.c.

  {
    return ctx.Read(param1) && ctx.Read(param2);
  }

References Serializer::Read().

Deserializer() [4/7]

override bool Param::Deserializer ( Serializer ctx )

inlineprivate

Definition at line 106 of file param.c.

  {
    return ctx.Read(param1) && ctx.Read(param2) && ctx.Read(param3);
  }

References Serializer::Read().

Deserializer() [5/7]

override bool Param::Deserializer ( Serializer ctx )

inlineprivate

Definition at line 139 of file param.c.

  {
    return ctx.Read(param1) && ctx.Read(param2) && ctx.Read(param3) && ctx.Read(param4);
  }

References Serializer::Read().

Deserializer() [6/7]

override bool Param::Deserializer ( Serializer ctx )

inlineprivate

Definition at line 170 of file param.c.

  {
    return ctx.Read(param1) && ctx.Read(param2) && ctx.Read(param3) && ctx.Read(param4) && ctx.Read(param5);
  }

References Serializer::Read().

Deserializer() [7/7]

override bool Param::Deserializer ( Serializer ctx )

inlineprivate

Definition at line 203 of file param.c.

  {
    return ctx.Read(param1) && ctx.Read(param2) && ctx.Read(param3) && ctx.Read(param4) && ctx.Read(param5) && ctx.Read(param6);
  }

References Serializer::Read().

Param1()

void Param::Param1 ( T1 p1 )

inlineprivate

Definition at line 36 of file param.c.

  {
    param1 = p1;
  }

Param2()

void Param::Param2 ( T1 p1, T2 p2 )

inlineprivate

Definition at line 64 of file param.c.

  {
    param1 = p1;
    param2 = p2;
  }

Param3()

void Param::Param3 ( T1 p1, T2 p2, T3 p3 )

inlineprivate

Definition at line 94 of file param.c.

  {
    param1 = p1;
    param2 = p2;
    param3 = p3;
  }

Param4()

void Param::Param4 ( T1 p1, T2 p2, T3 p3, T4 p4 )

inlineprivate

Definition at line 126 of file param.c.

  {
    param1 = p1;
    param2 = p2;
    param3 = p3;
    param4 = p4;
  }

Param5()

void Param::Param5 ( T1 p1, T2 p2, T3 p3, T4 p4, T5 p5 )

inlineprivate

Definition at line 156 of file param.c.

  {
    param1 = p1;
    param2 = p2;
    param3 = p3;
    param4 = p4;
    param5 = p5;
  }

Param6()

void Param::Param6 ( T1 p1, T2 p2, T3 p3, T4 p4, T5 p5, T6 p6 )

inlineprivate

Definition at line 188 of file param.c.

  {
    param1 = p1;
    param2 = p2;
    param3 = p3;
    param4 = p4;
    param5 = p5;
    param6 = p6;
  }

Serialize() [1/7]

bool Param::Serialize ( Serializer ctx )

inlineprivate

Definition at line 13 of file param.c.

  {
    return false;
  }

Serialize() [2/7]

override bool Param::Serialize ( Serializer ctx )

inlineprivate

Definition at line 41 of file param.c.

  {
    return ctx.Write(param1);
  }

References Serializer::Write().

Serialize() [3/7]

override bool Param::Serialize ( Serializer ctx )

inlineprivate

Definition at line 70 of file param.c.

  {
    return ctx.Write(param1) && ctx.Write(param2);
  }

References Serializer::Write().

Serialize() [4/7]

override bool Param::Serialize ( Serializer ctx )

inlineprivate

Definition at line 101 of file param.c.

  {
    return ctx.Write(param1) && ctx.Write(param2) && ctx.Write(param3);
  }

References Serializer::Write().

Serialize() [5/7]

override bool Param::Serialize ( Serializer ctx )

inlineprivate

Definition at line 134 of file param.c.

  {
    return ctx.Write(param1) && ctx.Write(param2) && ctx.Write(param3) && ctx.Write(param4);
  }

References Serializer::Write().

Serialize() [6/7]

override bool Param::Serialize ( Serializer ctx )

inlineprivate

Definition at line 165 of file param.c.

  {
    return ctx.Write(param1) && ctx.Write(param2) && ctx.Write(param3) && ctx.Write(param4) && ctx.Write(param5);
  }

References Serializer::Write().

Serialize() [7/7]

override bool Param::Serialize ( Serializer ctx )

inlineprivate

Definition at line 198 of file param.c.

  {
    return ctx.Write(param1) && ctx.Write(param2) && ctx.Write(param3) && ctx.Write(param4) && ctx.Write(param5) && ctx.Write(param6);
  }

References Serializer::Write().

Member Data Documentation

param1

T1 Param::param1

private

Definition at line 34 of file param.c.

param2

T2 Param::param2

private

Definition at line 62 of file param.c.

param3

T3 Param::param3

private

Definition at line 92 of file param.c.

param4

T4 Param::param4

private

Definition at line 124 of file param.c.

param5

T5 Param::param5

private

Definition at line 154 of file param.c.

param6

T6 Param::param6

private

Definition at line 186 of file param.c.

---

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

• scripts/1_Core/param.c