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

Public Member Functions

int GetGroupType ()
 Getter for type of groups that are intended to be spawned with this slot.
 
array< ref SCR_QRFSpawnSafeZoneGetSpawnSafeZones ()
 Getter for an array of configs defining group types and their respective distances to nearest observers.
 
void SetObjectToSpawn (ResourceName newObjectPrefab)
 
int GetNumberOfExistingWaypoints ()
 Getter that returns number of existing waypoints for the entity that was the last one to be spawned.
 
void ClearWaypoints (bool deleteWaypointEntities=false)
 Clears both array of queued waypoint configs and waypoints entities with option to delete them.
 
AIWaypoint CreateWaypoint (vector position, ResourceName wpPrefab)
 Creation of waypoint entity and storing of waypoint information for dynamic respawn of this slot.
 
override void Init (SCR_ScenarioFrameworkArea area=null, SCR_ScenarioFrameworkEActivationType activation=SCR_ScenarioFrameworkEActivationType.SAME_AS_PARENT)
 
- Public Member Functions inherited from SCR_ScenarioFrameworkSlotAI
void SetAIPrefabsForRemoval (array< ResourceName > arrayForRemoval)
 
array< ResourceName > GetAIPrefabsForRemoval ()
 
override void RestoreToDefault (bool includeChildren=false, bool reinitAfterRestoration=false)
 
override void DynamicDespawn (SCR_ScenarioFrameworkLayerBase layer)
 
override void Init (SCR_ScenarioFrameworkArea area=null, SCR_ScenarioFrameworkEActivationType activation=SCR_ScenarioFrameworkEActivationType.SAME_AS_PARENT)
 
override void AfterAllChildrenSpawned (SCR_ScenarioFrameworkLayerBase layer)
 
void AfterAllAgentsSpawned ()
 
void ActivateAI ()
 
void OnAgentAdded (AIAgent child)
 
void DecreaseAIGroupMemberCount (SCR_AIGroup group, AIAgent agent)
 
void SCR_ScenarioFrameworkSlotAI (IEntityComponentSource src, IEntity ent, IEntity parent)
 
- Public Member Functions inherited from SCR_ScenarioFrameworkSlotBase
void OnObjectDamage (EDamageState state)
 
void OnInventoryParentChanged (InventoryStorageSlot oldSlot, InventoryStorageSlot newSlot)
 
void OnCompartmentEntered (IEntity vehicle, BaseCompartmentManagerComponent mgr, IEntity occupant, int managerId, int slotID)
 
string GetOverridenObjectDisplayName ()
 
void SetOverridenObjectDisplayName (string name)
 
string GetSpawnedEntityDisplayName ()
 
SCR_ScenarioFrameworkArea GetAreaWB ()
 Get the Layer Task which is parent of this Slot.
 
string GetSpawnedObjectName ()
 
ResourceName GetObjectToSpawn ()
 
ResourceName GetRandomlySpawnedObject ()
 
void SetRandomlySpawnedObject (ResourceName name)
 
override void RestoreToDefault (bool includeChildren=false, bool reinitAfterRestoration=false)
 
override void DynamicDespawn (SCR_ScenarioFrameworkLayerBase layer)
 
override bool InitAlreadyHappened ()
 
bool InitRepeatableSpawn ()
 
bool InitEntitySpawnCheck ()
 
bool InitEntitySpawn ()
 
override bool InitOtherThings ()
 For situations where some other logic is to be appended in these checks and is to be performed before FinishInit.
 
override void FinishInit ()
 
override void Init (SCR_ScenarioFrameworkArea area=null, SCR_ScenarioFrameworkEActivationType activation=SCR_ScenarioFrameworkEActivationType.SAME_AS_PARENT)
 
override void AfterAllChildrenSpawned (SCR_ScenarioFrameworkLayerBase layer)
 
ScriptInvoker GetOnAllAreasInitiatedInvoker ()
 
override void SpawnChildren (bool previouslyRandomized=false)
 
ResourceName GetRandomAsset (out ResourceName prefab)
 
IEntity SpawnAsset ()
 
override void _WB_AfterWorldUpdate (IEntity owner, float timeSlice)
 
override void _WB_SetTransform (IEntity owner, inout vector mat[4], IEntitySource src)
 
void SpawnEntityPreview (IEntity owner, Resource resource)
 
override void _WB_OnInit (IEntity owner, inout vector mat[4], IEntitySource src)
 
override bool _WB_OnKeyChanged (IEntity owner, BaseContainer src, string key, BaseContainerList ownerContainers, IEntity parent)
 
void SCR_ScenarioFrameworkSlotBase (IEntityComponentSource src, IEntity ent, IEntity parent)
 
void ~SCR_ScenarioFrameworkSlotBase ()
 
- Public Member Functions inherited from SCR_ScenarioFrameworkLayerBase
string GetName ()
 
void SetEntity (IEntity entity)
 
bool GetIsTerminated ()
 
void SetIsTerminated (bool state)
 
void SetRandomlySpawnedChildren (array< string > randomlySpawnedChildren)
 
array< SCR_ScenarioFrameworkLayerBaseGetRandomlySpawnedChildren ()
 
int GetPlayersCount (FactionKey factionName="")
 
int GetMaxPlayersForGameMode (FactionKey factionName="")
 
SCR_ScenarioFrameworkArea GetParentArea ()
 Get parent area the object is nested into.
 
SCR_ScenarioFrameworkLayerTask GetLayerTask ()
 Get layer task the object is nested into if there is some.
 
SCR_ScenarioFrameworkSlotTask GetSlotTask (array< SCR_ScenarioFrameworkLayerBase > aLayers)
 Get SlotTask from array of LayerBases if there is any.
 
void SetParentLayer (SCR_ScenarioFrameworkLayerBase parentLayer)
 
SCR_ScenarioFrameworkLayerBase GetParentLayer ()
 
SCR_EScenarioFrameworkSpawnChildrenType GetSpawnChildrenType ()
 
bool GetEnableRepeatedSpawn ()
 
void SetEnableRepeatedSpawn (bool value)
 
SCR_ScenarioFrameworkEActivationType GetActivationType ()
 
void SetActivationType (SCR_ScenarioFrameworkEActivationType activationType)
 
bool GetIsInitiated ()
 
bool GetDynamicDespawnExcluded ()
 
void SetDynamicDespawnExcluded (bool excluded)
 
array< IEntity > GetSpawnedEntities ()
 
array< SCR_ScenarioFrameworkLayerBaseGetChildrenEntities ()
 
SCR_ScenarioFrameworkLayerBase GetRandomChildren ()
 Returns the random Slot.
 
void GetChildren (out array< SCR_ScenarioFrameworkLayerBase > children)
 Goes through the hierarchy and returns all the child entities of LayerBase type.
 
void GetLogics (out array< SCR_ScenarioFrameworkLogic > logics)
 
array< SCR_ScenarioFrameworkLogicGetSpawnedLogics ()
 
array< ref SCR_ScenarioFrameworkPluginGetSpawnedPlugins ()
 
int GetRepeatedSpawnNumber ()
 
void SetRepeatedSpawnNumber (int number)
 
ScriptInvokerScenarioFrameworkLayer GetOnAllChildrenSpawned ()
 
void InvokeAllChildrenSpawned ()
 
void CheckAllChildrenSpawned (SCR_ScenarioFrameworkLayerBase layer=null)
 
void SpawnChildren (bool previouslyRandomized=false)
 
void SpawnPreviouslyRandomizedChildren ()
 
void SpawnRandomOneChild (bool previouslyRandomized=false)
 
void SpawnRandomMultipleChildren (bool previouslyRandomized=false)
 
void InitChild (SCR_ScenarioFrameworkLayerBase child)
 
IEntity GetSpawnedEntity ()
 
void RestoreToDefault (bool includeChildren=false, bool reinitAfterRestoration=false)
 
void DynamicDespawn (SCR_ScenarioFrameworkLayerBase layer)
 
void DynamicReinit ()
 
bool InitAlreadyHappened ()
 
bool InitParentLayer ()
 
bool InitNotTerminated ()
 
bool InitDynDespawnAndActivation (SCR_ScenarioFrameworkEActivationType activation)
 
bool InitActivationConditions ()
 
bool InitArea (SCR_ScenarioFrameworkArea area)
 
void InitFactionSettings ()
 Handles inheritance of faction settings from parents.
 
bool InitOtherThings ()
 For situations where some other logic is to be appended in these checks and is to be performed before FinishInit.
 
void FinishInitChildrenInsert ()
 For situations where some other logic is needed to be performed before or after this Insert.
 
void FinishInit ()
 
void Init (SCR_ScenarioFrameworkArea area=null, SCR_ScenarioFrameworkEActivationType activation=SCR_ScenarioFrameworkEActivationType.SAME_AS_PARENT)
 
void AfterAllChildrenSpawned (SCR_ScenarioFrameworkLayerBase layer)
 
override void EOnFrame (IEntity owner, float timeSlice)
 
override void OnPostInit (IEntity owner)
 
void SetDebugShapeSize (float fSize)
 
override void _WB_OnCreate (IEntity owner, IEntitySource src)
 
void RenameOwnerEntity (IEntity owner)
 
void SCR_ScenarioFrameworkLayerBase (IEntityComponentSource src, IEntity ent, IEntity parent)
 
void ~SCR_ScenarioFrameworkLayerBase ()
 

Protected Member Functions

AIWaypoint SpawnWaypoint (vector position, ResourceName wpPrefab)
 Creation and storage of waypoint entity.
 
void ProcessQueuedWaypoints (SCR_ScenarioFrameworkLayerBase layer)
 Creation and assignment of queued waypoints after this slot is dynamically respawned.
 
override void SetWaypointToAI (SCR_ScenarioFrameworkLayerBase layer)
 
- Protected Member Functions inherited from SCR_ScenarioFrameworkSlotAI
void InitGroupComponents ()
 
void InitWaypoints ()
 
void CheckWaypointsAfterInit (SCR_ScenarioFrameworkLayerBase layer)
 
void ProcessWaypoints (SCR_ScenarioFrameworkLayerBase layer)
 
void SetWaypointToAI (SCR_ScenarioFrameworkLayerBase layer)
 
AIWaypoint CreateDefaultWaypoint ()
 
bool CreateAIGroup ()
 
- Protected Member Functions inherited from SCR_ScenarioFrameworkSlotBase
void QueryObjectsInRange (float fRange=2.5)
 Get objects of type defined in m_sObjectToSpawn in the range.
 
bool GetEntity (notnull IEntity entity)
 Get object of type defined in m_sObjectToSpawn.
 
- Protected Member Functions inherited from SCR_ScenarioFrameworkLayerBase
void SetFactionKey (FactionKey factionKey)
 
FactionKey GetFactionKey ()
 
void RepeatedSpawn ()
 
void RepeatedSpawnCalled ()
 
void ActivateLogic ()
 
void DrawDebugShape (bool draw)
 

Protected Attributes

int m_iGroupType
 
ref array< ref SCR_QRFSpawnSafeZonem_aSCR_QRFSpawnSafeZone
 
ref array< ref SCR_QRFWaypointConfigm_aQRFWaypoints = {}
 
- Protected Attributes inherited from SCR_ScenarioFrameworkSlotBase
IEntity m_PreviewEntity
 

Additional Inherited Members

- Public Attributes inherited from SCR_ScenarioFrameworkSlotAI
ref SCR_ScenarioFrameworkWaypointSet m_WaypointSet
 
bool m_bSpawnAIOnWPPos
 
ResourceName m_sWPToSpawn
 
bool m_bBalanceOnPlayersCount
 
int m_iMinUnitsInGroup
 
SCR_EAIGroupFormation m_eAIGroupFormation
 
EAISkill m_eAISkill
 
EAICombatType m_eAICombatType
 
float m_fPerceptionFactor
 
ResourceName m_sGroupPrefab
 
ref array< AIWaypoint > m_aWaypoints = {}
 
SCR_AIGroup m_AIGroup
 
ref array< ResourceName > m_aAIPrefabsForRemoval = {}
 
ref array< SCR_ScenarioFrameworkSlotWaypointm_aSlotWaypoints = {}
 
int m_iCurrentlySpawnedWaypoints
 
bool m_bWaypointsInitialized
 
- Public Attributes inherited from SCR_ScenarioFrameworkSlotBase
ResourceName m_sObjectToSpawn
 
string m_sID
 
bool m_bUseExistingWorldAsset
 
string m_sOverrideObjectDisplayName
 
bool m_bCanBeGarbageCollected
 
bool m_bRandomizePerFaction
 
EEntityCatalogType m_eEntityCatalogType
 
ref array< EEditableEntityLabel > m_aIncludedEditableEntityLabels
 
ref array< EEditableEntityLabel > m_aExcludedEditableEntityLabels
 
bool m_bIncludeOnlySelectedLabels
 
bool m_bIgnoreOrientChildrenToTerrain
 
bool m_bSelected = false
 
ref EntitySpawnParams m_SpawnParams = new EntitySpawnParams()
 
vector m_Size
 
ResourceName m_sRandomlySpawnedObject
 
vector m_vPosition
 
bool m_bShowDebugShapesInWorkbench
 
- Public Attributes inherited from SCR_ScenarioFrameworkLayerBase
SCR_EScenarioFrameworkSpawnChildrenType m_SpawnChildren
 
FactionKey m_sFactionKey
 
int m_iRandomPercent
 
bool m_bEnableRepeatedSpawn
 
int m_iRepeatedSpawnNumber
 
float m_fRepeatedSpawnTimer
 
bool m_bShowDebugShapesDuringRuntime
 
SCR_ScenarioFrameworkEActivationType m_eActivationType
 
ref array< ref SCR_ScenarioFrameworkActivationConditionBasem_aActivationConditions
 
ref array< ref SCR_ScenarioFrameworkActionBasem_aActivationActions
 
bool m_bExcludeFromDynamicDespawn
 
ref array< ref SCR_ScenarioFrameworkPluginm_aPlugins
 
ref array< SCR_ScenarioFrameworkLayerBasem_aChildren = {}
 
ref array< SCR_ScenarioFrameworkLayerBasem_aRandomlySpawnedChildren = {}
 
ref array< SCR_ScenarioFrameworkLogicm_aLogic = {}
 
ref ScriptInvokerBase< ScriptInvokerScenarioFrameworkLayerMethod > m_OnAllChildrenSpawned
 
ref array< IEntity > m_aSpawnedEntities = {}
 
IEntity m_Entity
 
SCR_ScenarioFrameworkArea m_Area
 
SCR_ScenarioFrameworkLayerBase m_ParentLayer
 
float m_fDebugShapeRadius = 0.25
 
WorldTimestamp m_fRepeatSpawnTimeStart
 
WorldTimestamp m_fRepeatSpawnTimeEnd
 
int m_iDebugShapeColor = ARGB(32, 0xFF, 0x00, 0x12)
 
int m_iCurrentlySpawnedChildren
 
int m_iSupposedSpawnedChildren
 
bool m_bInitiated
 
bool m_bIsRegistered
 
bool m_bDynamicallyDespawned
 
bool m_bIsTerminated
 
int m_iRepeatedSpawnNumberDefault = m_iRepeatedSpawnNumber
 
SCR_ScenarioFrameworkEActivationType m_eActivationTypeDefault = m_eActivationType
 
- Static Public Attributes inherited from SCR_ScenarioFrameworkLayerBase
static const int SPAWN_DELAY = 200
 

Member Function Documentation

◆ ClearWaypoints()

void SCR_ScenarioFrameworkQRFSlotAI.ClearWaypoints ( bool  deleteWaypointEntities = false)

Clears both array of queued waypoint configs and waypoints entities with option to delete them.

◆ CreateWaypoint()

AIWaypoint SCR_ScenarioFrameworkQRFSlotAI.CreateWaypoint ( vector  position,
ResourceName  wpPrefab 
)

Creation of waypoint entity and storing of waypoint information for dynamic respawn of this slot.

◆ GetGroupType()

int SCR_ScenarioFrameworkQRFSlotAI.GetGroupType ( )

Getter for type of groups that are intended to be spawned with this slot.

◆ GetNumberOfExistingWaypoints()

int SCR_ScenarioFrameworkQRFSlotAI.GetNumberOfExistingWaypoints ( )

Getter that returns number of existing waypoints for the entity that was the last one to be spawned.

◆ GetSpawnSafeZones()

array< ref SCR_QRFSpawnSafeZone > SCR_ScenarioFrameworkQRFSlotAI.GetSpawnSafeZones ( )

Getter for an array of configs defining group types and their respective distances to nearest observers.

◆ Init()

override void SCR_ScenarioFrameworkQRFSlotAI.Init ( SCR_ScenarioFrameworkArea  area = null,
SCR_ScenarioFrameworkEActivationType  activation = SCR_ScenarioFrameworkEActivationType::SAME_AS_PARENT 
)
Parameters
[in]area
[in]activation

Implements SCR_ScenarioFrameworkSlotAI.

◆ ProcessQueuedWaypoints()

void SCR_ScenarioFrameworkQRFSlotAI.ProcessQueuedWaypoints ( SCR_ScenarioFrameworkLayerBase  layer)
protected

Creation and assignment of queued waypoints after this slot is dynamically respawned.

◆ SetObjectToSpawn()

void SCR_ScenarioFrameworkQRFSlotAI.SetObjectToSpawn ( ResourceName  newObjectPrefab)

◆ SetWaypointToAI()

override void SCR_ScenarioFrameworkQRFSlotAI.SetWaypointToAI ( SCR_ScenarioFrameworkLayerBase  layer)
protected

◆ SpawnWaypoint()

AIWaypoint SCR_ScenarioFrameworkQRFSlotAI.SpawnWaypoint ( vector  position,
ResourceName  wpPrefab 
)
protected

Creation and storage of waypoint entity.

Member Data Documentation

◆ m_aQRFWaypoints

ref array<ref SCR_QRFWaypointConfig> SCR_ScenarioFrameworkQRFSlotAI.m_aQRFWaypoints = {}
protected

◆ m_aSCR_QRFSpawnSafeZone

ref array<ref SCR_QRFSpawnSafeZone> SCR_ScenarioFrameworkQRFSlotAI.m_aSCR_QRFSpawnSafeZone
protected

◆ m_iGroupType

int SCR_ScenarioFrameworkQRFSlotAI.m_iGroupType
protected

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