VicinityObjects Class Reference

objects in vicinity - extended with secondary object which is parent of that Object More...

Private Member Functions
void	VicinityObjects ()
void	StoreVicinityObject (Object object, Object parent=null)
	stores VicinityObject to Hashmap - for storing of parent/child relationship
void	TransformToVicinityObjects (array< Object > objects)
	transform simple array of Objects to VicinityObjects hashmap
void	ClearVicinityObjects ()
array< Object >	GetVicinityObjects ()
	return simple array of Objects in Vicinity
array< Object >	GetRawVicinityObjects ()
	return simple array of Objects in Vicinity
Object	GetObject (int i)
	returns VicinityObjects Key
Object	GetParent (int i)
	returns VicinityObjects Element
int	Count ()
void	Remove (Object object)
void	Remove (array< Object > objects)

Private Attributes
ref map< Object, Object >	m_VicinityObjects

Detailed Description

objects in vicinity - extended with secondary object which is parent of that Object

Definition at line 2 of file ActionTargets.c.

Constructor & Destructor Documentation

VicinityObjects()

void VicinityObjects::VicinityObjects ( )

inlineprivate

Definition at line 6 of file ActionTargets.c.

  {
    m_VicinityObjects = new map<Object, Object>;
  }

References m_VicinityObjects.

Member Function Documentation

ClearVicinityObjects()

void VicinityObjects::ClearVicinityObjects ( )

inlineprivate

Definition at line 46 of file ActionTargets.c.

  {
    m_VicinityObjects.Clear();
  }

References m_VicinityObjects.

Count()

int VicinityObjects::Count ( )

inlineprivate

Definition at line 90 of file ActionTargets.c.

  {
    return m_VicinityObjects.Count();
  }

References m_VicinityObjects.

GetObject()

Object VicinityObjects::GetObject ( int i )

inlineprivate

returns VicinityObjects Key

Definition at line 79 of file ActionTargets.c.

  {
    return m_VicinityObjects.GetKey(i);
  }

References m_VicinityObjects.

GetParent()

Object VicinityObjects::GetParent ( int i )

inlineprivate

returns VicinityObjects Element

Definition at line 85 of file ActionTargets.c.

  {
    return m_VicinityObjects.GetElement(i);
  }

References m_VicinityObjects.

GetRawVicinityObjects()

array< Object > VicinityObjects::GetRawVicinityObjects ( )

inlineprivate

return simple array of Objects in Vicinity

Definition at line 69 of file ActionTargets.c.

  {
    ref array<Object> vicinityObjects = new array<Object>;
    for (int i = 0; i < m_VicinityObjects.Count(); i++)
      vicinityObjects.Insert(GetObject(i));
 
    return vicinityObjects;
  }

References GetObject(), and m_VicinityObjects.

GetVicinityObjects()

array< Object > VicinityObjects::GetVicinityObjects ( )

inlineprivate

return simple array of Objects in Vicinity

filters out non-takeable items (won't be shown in vicinity)

Definition at line 52 of file ActionTargets.c.

  {
    ref array<Object> vicinityObjects = new array<Object>;
    for (int i = 0; i < m_VicinityObjects.Count(); i++)
    {
      ItemBase ib = ItemBase.Cast(GetObject(i));
      if (ib && !ib.IsTakeable())
        continue;
 
      vicinityObjects.Insert(GetObject(i));
    }
 
    return vicinityObjects;
  }

References GetObject(), and m_VicinityObjects.

Remove() [1/2]

void VicinityObjects::Remove ( array< Object > objects )

inlineprivate

Definition at line 100 of file ActionTargets.c.

  {
    for (int i = 0; i < objects.Count(); i++)
      m_VicinityObjects.Remove(objects[i]);
  }

References m_VicinityObjects.

Remove() [2/2]

void VicinityObjects::Remove ( Object object )

inlineprivate

Definition at line 95 of file ActionTargets.c.

  {
    m_VicinityObjects.Remove(object);
  }

References m_VicinityObjects.

StoreVicinityObject()

void VicinityObjects::StoreVicinityObject ( Object object, Object parent = null )

inlineprivate

stores VicinityObject to Hashmap - for storing of parent/child relationship

completely remove items that are being placed or are holograms

ignores plain objects

init of VicinityObjects - object, parent(if exists)

Definition at line 12 of file ActionTargets.c.

  {
    ItemBase ib = ItemBase.Cast(object);
    if (ib && (ib.IsBeingPlaced() || ib.IsHologram()))
      return;
 
    /*if(object && object.IsPlainObject())
      {
      Print("ERROR: VicinityObjects | StoreVicinityObject | IsPlainObject check fail");
      return;
      }*/
 
    if (!m_VicinityObjects.Contains(object))
    {
      m_VicinityObjects.Set(object, parent);
    }
  }

References m_VicinityObjects.

Referenced by TransformToVicinityObjects().

TransformToVicinityObjects()

void VicinityObjects::TransformToVicinityObjects ( array< Object > objects )

inlineprivate

transform simple array of Objects to VicinityObjects hashmap

Definition at line 34 of file ActionTargets.c.

  {
    for (int i = 0; i < objects.Count(); i++)
    {
      if (objects[i].GetType() != "" && objects[i].CanBeActionTarget())
      {
        StoreVicinityObject(objects[i]);
        //Print("storing, 2nd pass: " + objects[i]);
      }
    }
  }

References CanBeActionTarget(), GetType(), and StoreVicinityObject().

Member Data Documentation

m_VicinityObjects

ref map<Object, Object> VicinityObjects::m_VicinityObjects

private

Definition at line 4 of file ActionTargets.c.

Referenced by ClearVicinityObjects(), Count(), GetObject(), GetParent(), GetRawVicinityObjects(), GetVicinityObjects(), Remove(), Remove(), StoreVicinityObject(), and VicinityObjects().

---

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

• scripts/4_World/Classes/UserActionsComponent/ActionTargets.c