Component Class Reference

Inheritance diagram for Component:

Collaboration diagram for Component:

Protected Member Functions
void	Event_OnFrame (IEntity other, float timeSlice)
Shape	DebugBBoxDraw ()
void	DebugBBoxSetColor (int color)
void	DebugBBoxDelete ()
Shape	DebugDirectionDraw (float distance=1)
void	DebugDirectionSetColor (int color)
void	DebugDirectionDelete ()
void	SetParentEntityAI (EntityAI e)
void	Event_OnAwake ()
void	Event_OnInit ()
void	LogThis (string msg, string fnc_name="n/a")
void	LogThisWarning (string msg, string fnc_name="n/a")
void	LogThisError (string msg, string fnc_name="n/a")
string	GetCompName ()
int	GetCompType ()
void	Event_OnItemAttached (EntityAI item, string slot_name)
void	Event_OnItemDetached (EntityAI item, string slot_name)
override Shape	DebugBBoxDraw ()
override void	DebugBBoxSetColor (int color)
override void	DebugBBoxDelete ()
override Shape	DebugDirectionDraw (float distance=1)
override void	DebugDirectionDelete ()
void	OnDrawing ()

Static Protected Member Functions
static void	Init ()
static string	GetNameByType (int comp_type)
static bool	IsTypeExist (int comp_type)
static void	LogErrorBadCompType (int comp_type, string fnc_name)
static void	LogWarningAlredyExist (int comp_type, string fnc_name)

Protected Attributes
EntityAI	m_ThisEntityAI
Shape	m_DebugShapeBBox
Shape	m_DebugShapeDirection
float	m_DebugShapeDirectionDist

Static Private Attributes
static string	m_CompNames [COMP_TYPE_COUNT]

Detailed Description

Definition at line 15 of file Component.c.

Member Function Documentation

DebugBBoxDelete() [1/2]

void Component::DebugBBoxDelete ( )

protected

DebugBBoxDelete() [2/2]

override void Component::DebugBBoxDelete ( )

inlineprotected

Definition at line 40 of file ComponentEntityDebug.c.

  {
#ifndef DEVELOPER
    return;
#endif
 
    if (m_DebugShapeBBox)
    {
      m_DebugShapeBBox.Destroy();
      m_DebugShapeBBox = null;
    }
 
    if (!m_DebugShapeDirection && !m_DebugShapeBBox)
      GetGame().GetCallQueue(CALL_CATEGORY_GUI).Remove(OnDrawing);
  }

References CALL_CATEGORY_GUI, and GetGame().

DebugBBoxDraw() [1/2]

Shape Component::DebugBBoxDraw ( )

protected

DebugBBoxDraw() [2/2]

override Shape Component::DebugBBoxDraw ( )

inlineprotected

Definition at line 9 of file ComponentEntityDebug.c.

  {
#ifndef DEVELOPER
    return null;
#endif
 
    if (m_DebugShapeBBox)
      m_DebugShapeBBox.Destroy();
 
    vector min_max[2];
 
    if (!m_ThisEntityAI.GetCollisionBox(min_max))
      return null;
 
    m_DebugShapeBBox = Debug.DrawBox(min_max[0], min_max[1]);
 
    GetGame().GetCallQueue(CALL_CATEGORY_GUI).CallLater(OnDrawing, 0, true);
 
    m_ThisEntityAI.SetEventMask(EntityEvent.FRAME);
 
    return null;
  }

References CALL_CATEGORY_GUI, Debug::DrawBox(), and GetGame().

DebugBBoxSetColor() [1/2]

void Component::DebugBBoxSetColor ( int color )

protected

DebugBBoxSetColor() [2/2]

override void Component::DebugBBoxSetColor ( int color )

inlineprotected

Definition at line 33 of file ComponentEntityDebug.c.

  {
    if (m_DebugShapeBBox)
      m_DebugShapeBBox.SetColor(color);
  }

DebugDirectionDelete() [1/2]

void Component::DebugDirectionDelete ( )

protected

DebugDirectionDelete() [2/2]

override void Component::DebugDirectionDelete ( )

inlineprotected

Definition at line 78 of file ComponentEntityDebug.c.

  {
#ifndef DEVELOPER
    return;
#endif
 
    if (m_DebugShapeDirection)
    {
      m_DebugShapeDirection.Destroy();
      m_DebugShapeDirection = null;
    }
 
    if (!m_DebugShapeDirection && !m_DebugShapeBBox)
      GetGame().GetCallQueue(CALL_CATEGORY_GUI).Remove(OnDrawing);
  }

References CALL_CATEGORY_GUI, and GetGame().

DebugDirectionDraw() [1/2]

Shape Component::DebugDirectionDraw ( float distance = 1 )

protected

DebugDirectionDraw() [2/2]

override Shape Component::DebugDirectionDraw ( float distance = 1 )

inlineprotected

Definition at line 57 of file ComponentEntityDebug.c.

  {
#ifndef DEVELOPER
    return null;
#endif
 
    if (m_DebugShapeDirection)
      m_DebugShapeDirection.Destroy();
 
    vector p1 = "0 0 0";
    vector p2 = m_ThisEntityAI.GetDirection() * m_DebugShapeDirectionDist;
    m_DebugShapeDirectionDist = distance;
    m_DebugShapeDirection = Debug.DrawArrow(p1, p2);
 
    GetGame().GetCallQueue(CALL_CATEGORY_GUI).CallLater(OnDrawing, 0, true);
 
    m_ThisEntityAI.SetEventMask(EntityEvent.FRAME);
    return null;
  }

References CALL_CATEGORY_GUI, Debug::DrawArrow(), and GetGame().

DebugDirectionSetColor()

void Component::DebugDirectionSetColor ( int color )

protected

Event_OnAwake()

void Component::Event_OnAwake ( )

inlineprotected

Definition at line 100 of file Component.c.

  {
 
  }

Event_OnFrame()

void Component::Event_OnFrame ( IEntity other, float timeSlice )

protected

Event_OnInit()

void Component::Event_OnInit ( )

inlineprotected

Definition at line 108 of file Component.c.

  {
 
  }

Event_OnItemAttached()

void Component::Event_OnItemAttached ( EntityAI item, string slot_name )

inlineprotected

Definition at line 156 of file Component.c.

  {
    LogThis("" + item + " -> " + slot_name, "Event_OnItemAttached");
    //Debug.Log("Component=>Event_OnItemAttached: " + item + " -> " + slot_name, );
  }

References LogThis().

Event_OnItemDetached()

void Component::Event_OnItemDetached ( EntityAI item, string slot_name )

inlineprotected

Definition at line 165 of file Component.c.

  {
    LogThis("" + item + " <- " + slot_name, "Event_OnItemDetached");
    //Log("Component=>Event_OnItemDetached: " + item + " <- " + slot_name );
  }

References LogThis().

GetCompName()

string Component::GetCompName ( )

inlineprotected

Definition at line 140 of file Component.c.

  {
    return Component.GetNameByType(this.GetCompType());
  }

References GetCompType(), and GetNameByType().

Referenced by LogThisError(), and LogThisWarning().

GetCompType()

int Component::GetCompType ( )

inlineprotected

Definition at line 148 of file Component.c.

  {
    return COMP_TYPE_UNDEFINED;
  }

References COMP_TYPE_UNDEFINED.

Referenced by GetCompName().

GetNameByType()

static string Component::GetNameByType ( int comp_type )

inlinestaticprotected

Definition at line 48 of file Component.c.

  {
    if (IsTypeExist(comp_type) == false)
    {
      LogErrorBadCompType(comp_type, "Component->GetNameByType()");
      return "None";
    }
 
    return m_CompNames[comp_type];
  }

References IsTypeExist(), LogErrorBadCompType(), and m_CompNames.

Referenced by ComponentsBank::CreateComponent(), GetCompName(), and LogWarningAlredyExist().

Init()

static void Component::Init ( )

inlinestaticprotected

Definition at line 37 of file Component.c.

  {
    m_CompNames[COMP_TYPE_ETITY_DEBUG] = "ComponentEntityDebug";
    m_CompNames[COMP_TYPE_ENERGY_MANAGER] = "ComponentEnergyManager";
    m_CompNames[COMP_TYPE_BODY_STAGING] = "ComponentBodyStaging";
    m_CompNames[COMP_TYPE_ANIMAL_BLEEDING] = "ComponentAnimalBleeding";
  }

References COMP_TYPE_ANIMAL_BLEEDING, COMP_TYPE_BODY_STAGING, COMP_TYPE_ENERGY_MANAGER, COMP_TYPE_ETITY_DEBUG, and m_CompNames.

Referenced by CGame::DayZGame().

IsTypeExist()

static bool Component::IsTypeExist ( int comp_type )

inlinestaticprotected

Definition at line 62 of file Component.c.

  {
    if (comp_type < 0 || comp_type >= COMP_TYPE_COUNT)
      return false;
 
    return true;
  }

References COMP_TYPE_COUNT.

Referenced by ComponentsBank::CreateComponent(), ComponentsBank::GetComponent(), and GetNameByType().

LogErrorBadCompType()

static void Component::LogErrorBadCompType ( int comp_type, string fnc_name )

inlinestaticprotected

Definition at line 74 of file Component.c.

  {
    string msg = "Bad parameter comp_type='" + comp_type.ToString() + "'. Parameter must be 0-" + (COMP_TYPE_COUNT - 1).ToString() + ". Returning component name 'None'.";
    Debug.LogError(msg, "Component", "n/a", fnc_name);
  }

References COMP_TYPE_COUNT, Debug::LogError(), and ToString().

Referenced by ComponentsBank::CreateComponent(), ComponentsBank::GetComponent(), and GetNameByType().

LogThis()

void Component::LogThis ( string msg, string fnc_name = "n/a" )

inlineprotected

Definition at line 116 of file Component.c.

  {
    //Debug.Log(msg, GetCompName(), "n/a", fnc_name, m_ThisEntityAI.ToString());
  }

Referenced by Event_OnItemAttached(), and Event_OnItemDetached().

LogThisError()

void Component::LogThisError ( string msg, string fnc_name = "n/a" )

inlineprotected

Definition at line 132 of file Component.c.

  {
    Debug.LogError(msg, GetCompName(), "n/a", fnc_name, m_ThisEntityAI.ToString());
  }

References GetCompName(), Debug::LogError(), and m_ThisEntityAI.

LogThisWarning()

void Component::LogThisWarning ( string msg, string fnc_name = "n/a" )

inlineprotected

Definition at line 124 of file Component.c.

  {
    Debug.LogWarning(msg, GetCompName(), "n/a", fnc_name, m_ThisEntityAI.ToString());
  }

References GetCompName(), Debug::LogWarning(), and m_ThisEntityAI.

LogWarningAlredyExist()

static void Component::LogWarningAlredyExist ( int comp_type, string fnc_name )

inlinestaticprotected

Definition at line 83 of file Component.c.

  {
    string msg = "Component '" + Component.GetNameByType(comp_type) + "' already exists!";
    Debug.LogError(msg, "Component", "n/a", fnc_name);
  }

References GetNameByType(), and Debug::LogError().

Referenced by ComponentsBank::CreateComponent().

OnDrawing()

void Component::OnDrawing ( )

inlineprotected

Definition at line 94 of file ComponentEntityDebug.c.

  {
#ifndef DEVELOPER
    return;
#endif
 
    if (m_DebugShapeBBox || m_DebugShapeDirection)
    {
      vector mat[4];
      m_ThisEntityAI.GetTransform(mat);
 
      if (m_DebugShapeBBox)
        m_DebugShapeBBox.SetMatrix(mat);
 
      if (m_DebugShapeDirection)
        m_DebugShapeDirection.SetMatrix(mat);
    }
  }

SetParentEntityAI()

void Component::SetParentEntityAI ( EntityAI e )

inlineprotected

Definition at line 92 of file Component.c.

  {
    m_ThisEntityAI = e;
  }

References m_ThisEntityAI.

Member Data Documentation

m_CompNames

string Component::m_CompNames[COMP_TYPE_COUNT]

staticprivate

Definition at line 20 of file Component.c.

Referenced by GetNameByType(), and Init().

m_DebugShapeBBox

Shape Component::m_DebugShapeBBox

protected

Definition at line 4 of file ComponentEntityDebug.c.

m_DebugShapeDirection

Shape Component::m_DebugShapeDirection

protected

Definition at line 5 of file ComponentEntityDebug.c.

m_DebugShapeDirectionDist

float Component::m_DebugShapeDirectionDist

protected

Definition at line 6 of file ComponentEntityDebug.c.

m_ThisEntityAI

EntityAI Component::m_ThisEntityAI

protected

Definition at line 24 of file Component.c.

Referenced by ComponentAnimalBleeding::Bleed(), ComponentEnergyManager::CanBePluggedInto(), ComponentEnergyManager::CanReceivePlugFrom(), ComponentEnergyManager::CanWork(), ComponentEnergyManager::CheckWetness(), ComponentEnergyManager::ConsumeEnergy(), ComponentEnergyManager::DebugUpdate(), ComponentEnergyManager::DeviceUpdate(), ComponentEnergyManager::Event_OnAwake(), ComponentEnergyManager::Event_OnInit(), ComponentEnergyManager::FindAndConsumeEnergy(), ComponentEnergyManager::GetEnergyMax(), ComponentEnergyManager::GetThisEntityAI(), ComponentAnimalBleeding::InflictWoundDamage(), LogThisError(), LogThisWarning(), ComponentEnergyManager::OnAttachmentAdded(), ComponentEnergyManager::OnDeviceDestroyed(), ComponentEnergyManager::OnEnergyAdded(), ComponentEnergyManager::OnEnergyConsumed(), ComponentEnergyManager::OnInteractBranch(), ComponentEnergyManager::OnIsPlugged(), ComponentEnergyManager::OnIsUnplugged(), ComponentEnergyManager::OnOwnSocketReleased(), ComponentEnergyManager::OnOwnSocketTaken(), ComponentEnergyManager::OnWork(), ComponentEnergyManager::PlugInDevice(), ComponentEnergyManager::PlugThisInto(), ComponentEnergyManager::ResetEnergyUsage(), ComponentEnergyManager::SetEnergy(), SetParentEntityAI(), ComponentEnergyManager::SwitchOff(), ComponentEnergyManager::SwitchOn(), ComponentEnergyManager::Synch(), ComponentBodyStaging::SynchSkinnedState(), ComponentEnergyManager::UnplugCordFromSocket(), ComponentEnergyManager::UnplugDevice(), ComponentEnergyManager::UnplugThis(), ComponentEnergyManager::UpdateCanWork(), ComponentEnergyManager::UpdatePlugState(), ComponentEnergyManager::UpdateSelections(), and ComponentEnergyManager::UpdateSocketSelections().

---

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

• scripts/3_Game/tools/Component.c
• scripts/3_Game/tools/Component/ComponentEntityDebug.c