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

Public Member Functions

void RPC_AskSetPlacementPosition (vector right, vector up, vector forward, vector position, RplId placeableId, RplId characterId)
 Client side method for informing the authority about where item should be placed upon removal from their inventory.
 
void RPC_AskPlaceItem (RplId placeableId)
 placeableId = id of items rpl component
 
void RPC_AskPlaceItemWithParentChange (RplId placeableId, RplId targetId, int nodeId)
 placeableId = id of items rpl component
 
void OnPlacingEnded (IEntity item, bool successful, ItemUseParameters animParams)
 
void AskPlaceItem (RplId placeableId, RplId targetId, int nodeId, bool isBeingAttachedToEntity)
 Client side method for finishing item placement when that item was successfully removed from their inventory.
 
void ValidateTargetEntityExistance ()
 
IEntity GetWeaponFromWeaponComponent (BaseWeaponComponent weaponComponent)
 
void UseXZFixedPlacement (IEntity owner, float maxPlacementDistance, vector cameraMat[4])
 
void UseXYZPlacement (IEntity owner, float maxPlacementDistance, vector cameraMat[4])
 
void ValidatePlacement (vector up, IEntity tracedEntity, BaseWorld world, IEntity character, out ENotification cantPlaceReason)
 
bool TraceEntitiesCallback (notnull IEntity e, vector start="0 0 0", vector dir="0 0 0")
 
void SCR_ItemPlacementComponent (IEntityComponentSource src, IEntity ent, IEntity parent)
 

Protected Member Functions

SCR_CharacterControllerComponent GetCharacterController (IEntity from)
 
void UnregisterEvents (IEntity from)
 
void RegisterEvents (IEntity to)
 
void OnControlledEntityChanged (IEntity from, IEntity to)
 
void StartPlaceItem ()
 
void DisablePreview ()
 
void EnablePreview (IEntity weapon)
 
void OnComparmentEntered (IEntity targetEntity, BaseCompartmentManagerComponent manager, int mgrID, int slotID, bool move)
 
void GetOnCompartmentLeft ()
 
void OnWeaponChangeEnded (BaseWeaponComponent newWeaponSlot)
 
void OnWeaponChanged (BaseWeaponComponent newWeaponSlot)
 
void OnCharacterDeath (SCR_CharacterControllerComponent characterController, IEntity killerEntity, notnull Instigator killer)
 
void TogglePreview (IEntity weapon)
 
override void EOnFrame (IEntity owner, float timeSlice)
 
bool FilterCallback (IEntity e)
 
bool ValidateEntity (notnull IEntity entity)
 
void OnEditorOpened ()
 
void OnEditorClosed ()
 
void RegisterToManagerInvokers (SCR_EditorManagerEntity manager)
 
override void OnPostInit (IEntity owner)
 
void InitEditorListeners ()
 
override void EOnInit (IEntity owner)
 

Protected Attributes

ResourceName m_sCanBuildMaterial
 
ResourceName m_sCannotBuildMaterial
 
ResourceName m_sTransparentMaterial
 
int m_iEquipComplete
 
int m_iTargetEntityNodeID
 
bool m_bInEditor
 
bool m_bIsBeingAttachedToEntity
 
vector m_vCurrentMat [4]
 
vector m_aCamDeploymentPosition [4]
 
IEntity m_EquippedItem
 
ENotification m_eCantPlaceReason
 
SCR_PlaceableItemComponent m_PlaceableItem
 
IEntity m_PreviewEntity
 
SCR_CompartmentAccessComponent m_CompartmnetAccessComponent
 
RplId m_TargetId
 
IEntity m_TargetEntity
 

Constructor & Destructor Documentation

◆ SCR_ItemPlacementComponent()

void SCR_ItemPlacementComponent.SCR_ItemPlacementComponent ( IEntityComponentSource src,
IEntity ent,
IEntity parent )
Parameters
[in]src
[in]ent
[in]parent

Member Function Documentation

◆ AskPlaceItem()

void SCR_ItemPlacementComponent.AskPlaceItem ( RplId placeableId,
RplId targetId,
int nodeId,
bool isBeingAttachedToEntity )

Client side method for finishing item placement when that item was successfully removed from their inventory.

Parameters
[in]placeableIdreplication id of placed item
[in]targetIdreplication id of object to which this item is being attached to
[in]nodeIdnode of the target object to which placed item will be attached to
[in]isBeingAttachedToEntity

◆ DisablePreview()

void SCR_ItemPlacementComponent.DisablePreview ( )
protected

◆ EnablePreview()

void SCR_ItemPlacementComponent.EnablePreview ( IEntity weapon)
protected

◆ EOnFrame()

override void SCR_ItemPlacementComponent.EOnFrame ( IEntity owner,
float timeSlice )
protected

◆ EOnInit()

override void SCR_ItemPlacementComponent.EOnInit ( IEntity owner)
protected

◆ FilterCallback()

bool SCR_ItemPlacementComponent.FilterCallback ( IEntity e)
protected

◆ GetCharacterController()

SCR_CharacterControllerComponent SCR_ItemPlacementComponent.GetCharacterController ( IEntity from)
protected

◆ GetOnCompartmentLeft()

void SCR_ItemPlacementComponent.GetOnCompartmentLeft ( )
protected

◆ GetWeaponFromWeaponComponent()

IEntity SCR_ItemPlacementComponent.GetWeaponFromWeaponComponent ( BaseWeaponComponent weaponComponent)
Parameters
[in]weaponComponent
Returns

◆ InitEditorListeners()

void SCR_ItemPlacementComponent.InitEditorListeners ( )
protected

◆ OnCharacterDeath()

void SCR_ItemPlacementComponent.OnCharacterDeath ( SCR_CharacterControllerComponent characterController,
IEntity killerEntity,
notnull Instigator killer )
protected

◆ OnComparmentEntered()

void SCR_ItemPlacementComponent.OnComparmentEntered ( IEntity targetEntity,
BaseCompartmentManagerComponent manager,
int mgrID,
int slotID,
bool move )
protected

◆ OnControlledEntityChanged()

void SCR_ItemPlacementComponent.OnControlledEntityChanged ( IEntity from,
IEntity to )
protected

◆ OnEditorClosed()

void SCR_ItemPlacementComponent.OnEditorClosed ( )
protected

◆ OnEditorOpened()

void SCR_ItemPlacementComponent.OnEditorOpened ( )
protected

◆ OnPlacingEnded()

void SCR_ItemPlacementComponent.OnPlacingEnded ( IEntity item,
bool successful,
ItemUseParameters animParams )

◆ OnPostInit()

override void SCR_ItemPlacementComponent.OnPostInit ( IEntity owner)
protected

◆ OnWeaponChanged()

void SCR_ItemPlacementComponent.OnWeaponChanged ( BaseWeaponComponent newWeaponSlot)
protected

◆ OnWeaponChangeEnded()

void SCR_ItemPlacementComponent.OnWeaponChangeEnded ( BaseWeaponComponent newWeaponSlot)
protected

◆ RegisterEvents()

void SCR_ItemPlacementComponent.RegisterEvents ( IEntity to)
protected

◆ RegisterToManagerInvokers()

void SCR_ItemPlacementComponent.RegisterToManagerInvokers ( SCR_EditorManagerEntity manager)
protected

◆ RPC_AskPlaceItem()

void SCR_ItemPlacementComponent.RPC_AskPlaceItem ( RplId placeableId)

placeableId = id of items rpl component

Parameters
[in]placeableId

◆ RPC_AskPlaceItemWithParentChange()

void SCR_ItemPlacementComponent.RPC_AskPlaceItemWithParentChange ( RplId placeableId,
RplId targetId,
int nodeId )

placeableId = id of items rpl component

Parameters
[in]placeableId
[in]targetIdis an RplId of the owner of the surface to which this item is meant to be attached to
[in]nodeIdis an node id of the surface to which this object is meant to be attached to

◆ RPC_AskSetPlacementPosition()

void SCR_ItemPlacementComponent.RPC_AskSetPlacementPosition ( vector right,
vector up,
vector forward,
vector position,
RplId placeableId,
RplId characterId )

Client side method for informing the authority about where item should be placed upon removal from their inventory.

Parameters
[in]right
[in]up
[in]forward
[in]position
[in]placeableIdreplication id of placed item
[in]characterIdreplication id of the character that placed it there

◆ StartPlaceItem()

void SCR_ItemPlacementComponent.StartPlaceItem ( )
protected

◆ TogglePreview()

void SCR_ItemPlacementComponent.TogglePreview ( IEntity weapon)
protected

◆ TraceEntitiesCallback()

bool SCR_ItemPlacementComponent.TraceEntitiesCallback ( notnull IEntity e,
vector start = "0 0 0",
vector dir = "0 0 0" )
Parameters
[in]e
Returns

◆ UnregisterEvents()

void SCR_ItemPlacementComponent.UnregisterEvents ( IEntity from)
protected

◆ UseXYZPlacement()

void SCR_ItemPlacementComponent.UseXYZPlacement ( IEntity owner,
float maxPlacementDistance,
vector cameraMat[4] )
Parameters
[in]owner
[in]maxPlacementDistance
[in]cameraMat

◆ UseXZFixedPlacement()

void SCR_ItemPlacementComponent.UseXZFixedPlacement ( IEntity owner,
float maxPlacementDistance,
vector cameraMat[4] )
Parameters
[in]owner
[in]maxPlacementDistance
[in]cameraMat

◆ ValidateEntity()

bool SCR_ItemPlacementComponent.ValidateEntity ( notnull IEntity entity)
protected
Parameters
[in]entity
Returns

◆ ValidatePlacement()

void SCR_ItemPlacementComponent.ValidatePlacement ( vector up,
IEntity tracedEntity,
BaseWorld world,
IEntity character,
out ENotification cantPlaceReason )
Parameters
[in]up
[in]tracedEntity
[in]world
[in]character
Returns

◆ ValidateTargetEntityExistance()

void SCR_ItemPlacementComponent.ValidateTargetEntityExistance ( )

Member Data Documentation

◆ m_aCamDeploymentPosition

vector SCR_ItemPlacementComponent.m_aCamDeploymentPosition[4]
protected

◆ m_bInEditor

bool SCR_ItemPlacementComponent.m_bInEditor
protected

◆ m_bIsBeingAttachedToEntity

bool SCR_ItemPlacementComponent.m_bIsBeingAttachedToEntity
protected

◆ m_CompartmnetAccessComponent

SCR_CompartmentAccessComponent SCR_ItemPlacementComponent.m_CompartmnetAccessComponent
protected

◆ m_eCantPlaceReason

ENotification SCR_ItemPlacementComponent.m_eCantPlaceReason
protected

◆ m_EquippedItem

IEntity SCR_ItemPlacementComponent.m_EquippedItem
protected

◆ m_iEquipComplete

int SCR_ItemPlacementComponent.m_iEquipComplete
protected

◆ m_iTargetEntityNodeID

int SCR_ItemPlacementComponent.m_iTargetEntityNodeID
protected

◆ m_PlaceableItem

SCR_PlaceableItemComponent SCR_ItemPlacementComponent.m_PlaceableItem
protected

◆ m_PreviewEntity

IEntity SCR_ItemPlacementComponent.m_PreviewEntity
protected

◆ m_sCanBuildMaterial

ResourceName SCR_ItemPlacementComponent.m_sCanBuildMaterial
protected

◆ m_sCannotBuildMaterial

ResourceName SCR_ItemPlacementComponent.m_sCannotBuildMaterial
protected

◆ m_sTransparentMaterial

ResourceName SCR_ItemPlacementComponent.m_sTransparentMaterial
protected

◆ m_TargetEntity

IEntity SCR_ItemPlacementComponent.m_TargetEntity
protected

◆ m_TargetId

RplId SCR_ItemPlacementComponent.m_TargetId
protected

◆ m_vCurrentMat

vector SCR_ItemPlacementComponent.m_vCurrentMat[4]
protected
The documentation for this interface was generated from the following file:
Generated by doxygen 1.11.0