Arma Reforger Script API
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
SCR_RenderedEditableEntityFilter Interface Reference
Inheritance diagram for SCR_RenderedEditableEntityFilter:
[legend]

Public Member Functions

float GetCameraDisCoef ()
 
override void EOnEditorFrame (float timeSlice)
 Every frame while the editor is opened.
 
bool IsNear (SCR_EditableEntityComponent entity)
 
override void EOnEditorActivate ()
 When the editor is opened (before cached array is intialized)
 
override void EOnEditorDeactivate ()
 When the editor is closed (after cached array is destroyed)
 
override bool CanAdd (SCR_EditableEntityComponent entity)
 Check if the entity meets condition for this entity state.
 
void SCR_RenderedEditableEntityFilter ()
 
- Public Member Functions inherited from SCR_BaseEditableEntityFilter
void InitVariables (SCR_EntitiesManagerEditorComponent manager, SCR_BaseEditableEntityFilter predecessor)
 
EEditableEntityState GetState ()
 Get entity state this component is managing.
 
string GetStateName ()
 Get name of the entity state this component is managing.
 
EEditableEntityState GetPredecessorState ()
 Get entity state of the component which preceeds this one.
 
SCR_BaseEditableEntityFilter GetPredecessor ()
 Get component which preceeds this one.
 
EEditableEntityFilterAutoAdd GetAutoAdd ()
 Check if entities can be registered automatically based on predecessor component.
 
int GetEntities (out set< SCR_EditableEntityComponent > entities, bool includeChildren=false, bool evaluate=true)
 Get entities managed by this filter.
 
int GetEntitiesCount ()
 Get number of cached entities.
 
bool IsEmpty ()
 Check if the filter contains any entities.
 
SCR_EditableEntityComponent GetFirstEntity ()
 Get the first cached entity.
 
bool Contains (SCR_EditableEntityComponent entity)
 Check if given entity is among cached entities.
 
ScriptInvokerBase< SCR_BaseEditableEntityFilter_OnChange > GetOnChanged ()
 Get script invoker which is triggered every time some entities are added or removed.
 
void Log ()
 Print all cached entities to the log.
 
void OnFrameBase (float timeSlice)
 
void OnActivateBase ()
 
void OnDeactivateBase ()
 
bool Add (SCR_EditableEntityComponent entityInsert, bool onlyDirect=false)
 Register given entity.
 
bool Add (notnull set< SCR_EditableEntityComponent > entitiesInsert, bool onlyDirect=false)
 Register multiple entities.
 
bool Remove (SCR_EditableEntityComponent entityRemove, bool onlyDirect=false)
 Unregister given entity.
 
bool Remove (notnull set< SCR_EditableEntityComponent > entitiesRemove, bool onlyDirect=false)
 Unregister multiple entities.
 
bool Toggle (SCR_EditableEntityComponent entity, bool onlyDirect=false)
 Toggle state of given entity, i.e., register it if it's unregistered and unregister it if it's registered.
 
bool Toggle (notnull set< SCR_EditableEntityComponent > entities, bool onlyDirect=false)
 Toggle state of given entities, i.e., register them if they're unregistered and unregister them if they're registered.
 
bool Replace (SCR_EditableEntityComponent entityInsert, bool onlyDirect=false, bool keepExisting=false)
 Replace cached array with given entity.
 
bool Replace (set< SCR_EditableEntityComponent > entitiesInsert, bool onlyDirect=false, bool keepExisting=false)
 Replace cached array with entities.
 
bool Set (SCR_EditableEntityComponent entityInsert, SCR_EditableEntityComponent entityRemove, bool onlyDirect=false)
 Register and unregister entities in one go.
 
bool Set (set< SCR_EditableEntityComponent > entitiesInsert, set< SCR_EditableEntityComponent > entitiesRemove, bool onlyDirect=false)
 Register and unregister entities in one go.
 
bool SetFromPredecessor ()
 Fill the list from the predecessor.
 
bool Validate (SCR_EditableEntityComponent entity)
 If the entity is added to the filter, check if its condition is still valid.
 
bool Clear ()
 Clear cached array.
 
bool Copy (SCR_BaseEditableEntityFilter filter, bool onlyDirect=false)
 Copy the list of registered entities from another filter.
 

Protected Member Functions

void CacheCameraPos ()
 
void OnEntityRefreshed (SCR_EditableEntityComponent entity)
 
- Protected Member Functions inherited from SCR_BaseEditableEntityFilter
int GetEntitiesPointer (out set< SCR_EditableEntityComponent > entities)
 
SCR_EditableEntityComponent GetParentBelowCurrentLayer (SCR_EditableEntityComponent entity)
 
sealed SCR_EntitiesManagerEditorComponent GetManager ()
 
sealed SCR_EditableEntityCore GetCore ()
 
void InitEntities ()
 
void OnChanged (set< SCR_EditableEntityComponent > entitiesInsert, set< SCR_EditableEntityComponent > entitiesRemove)
 
void OnChanged ()
 
sealed void InsertChildren (out set< SCR_EditableEntityComponent > entities)
 
sealed bool AddToArray (SCR_EditableEntityComponent entity, out bool isChange, bool returnWhenExists=false)
 
sealed bool RemoveFromArray (SCR_EditableEntityComponent entity, out bool isChange)
 

Protected Attributes

float m_HeightMin
 
float m_HeightMax
 
float m_CoefMin
 
float m_CoefMax
 
float m_fRefreshDuration
 
float m_fTeleportDistance
 
BaseWorld m_World
 
vector m_vCameraPos
 
float m_fCameraDisCoef = 1
 
float m_fDelay
 
SCR_LayersEditorComponent m_LayersManager
 
ref set< SCR_EditableEntityComponentm_aCacheEntities
 
float m_iBatchSize
 
int m_iBatchCount
 
float m_iBatchIndex
 
bool m_bInstantRefresh
 
- Protected Attributes inherited from SCR_BaseEditableEntityFilter
EEditableEntityState m_State
 
EEditableEntityState m_PredecessorState
 
EEditableEntityFilterAutoAdd m_bAutoAdd
 
bool m_bSkipIgnored
 
bool m_bOnlyInteractive
 
SCR_EditableEntityCore m_Core
 
SCR_EntitiesManagerEditorComponent m_Manager
 
SCR_BaseEditableEntityFilter m_Predecessor
 
ref set< SCR_EditableEntityComponentm_Entities
 
int m_iEntitiesCount
 
string m_sStateName = "N/A"
 
ref ScriptInvokerBase< SCR_BaseEditableEntityFilter_OnChange > m_OnChange = new ScriptInvokerBase<SCR_BaseEditableEntityFilter_OnChange>()
 

Additional Inherited Members

- Static Public Member Functions inherited from SCR_BaseEditableEntityFilter
static SCR_BaseEditableEntityFilter GetInstance (EEditableEntityState state, bool showError=false)
 Get current filter instance.
 
static SCR_EditableEntityComponent GetFirstEntity (EEditableEntityState state)
 Get first entity of given filter type.
 
static int GetEnititiesStatic (out set< SCR_EditableEntityComponent > entities, EEditableEntityState state, bool includeChildren=false, bool evaluate=true)
 Get first entity of given filter type.
 

Detailed Description

Examples
d:/jenkins/workspace/ar_data_branches_stable_1.2.1/A4Data/scripts/Game/Editor/Containers/EditableEntityFilters/SCR_RenderedEditableEntityFilter.c.

Constructor & Destructor Documentation

◆ SCR_RenderedEditableEntityFilter()

void SCR_RenderedEditableEntityFilter.SCR_RenderedEditableEntityFilter ( )

Member Function Documentation

◆ CacheCameraPos()

void SCR_RenderedEditableEntityFilter.CacheCameraPos ( )
protected

◆ CanAdd()

override bool SCR_RenderedEditableEntityFilter.CanAdd ( SCR_EditableEntityComponent  entity)

Check if the entity meets condition for this entity state.

Parameters
entityEditable entity
Returns
True if the condition is met

Implements SCR_BaseEditableEntityFilter.

Examples
d:/jenkins/workspace/ar_data_branches_stable_1.2.1/A4Data/scripts/Game/Editor/Containers/EditableEntityFilters/SCR_RenderedEditableEntityFilter.c.

◆ EOnEditorActivate()

override void SCR_RenderedEditableEntityFilter.EOnEditorActivate ( )

◆ EOnEditorDeactivate()

override void SCR_RenderedEditableEntityFilter.EOnEditorDeactivate ( )

◆ EOnEditorFrame()

override void SCR_RenderedEditableEntityFilter.EOnEditorFrame ( float  timeSlice)

◆ GetCameraDisCoef()

float SCR_RenderedEditableEntityFilter.GetCameraDisCoef ( )

◆ IsNear()

bool SCR_RenderedEditableEntityFilter.IsNear ( SCR_EditableEntityComponent  entity)

◆ OnEntityRefreshed()

void SCR_RenderedEditableEntityFilter.OnEntityRefreshed ( SCR_EditableEntityComponent  entity)
protected

Member Data Documentation

◆ m_aCacheEntities

ref set<SCR_EditableEntityComponent> SCR_RenderedEditableEntityFilter.m_aCacheEntities
protected

◆ m_bInstantRefresh

bool SCR_RenderedEditableEntityFilter.m_bInstantRefresh
protected

◆ m_CoefMax

float SCR_RenderedEditableEntityFilter.m_CoefMax
protected

◆ m_CoefMin

float SCR_RenderedEditableEntityFilter.m_CoefMin
protected

◆ m_fCameraDisCoef

float SCR_RenderedEditableEntityFilter.m_fCameraDisCoef = 1
protected

◆ m_fDelay

float SCR_RenderedEditableEntityFilter.m_fDelay
protected

◆ m_fRefreshDuration

float SCR_RenderedEditableEntityFilter.m_fRefreshDuration
protected

◆ m_fTeleportDistance

float SCR_RenderedEditableEntityFilter.m_fTeleportDistance
protected

◆ m_HeightMax

float SCR_RenderedEditableEntityFilter.m_HeightMax
protected

◆ m_HeightMin

float SCR_RenderedEditableEntityFilter.m_HeightMin
protected

◆ m_iBatchCount

int SCR_RenderedEditableEntityFilter.m_iBatchCount
protected

◆ m_iBatchIndex

float SCR_RenderedEditableEntityFilter.m_iBatchIndex
protected

◆ m_iBatchSize

float SCR_RenderedEditableEntityFilter.m_iBatchSize
protected

◆ m_LayersManager

SCR_LayersEditorComponent SCR_RenderedEditableEntityFilter.m_LayersManager
protected

◆ m_vCameraPos

vector SCR_RenderedEditableEntityFilter.m_vCameraPos
protected

◆ m_World

BaseWorld SCR_RenderedEditableEntityFilter.m_World
protected

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