|
Arma Reforger Script API
|
Public Member Functions | |
| override bool | CanReserveFor_S (int playerId, out SCR_ESpawnResult result=SCR_ESpawnResult.SPAWN_NOT_ALLOWED) |
| Returns whether this point can be reserved for provided player. | |
Public Member Functions inherited from SCR_SpawnPoint | |
| bool | IsSpawnPointVisibleForPlayer (int pid) |
| bool | IsSpawnPointEnabled () |
| void | SetSpawnPointEnabled_S (bool enabled) |
| ScriptInvokerBool | GetOnSpawnPointEnabled () |
| float | GetRespawnTime () |
| void | SetRespawnTime (float time) |
| bool | IsReservedFor_S (int playerId) |
| Authority: Returns whether this point is currently reserved for provided player. | |
| bool | ReserveFor_S (int playerId) |
| Authority: Returns whether this point is currently reserved for provided player. | |
| void | ClearReservationFor_S (int playerId) |
| Authority: Clears reservation for provided player. | |
| float | GetSpawnRadius () |
| void | SetSpawnRadius (float radius) |
| RplId | GetRplId () |
| Returns RplId of this spawn point. | |
| void | SetUseNearbySpawnPositions (bool use) |
| void | GetPositionAndRotation (out vector pos, out vector rot) |
| bool | IsSpawnPointActive () |
| bool | GetVisibleInDeployMapOnly () |
| void | SetVisibleInDeployMapOnly (bool visible) |
| void | SetFaction (Faction faction) |
| void | SetFactionKey (string factionKey) |
| void | SetSpawnPositionRange (float range) |
| float | GetSpawnPositionRange () |
| array< SCR_Position > | GetChildSpawnPoints () |
| string | GetFactionKey () |
| SCR_UIInfo | GetInfo () |
| void | SetInfo (SCR_UIInfo info) |
| string | GetSpawnPointName () |
| void | SetSpawnPointName (string name) |
| bool | IsTimed () |
| void | SetIsTimed (bool isTimed) |
| void | LinkInfo (SCR_UIInfo info) |
| override void | SetColorAndText () |
| bool | PrepareSpawnedEntity_S (SCR_SpawnRequestComponent requestComponent, SCR_SpawnData data, IEntity entity) |
| bool | CanFinalizeSpawn_S (SCR_SpawnRequestComponent requestComponent, SCR_SpawnData data, IEntity entity) |
| Authority: The PrepareEntity_S step might start doing an operation which is not performed immediately, for such cases we can await the finalization by returning 'false', until spawned entity is in desired state. | |
| void | OnFinalizeSpawnDone_S (SCR_SpawnRequestComponent requestComponent, SCR_SpawnData data, IEntity entity) |
| Authority: Callback for when finalization is done, e.g. | |
| override void | EOnInit (IEntity owner) |
| override bool | RplSave (ScriptBitWriter writer) |
| void | SCR_SpawnPoint (IEntitySource src, IEntity parent) |
| void | ~SCR_SpawnPoint () |
Public Member Functions inherited from SCR_Position | |
| override int | _WB_GetAfterWorldUpdateSpecs (IEntitySource src) |
| override void | _WB_AfterWorldUpdate (float timeSlice) |
| void | SCR_Position (IEntitySource src, IEntity parent) |
Additional Inherited Members | |
Static Public Member Functions inherited from SCR_SpawnPoint | |
| static SCR_SpawnPointFinalizeSpawn_Invoker | GetOnSpawnPointFinalizeSpawn () |
| static void | ShowSpawnPointDescriptors (bool show, Faction faction) |
| static SCR_SpawnPoint | GetSpawnPointByRplId (RplId id) |
| static SCR_SpawnPoint | GetSpawnPointByIndex (int spawnPointIndex) |
| Return spawn point or null if out of bounds. | |
| static int | GetSpawnPointIndex (SCR_SpawnPoint spawnPoint) |
| Return spawn point index or -1 if not existant. | |
| static int | CountSpawnPoints () |
| static array< SCR_SpawnPoint > | GetSpawnPoints () |
| static SCR_SpawnPoint | GetRandomSpawnPointDeathmatch () |
| static SCR_SpawnPoint | GetRandomSpawnPoint (SCR_ChimeraCharacter character) |
| static array< SCR_SpawnPoint > | GetSpawnPointsForPlayer (SCR_ChimeraCharacter character) |
| static array< SCR_SpawnPoint > | GetSpawnPointsForFaction (string factionKey) |
| Get spawn points valid for given faction. | |
| static int | GetSpawnPointCountForFaction (string factionKey) |
| Get count of spawn points belonging to given faction. | |
| static SCR_SpawnPoint | GetRandomSpawnPointForFaction (string factionKey) |
Static Public Attributes inherited from SCR_SpawnPoint | |
| static ref ScriptInvoker | Event_OnSpawnPointCountChanged = new ScriptInvoker() |
| static ref ScriptInvoker | Event_SpawnPointFactionAssigned = new ScriptInvoker() |
| static ref SpawnPointInvoker | Event_SpawnPointAdded = new SpawnPointInvoker() |
| static ref SpawnPointInvoker | Event_SpawnPointRemoved = new SpawnPointInvoker() |
| static ref SCR_SpawnPointFinalizeSpawn_Invoker | s_OnSpawnPointFinalizeSpawn |
| static ref SCR_SpawnPointNameChanged_Invoker | OnSpawnPointNameChanged = new SCR_SpawnPointNameChanged_Invoker() |
Protected Member Functions inherited from SCR_SpawnPoint | |
| void | OnSetEnabled () |
| bool | GetEmptyPositionAndRotationInRange (out vector pos, out vector rot) |
| void | ApplyFactionChange (FactionAffiliationComponent owner, Faction previousFaction, Faction newFaction) |
| void | OnSetFactionKey () |
| void | InitFactionAffiliation (IEntity owner) |
| override bool | RplLoad (ScriptBitReader reader) |
Protected Attributes inherited from SCR_SpawnPoint | |
| RplComponent | m_RplComponent |
| float | m_fSpawnRadius |
| string | m_sFaction |
| bool | m_bShowInDeployMapOnly |
| bool | m_bTimedSpawnPoint |
| SCR_UIInfo | m_LinkedInfo |
| SCR_FactionAffiliationComponent | m_FactionAffiliationComponent |
| ref SCR_UIInfo | m_Info |
| bool | m_bUseNearbySpawnPositions |
| float | m_fSpawnPositionUsageRange |
| float | m_fRespawnTime |
| string | m_sSpawnPointName |
| ref array< SCR_Position > | m_aChildren = {} |
| ref set< int > | m_ReservationLocks = new set<int>() |
| Authority: Set of all pending players that have a reservation for this spawn point. | |
| ref ScriptInvokerBool | m_OnSetSpawnPointEnabled |
| bool | m_bSpawnPointEnabled |
Protected Attributes inherited from SCR_Position | |
| int | m_iColor = Color.WHITE |
| string | m_sText = string.Empty |
| override bool SCR_CampaignSupplyRestrictedSpawnPoint.CanReserveFor_S | ( | int | playerId, |
| out SCR_ESpawnResult | result = SCR_ESpawnResult::SPAWN_NOT_ALLOWED ) |
Returns whether this point can be reserved for provided player.
Returns false when the player has a custom loadout or there is not enough resources for spawning
Implements SCR_SpawnPoint.