Arma Reforger Script API
Loading...
Searching...
No Matches
Public Member Functions | List of all members
SCR_SpawnData Interface Reference

The most basic payload that can be derived and sent via SCR_SpawnRequestComponent to be handled by SCR_SpawnHandlerComponent on the authority. More...

Inheritance diagram for SCR_SpawnData:
[legend]

Public Member Functions

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)
 

Detailed Description

The most basic payload that can be derived and sent via SCR_SpawnRequestComponent to be handled by SCR_SpawnHandlerComponent on the authority.

Each data needs a specific handler, the relation of SCR_SpawnRequestComponent : SCR_SpawnHandlerComponent is always 1:1. See existing implementation for details and examples.

Member Function Documentation

◆ GetAngles()

vector SCR_SpawnData.GetAngles ( )

Returns the orientation at which to spawn.

Implemented in SCR_FreeSpawnData, and SCR_SpawnPointSpawnData.

◆ GetPosition()

vector SCR_SpawnData.GetPosition ( )

Returns the position at which to spawn.

Implemented in SCR_FreeSpawnData, and SCR_SpawnPointSpawnData.

◆ GetPrefab()

ResourceName SCR_SpawnData.GetPrefab ( )

Returns the resource name of prefab to spawn.

Implemented in SCR_FreeSpawnData, and SCR_SpawnPointSpawnData.

◆ GetSkipPreload()

bool SCR_SpawnData.GetSkipPreload ( )

Implemented in SCR_PossessSpawnData.

◆ IsValid()

bool SCR_SpawnData.IsValid ( )

Are data valid in the most basic context?

Implemented in SCR_PossessSpawnData.

◆ SetSkipPreload()

void SCR_SpawnData.SetSkipPreload ( bool  skip)

Implemented in SCR_PossessSpawnData.


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