Arma Reforger Script API
Loading...
Searching...
No Matches
SCR_XPHandlerComponent Interface Reference
Inheritance diagram for SCR_XPHandlerComponent:
SCR_BaseGameModeComponent

Public Member Functions

override void OnPlayerSpawnFinalize_S (SCR_SpawnRequestComponent requestComponent, SCR_SpawnHandlerComponent handlerComponent, SCR_SpawnData data, IEntity entity)
 
override void OnPlayerDisconnected (int playerId, KickCauseCode cause, int timeout)
 Called after a player is disconnected.
 
override void OnPlayerKilled (notnull SCR_InstigatorContextData instigatorContextData)
 Called after a player gets killed.
 
override void OnControllableDestroyed (notnull SCR_InstigatorContextData instigatorContextData)
 When a controllable entity is destroyed, this event is raised.
 
void ProcessSuicide (int playerId)
 
void AwardXP (int playerId, SCR_EXPRewards rewardID, float multiplier=1.0, bool volunteer=false, int customXP=0)
 Add XP to given playerId.
 
void AwardXP (notnull PlayerController controller, SCR_EXPRewards rewardID, float multiplier=1.0, bool volunteer=false, int customXP=0)
 Add XP to given controller.
 
void VeterancyAward (notnull PlayerController controller, float multiplier)
 
int GetXPRewardAmount (SCR_EXPRewards reward)
 Returns XP reward amount.
 
float GetXPMultiplier ()
 Returns XP reward amount.
 
string GetXPRewardName (SCR_EXPRewards reward)
 Returns XP reward name.
 
bool AllowNotification (SCR_EXPRewards reward)
 
override void OnPostInit (IEntity owner)
 Returns XP reward skill.
 
void ~SCR_XPHandlerComponent ()
 
- Public Member Functions inherited from SCR_BaseGameModeComponent
SCR_BaseGameMode GetGameMode ()
 
void OnGameEnd ()
 Called on all machines when the world ends.
 
void OnGameStateChanged (SCR_EGameModeState state)
 Called when game mode state changes called on all machines.
 
void OnGameModeStart ()
 Called on every machine when game mode starts.
 
void OnGameModeEnd (SCR_GameModeEndData data)
 Called when game mode ends.
 
void OnPlayerConnected (int playerId)
 Called after a player is connected.
 
void OnPlayerAuditSuccess (int playerId)
 Event is called when player connecting Session hosting current Game Mode where is required authentication verification via.
 
void OnPlayerAuditFail (int playerId)
 Event is called when player connecting Session hosting current Game Mode AuditFail() call may be called under two occasions: 1) verification is required but failed (account is not valid, player is banned, internet issues) 2) player cannot be verified as authentication is not required or possible - where it may be valid behavior (server online connectivity turned off for example) Basically non-audited player cannot access persistency/ etc.
 
void OnPlayerAuditTimeouted (int playerId)
 Event is called when player connected to Session was kicked and did not reconnected in time This mean that slot reservation can be canceled.
 
void OnPlayerAuditRevived (int playerId)
 Event is called when player reconnected successfully back to Session after kick This mean that slot reservation need to be finished (closed).
 
void OnPlayerRegistered (int playerId)
 Called on every machine after a player is registered (identity, name etc.).
 
void OnPlayerSpawned (int playerId, IEntity controlledEntity)
 Called after a player is spawned.
 
bool PreparePlayerEntity_S (SCR_SpawnRequestComponent requestComponent, SCR_SpawnHandlerComponent handlerComponent, SCR_SpawnData data, IEntity entity)
 
void OnSpawnPlayerEntityFailure_S (SCR_SpawnRequestComponent requestComponent, SCR_SpawnHandlerComponent handlerComponent, IEntity entity, SCR_SpawnData data, SCR_ESpawnResult reason)
 
bool HandlePlayerKilled (int playerId, IEntity playerEntity, IEntity killerEntity, notnull Instigator instigator)
 See SCR_BaseGameMode.HandlePlayerKilled.
 
void OnPlayerKilledHandled (int playerId, IEntity playerEntity, IEntity killerEntity, notnull Instigator instigator)
 Called after player gets killed in cases where the kill was handled by the game mode, supressing the default OnPlayerKilled behaviour.
 
void OnPlayerDeleted (int playerId, IEntity player)
 Called after a player gets deleted.
 
void OnPlayerRoleChange (int playerId, EPlayerRole roleFlags)
 Called when player role changes.
 
void OnWorldPostProcess (World world)
 Called once loading of all entities of the world have been finished (still within the loading)
 
void HandleOnLoadoutAssigned (int playerID, SCR_BasePlayerLoadout assignedLoadout)
 What happens when a player is assigned a loadout.
 
void HandleOnFactionAssigned (int playerID, Faction assignedFaction)
 What happens when a player is assigned a faction.
 
void HandleOnSpawnPointAssigned (int playerID, SCR_SpawnPoint spawnPoint)
 What happens when a player is assigned a spawn point.
 
void OnControllableSpawned (IEntity entity)
 When a controllable entity is spawned, this event is raised.
 
void OnControllableDeleted (IEntity entity)
 Prior to a controllable entity being DELETED, this event is raised.
 
void SCR_BaseGameModeComponent (IEntityComponentSource src, IEntity ent, IEntity parent)
 

Static Public Member Functions

static bool IsXpSystemEnabled ()
 Returns true when Xp handling system is operational.
 

Protected Member Functions

void OnCompartmentLeft (IEntity targetEntity, BaseCompartmentManagerComponent manager, int mgrID, int slotID, bool move)
 
void OnStatPointsAdded (int playerId, SCR_EDataStats stat, float amount, bool temp)
 
void AwardTransportXP (int playerId)
 
bool IsProxy ()
 

Protected Attributes

int m_iVeterancyXPAwardThreshold
 
int m_iSuicidePenaltyCooldown
 
ref array< ref SCR_XPRewardInfom_aXPRewardList = {}
 
ref map< int, float > m_mPlayerTransportPoints = new map<int, float>()
 
float m_fXpMultiplier = 1
 
- Protected Attributes inherited from SCR_BaseGameModeComponent
SCR_BaseGameMode m_pGameMode
 The game mode entity this component is attached to.
 

Static Protected Attributes

static bool s_bXpSystemEnabled
 
static const float TRANSPORT_POINTS_TO_XP_RATIO = 0.01
 
static const float TRANSPORT_HELI_MULTIPLIER = 0.25
 
static const int TRANSPORT_XP_PAYOFF_THRESHOLD = 15
 

Constructor & Destructor Documentation

◆ ~SCR_XPHandlerComponent()

void SCR_XPHandlerComponent.~SCR_XPHandlerComponent ( )

Member Function Documentation

◆ AllowNotification()

bool SCR_XPHandlerComponent.AllowNotification ( SCR_EXPRewards reward)
Parameters
[in]reward
Returns

◆ AwardTransportXP()

void SCR_XPHandlerComponent.AwardTransportXP ( int playerId)
protected

◆ AwardXP() [1/2]

void SCR_XPHandlerComponent.AwardXP ( int playerId,
SCR_EXPRewards rewardID,
float multiplier = 1::0,
bool volunteer = false,
int customXP = 0 )

Add XP to given playerId.

Parameters
[in]playerId
[in]rewardID
[in]multiplier
[in]volunteer
[in]customXP

◆ AwardXP() [2/2]

void SCR_XPHandlerComponent.AwardXP ( notnull PlayerController controller,
SCR_EXPRewards rewardID,
float multiplier = 1::0,
bool volunteer = false,
int customXP = 0 )

Add XP to given controller.

Parameters
[in]controller
[in]rewardID
[in]multiplier
[in]volunteer
[in]customXP

◆ GetXPMultiplier()

float SCR_XPHandlerComponent.GetXPMultiplier ( )

Returns XP reward amount.

Returns

◆ GetXPRewardAmount()

int SCR_XPHandlerComponent.GetXPRewardAmount ( SCR_EXPRewards reward)

Returns XP reward amount.

Parameters
[in]reward
Returns

◆ GetXPRewardName()

string SCR_XPHandlerComponent.GetXPRewardName ( SCR_EXPRewards reward)

Returns XP reward name.

Parameters
[in]reward
Returns
XP reward name

◆ IsProxy()

bool SCR_XPHandlerComponent.IsProxy ( )
protected

◆ IsXpSystemEnabled()

static bool SCR_XPHandlerComponent.IsXpSystemEnabled ( )
static

Returns true when Xp handling system is operational.

◆ OnCompartmentLeft()

void SCR_XPHandlerComponent.OnCompartmentLeft ( IEntity targetEntity,
BaseCompartmentManagerComponent manager,
int mgrID,
int slotID,
bool move )
protected

◆ OnControllableDestroyed()

override void SCR_XPHandlerComponent.OnControllableDestroyed ( notnull SCR_InstigatorContextData instigatorContextData)

When a controllable entity is destroyed, this event is raised.

Parameters
[in]instigatorContextDataHolds the data of the victim and killer

Implements SCR_BaseGameModeComponent.

◆ OnPlayerDisconnected()

override void SCR_XPHandlerComponent.OnPlayerDisconnected ( int playerId,
KickCauseCode cause,
int timeout )

Called after a player is disconnected.

Parameters
[in]playerIdPlayerId of disconnected player.
[in]causeReason player disconnected
[in]timeoutTimeout for when players are allowed to connect again. -1 means Ban without an assigned timeout

Implements SCR_BaseGameModeComponent.

◆ OnPlayerKilled()

override void SCR_XPHandlerComponent.OnPlayerKilled ( notnull SCR_InstigatorContextData instigatorContextData)

Called after a player gets killed.

Parameters
[in]instigatorContextDataHolds the data of the victim and killer

Implements SCR_BaseGameModeComponent.

◆ OnPlayerSpawnFinalize_S()

override void SCR_XPHandlerComponent.OnPlayerSpawnFinalize_S ( SCR_SpawnRequestComponent requestComponent,
SCR_SpawnHandlerComponent handlerComponent,
SCR_SpawnData data,
IEntity entity )
Parameters
[in]requestComponent
[in]handlerComponent
[in]data
[in]entity

Implements SCR_BaseGameModeComponent.

◆ OnPostInit()

override void SCR_XPHandlerComponent.OnPostInit ( IEntity owner)

Returns XP reward skill.

Parameters
[in]reward
Returns

◆ OnStatPointsAdded()

void SCR_XPHandlerComponent.OnStatPointsAdded ( int playerId,
SCR_EDataStats stat,
float amount,
bool temp )
protected

◆ ProcessSuicide()

void SCR_XPHandlerComponent.ProcessSuicide ( int playerId)
Parameters
[in]playerId

◆ VeterancyAward()

void SCR_XPHandlerComponent.VeterancyAward ( notnull PlayerController controller,
float multiplier )
Parameters
[in]controller
[in]multiplier

Member Data Documentation

◆ m_aXPRewardList

ref array<ref SCR_XPRewardInfo> SCR_XPHandlerComponent.m_aXPRewardList = {}
protected

◆ m_fXpMultiplier

float SCR_XPHandlerComponent.m_fXpMultiplier = 1
protected

◆ m_iSuicidePenaltyCooldown

int SCR_XPHandlerComponent.m_iSuicidePenaltyCooldown
protected

◆ m_iVeterancyXPAwardThreshold

int SCR_XPHandlerComponent.m_iVeterancyXPAwardThreshold
protected

◆ m_mPlayerTransportPoints

ref map<int, float> SCR_XPHandlerComponent.m_mPlayerTransportPoints = new map<int, float>()
protected

◆ s_bXpSystemEnabled

bool SCR_XPHandlerComponent.s_bXpSystemEnabled
staticprotected

◆ TRANSPORT_HELI_MULTIPLIER

const float SCR_XPHandlerComponent.TRANSPORT_HELI_MULTIPLIER = 0.25
staticprotected

◆ TRANSPORT_POINTS_TO_XP_RATIO

const float SCR_XPHandlerComponent.TRANSPORT_POINTS_TO_XP_RATIO = 0.01
staticprotected

◆ TRANSPORT_XP_PAYOFF_THRESHOLD

const int SCR_XPHandlerComponent.TRANSPORT_XP_PAYOFF_THRESHOLD = 15
staticprotected

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