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

Public Member Functions

RplId GetRplId ()
 Returns RplId of entity to posses.
 
override bool IsValid ()
 Are data valid in the most basic context?
 
override void SetSkipPreload (bool skip)
 
override bool GetSkipPreload ()
 
- Public Member Functions inherited from SCR_SpawnData
ResourceName GetPrefab ()
 Returns the resource name of prefab to spawn.
 
vector GetPosition ()
 Returns the position at which to spawn.
 
vector GetAngles ()
 Returns the orientation at which to spawn.
 
bool IsValid ()
 Are data valid in the most basic context?
 
bool GetSkipPreload ()
 
void SetSkipPreload (bool skip)
 

Static Public Member Functions

static SCR_PossessSpawnData FromRplId (RplId id)
 Create data from provided RplId of possessable entity.
 
static SCR_PossessSpawnData FromEntity (notnull IEntity entity)
 Create data from provided entity.
 

Protected Member Functions

void SCR_PossessSpawnData ()
 

Protected Attributes

RplId m_RplId
 
bool m_bSkipPreload
 

Constructor & Destructor Documentation

◆ SCR_PossessSpawnData()

void SCR_PossessSpawnData.SCR_PossessSpawnData ( )
protected

Member Function Documentation

◆ FromEntity()

static SCR_PossessSpawnData SCR_PossessSpawnData.FromEntity ( notnull IEntity  entity)
static

Create data from provided entity.

Note: Not recommended for non-authority use as entities can stream in and out.

◆ FromRplId()

static SCR_PossessSpawnData SCR_PossessSpawnData.FromRplId ( RplId  id)
static

Create data from provided RplId of possessable entity.

◆ GetRplId()

RplId SCR_PossessSpawnData.GetRplId ( )

Returns RplId of entity to posses.

◆ GetSkipPreload()

override bool SCR_PossessSpawnData.GetSkipPreload ( )

Implements SCR_SpawnData.

◆ IsValid()

override bool SCR_PossessSpawnData.IsValid ( )

Are data valid in the most basic context?

Implements SCR_SpawnData.

◆ SetSkipPreload()

override void SCR_PossessSpawnData.SetSkipPreload ( bool  skip)

Implements SCR_SpawnData.

Member Data Documentation

◆ m_bSkipPreload

bool SCR_PossessSpawnData.m_bSkipPreload
protected

◆ m_RplId

RplId SCR_PossessSpawnData.m_RplId
protected

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