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

Public Member Functions

ResourceName GetSlotPrefab ()
 Get prefab of the slot to which the composition fits.
 
bool CanOrientChildrenToTerrain ()
 Check if composition children should be snapped and oriented to terrain.
 
void OrientToTerrain ()
 Orient composition and its children to terrain.
 
override void EOnInit (IEntity owner)
 
override void OnPostInit (IEntity owner)
 
override array< ref WB_UIMenuItem > _WB_GetContextMenuItems (IEntity owner)
 
override void _WB_OnContextMenu (IEntity owner, int id)
 

Static Public Member Functions

static void IgnoreOrientChildrenToTerrain ()
 Bool to disable the terrain snapping for next spawned composition.
 
static bool _WB_ConfigureComposition (WorldEditorAPI api, IEntitySource entitySource, bool isRoot=true, bool delayed=false)
 

Protected Member Functions

void SetChildTransform (IEntity owner, BaseWorld world)
 

Protected Attributes

GenericEntity m_Owner
 

Static Protected Attributes

static bool m_bIgnoreOrientChildrenToTerrain
 

Detailed Description

Entity composition which is supposed to fit into a slot

Member Function Documentation

◆ _WB_ConfigureComposition()

static bool SCR_SlotCompositionComponent._WB_ConfigureComposition ( WorldEditorAPI  api,
IEntitySource  entitySource,
bool  isRoot = true,
bool  delayed = false 
)
static
Parameters
[in]api
[in]entitySource
[in]isRoot
[in]delayed
Returns

◆ _WB_GetContextMenuItems()

override array< ref WB_UIMenuItem > SCR_SlotCompositionComponent._WB_GetContextMenuItems ( IEntity  owner)

◆ _WB_OnContextMenu()

override void SCR_SlotCompositionComponent._WB_OnContextMenu ( IEntity  owner,
int  id 
)

◆ CanOrientChildrenToTerrain()

bool SCR_SlotCompositionComponent.CanOrientChildrenToTerrain ( )

Check if composition children should be snapped and oriented to terrain.

Returns
True if children are affected

◆ EOnInit()

override void SCR_SlotCompositionComponent.EOnInit ( IEntity  owner)

◆ GetSlotPrefab()

ResourceName SCR_SlotCompositionComponent.GetSlotPrefab ( )

Get prefab of the slot to which the composition fits.

Returns
Slot prefab

◆ IgnoreOrientChildrenToTerrain()

static void SCR_SlotCompositionComponent.IgnoreOrientChildrenToTerrain ( )
static

Bool to disable the terrain snapping for next spawned composition.

◆ OnPostInit()

override void SCR_SlotCompositionComponent.OnPostInit ( IEntity  owner)

◆ OrientToTerrain()

void SCR_SlotCompositionComponent.OrientToTerrain ( )

Orient composition and its children to terrain.

Applied only if "Can Orient Children To Terrain" attribute is enabled.

◆ SetChildTransform()

void SCR_SlotCompositionComponent.SetChildTransform ( IEntity  owner,
BaseWorld  world 
)
protected

Member Data Documentation

◆ m_bIgnoreOrientChildrenToTerrain

bool SCR_SlotCompositionComponent.m_bIgnoreOrientChildrenToTerrain
staticprotected

◆ m_Owner

GenericEntity SCR_SlotCompositionComponent.m_Owner
protected

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