PC Stable Documentation
 
•All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Loading...
Searching...
No Matches
Private Member Functions | Private Attributes | Static Private Attributes
SceneObject Class Reference

Private Member Functions

SceneObject Init (string obj_name, vector pos)
 
EntityAI GetObject ()
 
string GetName ()
 
bool IsPlayer ()
 
string GetInitScript ()
 
void SetInitScript (string init_script)
 
void EditorShapeUpdatePos ()
 
void EditorShapeSetColor (int color)
 
void EditorShapeSelect ()
 
void EditorShapeDeselect ()
 
vector GetSize ()
 
void EditorShapeAdd ()
 
void EditorShapeRemove ()
 
void EditorLineRemove (SceneObject obj)
 
void EditorLineAdd (SceneObject obj)
 
void LinkEntityAI (EntityAI e)
 
bool IsLinkedWithSceneObject (SceneObject scene_object)
 
void LinkSceneObject (SceneObject scene_object, bool draw_line=true)
 
void UnlinkSceneObject (SceneObject scene_object)
 
void UnlinkAll ()
 
array< SceneObject > GetLinkedSceneObjects ()
 
int GetLinkedSceneObjectsCount ()
 
SceneObject GetLinkedSceneObject (int i)
 
EntityAI GetLinkedObject (int i)
 
void ~SceneObject ()
 
string GetTypeName ()
 
void PlaceOnSurface ()
 
void SetPosition (vector pos)
 
vector GetPosition ()
 
float GetHealth ()
 
float GetMaxHealth ()
 
void SetHealth (float value)
 
string GetPositionAsString ()
 
void SetPositionAsString (string string_pos)
 
float GetRotation ()
 
void SetRotation (float rot)
 
void SceneObjectSynch (Param p)
 
void AddRotation (float add_rot)
 
void AddAttachment (string att_name)
 
bool CanAttachment (EntityAI e)
 
void RemoveAttachment (EntityAI e)
 
array< EntityAI > GetAttachments ()
 
TStringArray GetConfigAttachments ()
 
override bool IsPlayer ()
 

Private Attributes

protected EntityAI m_ObjectPtr
 
protected Shape m_DebugShapeBBox
 
protected string m_InitScript
 
protected string m_ObjectName
 
protected string m_ObjectNameOrigin
 
protected ref array< SceneObject > m_LinkedSceneObjects
 
protected ref map< SceneObject, Shape > m_LinkedSceneObjectsShapes
 
ref array< int > m_LinkedSceneObjectsIndices
 

Static Private Attributes

static const int COLOR_OBJ_BBOX_NORMAL = 0x00000000
 
static const int COLOR_OBJ_BBOX_SELECT = 0x1f007C00
 

Constructor & Destructor Documentation

◆ ~SceneObject()

void ~SceneObject ( )
inlineprivate

References EditorLineRemove(), EditorShapeRemove(), GetGame(), GetPlayer(), m_LinkedSceneObjects, m_ObjectPtr, and CGame::ObjectDelete().

Member Function Documentation

◆ AddAttachment()

void AddAttachment ( string  att_name)
inlineprivate

References GetObject().

Referenced by PluginBase::SelectedObjectDuplicate().

◆ AddRotation()

void AddRotation ( float  add_rot)
inlineprivate

References EditorShapeUpdatePos(), GetGame(), m_ObjectPtr, and SceneObjectSynch().

◆ CanAttachment()

bool CanAttachment ( EntityAI  e)
inlineprivate

References GetObject().

◆ EditorLineAdd()

void EditorLineAdd ( SceneObject  obj)
inlineprivate

References Debug::DrawArrow(), EditorLineRemove(), GetObject(), GetSize(), and m_LinkedSceneObjectsShapes.

Referenced by PluginBase::EditorUpdate(), and LinkSceneObject().

◆ EditorLineRemove()

void EditorLineRemove ( SceneObject  obj)
inlineprivate

References m_LinkedSceneObjectsShapes.

Referenced by EditorLineAdd(), PluginBase::EditorUpdate(), UnlinkSceneObject(), and ~SceneObject().

◆ EditorShapeAdd()

void EditorShapeAdd ( )
inlineprivate

References Debug::DrawBox(), EditorShapeDeselect(), EditorShapeUpdatePos(), GetSize(), and m_DebugShapeBBox.

Referenced by PluginBase::EditorUpdate().

◆ EditorShapeDeselect()

void EditorShapeDeselect ( )
inlineprivate

References COLOR_OBJ_BBOX_NORMAL, and EditorShapeSetColor().

Referenced by EditorShapeAdd(), and PluginBase::EditorUpdate().

◆ EditorShapeRemove()

void EditorShapeRemove ( )
inlineprivate

References m_DebugShapeBBox.

Referenced by PluginBase::EditorUpdate(), and ~SceneObject().

◆ EditorShapeSelect()

void EditorShapeSelect ( )
inlineprivate

References COLOR_OBJ_BBOX_SELECT, and EditorShapeSetColor().

Referenced by PluginBase::EditorUpdate().

◆ EditorShapeSetColor()

void EditorShapeSetColor ( int  color)
inlineprivate

References m_DebugShapeBBox.

Referenced by EditorShapeDeselect(), and EditorShapeSelect().

◆ EditorShapeUpdatePos()

void EditorShapeUpdatePos ( )
inlineprivate

References GetObject(), and m_DebugShapeBBox.

Referenced by AddRotation(), EditorShapeAdd(), SetPosition(), and SetRotation().

◆ GetAttachments()

array< EntityAI > GetAttachments ( )
inlineprivate

References GetObject().

Referenced by PluginBase::SelectedObjectDuplicate().

◆ GetConfigAttachments()

TStringArray GetConfigAttachments ( )
inlineprivate

References CFG_MAGAZINESPATH, CFG_VEHICLESPATH, CFG_WEAPONSPATH, CGame::ConfigGetTextArray(), GetGame(), and GetTypeName().

Referenced by UIScriptedMenu::Refresh().

◆ GetHealth()

float GetHealth ( )
inlineprivate

References m_ObjectPtr.

Referenced by UIScriptedMenu::Refresh(), and PluginConfigHandler::SaveSceneObjects().

◆ GetInitScript()

string GetInitScript ( )
inlineprivate

References m_InitScript.

Referenced by PluginBase::ExecuteInitScripts(), UIPopupScript::OnOpen(), and PluginConfigHandler::SaveSceneObjects().

◆ GetLinkedObject()

EntityAI GetLinkedObject ( int  i)
inlineprivate

References GetLinkedSceneObject(), and GetObject().

◆ GetLinkedSceneObject()

SceneObject GetLinkedSceneObject ( int  i)
inlineprivate

References m_LinkedSceneObjects.

Referenced by GetLinkedObject(), and UnlinkAll().

◆ GetLinkedSceneObjects()

array< SceneObject > GetLinkedSceneObjects ( )
inlineprivate

References m_LinkedSceneObjects.

Referenced by PluginBase::EditorUpdate(), and PluginConfigHandler::SaveSceneObjects().

◆ GetLinkedSceneObjectsCount()

int GetLinkedSceneObjectsCount ( )
inlineprivate

References m_LinkedSceneObjects.

Referenced by UnlinkAll().

◆ GetMaxHealth()

float GetMaxHealth ( )
inlineprivate

References m_ObjectPtr.

◆ GetName()

string GetName ( )
inlineprivate

References m_ObjectName.

◆ GetObject()

EntityAI GetObject ( )
inlineprivate

References m_ObjectPtr.

Referenced by AddAttachment(), CanAttachment(), PluginBase::DeleteSceneObject(), EditorLineAdd(), EditorShapeUpdatePos(), PluginBase::ExecuteEnforceScript(), GetAttachments(), GetLinkedObject(), PluginBase::GetSceneObjectByEntity(), GetSize(), PluginConfigHandler::LoadSceneObjects(), PluginConfigHandler::SaveSceneObjects(), PluginBase::SelectedObjectDuplicate(), and PluginBase::SelectedObjectSetDamage().

◆ GetPosition()

vector GetPosition ( )
inlineprivate

References m_ObjectPtr, and Vector().

Referenced by UIScriptedMenu::Refresh(), PluginBase::SelectedObjectDuplicate(), PluginBase::SelectedObjectFocus(), PluginBase::SelectedObjectSetPosX(), PluginBase::SelectedObjectSetPosY(), and PluginBase::SelectedObjectSetPosZ().

◆ GetPositionAsString()

string GetPositionAsString ( )
inlineprivate

References m_ObjectPtr, vector::ToString(), and Vector().

Referenced by PluginConfigHandler::SaveSceneObjects().

◆ GetRotation()

float GetRotation ( )
inlineprivate

References m_ObjectPtr.

Referenced by UIScriptedMenu::Refresh(), PluginConfigHandler::SaveSceneObjects(), and PluginBase::SelectedObjectDuplicate().

◆ GetSize()

vector GetSize ( )
inlineprivate

References GetObject(), m_ObjectNameOrigin, Print(), and Vector().

Referenced by EditorLineAdd(), EditorShapeAdd(), and PluginBase::SelectedObjectFocus().

◆ GetTypeName()

string GetTypeName ( )
inlineprivate

References m_ObjectPtr.

Referenced by GetConfigAttachments(), UIScriptedMenu::GetFiltredSceneObjects(), UIScriptedMenu::Refresh(), PluginConfigHandler::SaveSceneObjects(), PluginLocalProfile::SceneSave(), PluginBase::SelectedObjectDuplicate(), and UIScriptedMenu::UpdateListObjects().

◆ Init()

SceneObject Init ( string  obj_name,
vector  pos 
)
inlineprivate

References GetGame(), GetPlugin(), CGame::IsKindOf(), LinkEntityAI(), m_LinkedSceneObjects, m_LinkedSceneObjectsIndices, m_LinkedSceneObjectsShapes, m_ObjectName, m_ObjectNameOrigin, ItemBase::SetQuantity(), and STRING_EMPTY.

Referenced by SceneData::AddObject(), and SceneData::CreateSceneObject().

◆ IsLinkedWithSceneObject()

bool IsLinkedWithSceneObject ( SceneObject  scene_object)
inlineprivate

References m_LinkedSceneObjects.

Referenced by PluginBase::AreSceneObjectsLinked(), and LinkSceneObject().

◆ IsPlayer() [1/2]

bool IsPlayer ( )
inlineprivate

Referenced by SceneData::AddObject(), PluginBase::DeleteSelectedObject(), and PluginBase::Event_OnClickMiddle().

◆ IsPlayer() [2/2]

override bool IsPlayer ( )
inlineprivate

◆ LinkEntityAI()

void LinkEntityAI ( EntityAI  e)
inlineprivate

References m_ObjectPtr.

Referenced by SceneData::AddObject(), and Init().

◆ LinkSceneObject()

void LinkSceneObject ( SceneObject  scene_object,
bool  draw_line = true 
)
inlineprivate

References EditorLineAdd(), IsLinkedWithSceneObject(), and m_LinkedSceneObjects.

Referenced by PluginBase::LinkSceneObjects(), and PluginBase::RestoreSceneObjectsLinks().

◆ PlaceOnSurface()

void PlaceOnSurface ( )
inlineprivate

References GetGame(), m_ObjectPtr, and SceneObjectSynch().

Referenced by SetPosition().

◆ RemoveAttachment()

void RemoveAttachment ( EntityAI  e)
inlineprivate

References GetGame(), and CGame::ObjectDelete().

◆ SceneObjectSynch()

void SceneObjectSynch ( Param  p)
inlineprivate

References GetGame(), GetPlayer(), and CGame::RPCSingleParam().

Referenced by AddRotation(), PlaceOnSurface(), SetHealth(), and SetPosition().

◆ SetHealth()

void SetHealth ( float  value)
inlineprivate

References GetGame(), m_ObjectPtr, and SceneObjectSynch().

Referenced by PluginConfigHandler::LoadSceneObjects(), and PluginBase::SelectedObjectSetDamage().

◆ SetInitScript()

void SetInitScript ( string  init_script)
inlineprivate

References m_InitScript.

Referenced by PluginConfigHandler::LoadSceneObjects(), and UIPopupScript::OnClick().

◆ SetPosition()

void SetPosition ( vector  pos)
inlineprivate

References EditorShapeUpdatePos(), GetGame(), m_ObjectPtr, PlaceOnSurface(), and SceneObjectSynch().

Referenced by PluginBase::SelectedObjectSetPosX(), PluginBase::SelectedObjectSetPosY(), PluginBase::SelectedObjectSetPosZ(), and SetPositionAsString().

◆ SetPositionAsString()

void SetPositionAsString ( string  string_pos)
inlineprivate

References SetPosition(), and string::ToVector().

◆ SetRotation()

void SetRotation ( float  rot)
inlineprivate

References EditorShapeUpdatePos(), and m_ObjectPtr.

Referenced by PluginConfigHandler::LoadSceneObjects(), and PluginBase::SelectedObjectDuplicate().

◆ UnlinkAll()

void UnlinkAll ( )
inlineprivate

References GetLinkedSceneObject(), and GetLinkedSceneObjectsCount().

Referenced by PluginBase::DeleteSceneObject().

◆ UnlinkSceneObject()

void UnlinkSceneObject ( SceneObject  scene_object)
inlineprivate

References EditorLineRemove(), and m_LinkedSceneObjects.

Referenced by PluginBase::UnlinkSceneObjects().

Field Documentation

◆ COLOR_OBJ_BBOX_NORMAL

const int COLOR_OBJ_BBOX_NORMAL = 0x00000000
staticprivate

Referenced by EditorShapeDeselect().

◆ COLOR_OBJ_BBOX_SELECT

const int COLOR_OBJ_BBOX_SELECT = 0x1f007C00
staticprivate

Referenced by EditorShapeSelect().

◆ m_DebugShapeBBox

protected Shape m_DebugShapeBBox
private

Referenced by EditorShapeAdd(), EditorShapeRemove(), EditorShapeSetColor(), and EditorShapeUpdatePos().

◆ m_InitScript

protected string m_InitScript
private

Referenced by GetInitScript(), and SetInitScript().

◆ m_LinkedSceneObjects

protected ref array<SceneObject> m_LinkedSceneObjects
private

Referenced by GetLinkedSceneObject(), GetLinkedSceneObjects(), GetLinkedSceneObjectsCount(), Init(), IsLinkedWithSceneObject(), LinkSceneObject(), UnlinkSceneObject(), and ~SceneObject().

◆ m_LinkedSceneObjectsIndices

ref array<int> m_LinkedSceneObjectsIndices
private

Referenced by Init(), PluginConfigHandler::LoadSceneObjects(), and PluginBase::RestoreSceneObjectsLinks().

◆ m_LinkedSceneObjectsShapes

protected ref map<SceneObject, Shape> m_LinkedSceneObjectsShapes
private

Referenced by EditorLineAdd(), EditorLineRemove(), and Init().

◆ m_ObjectName

protected string m_ObjectName
private

Referenced by GetName(), and Init().

◆ m_ObjectNameOrigin

protected string m_ObjectNameOrigin
private

Referenced by GetSize(), and Init().

◆ m_ObjectPtr

protected EntityAI m_ObjectPtr
private

Referenced by AddRotation(), GetHealth(), GetMaxHealth(), GetObject(), GetPosition(), GetPositionAsString(), GetRotation(), GetTypeName(), LinkEntityAI(), PlaceOnSurface(), SetHealth(), SetPosition(), SetRotation(), and ~SceneObject().

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