Inheritance diagram for SCR_GameModeCampaign:

Public Member Functions
bool	GetEstablishingBasesEnabled ()

bool	GetSuppliesAutoRegenerationEnabled ()

int	GetSuppliesArrivalIntervalSource ()

int	GetRegularSuppliesIncomeSource ()

float	GetAcceptableDistanceBetweenFactionHQs ()

float	GetPreferredDistanceBetweenFactionHQs ()

int	GetHQSpawnPointPriority ()

SCR_ECharacterRank	GetStartingRank ()

int	GetFactionEstablishBaseLimit ()

ResourceName	GetHQRadioSoundEntityPrefab ()

ScriptInvoker	GetOnFactionAssignedLocalPlayer ()
	Triggered when the local player picks a faction.

ScriptInvoker	GetOnStarted ()
	Triggered when Conflict gamemode has started.

ScriptInvoker	GetOnMatchSituationChanged ()
	Triggered when an event happened which should be communicated to players (i.e. amount of control points held etc.)

ScriptInvoker	GetOnCallsignOffsetChanged ()

ScriptInvokerEntity2	GetOnEntityRequested ()

int	GetSuppliesReplenishThreshold ()

int	GetQuickSuppliesReplenishThreshold ()

float	GetQuickSuppliesReplenishMultiplier ()

int	GetSuppliesArrivalInterval ()

int	GetRegularSuppliesIncome ()

int	GetRegularSuppliesIncomeBase ()

int	GetRegularSuppliesIncomeExtra ()

int	GetSupplyDepotIconThreshold ()

SCR_CampaignMilitaryBaseManager	GetBaseManager ()

float	GetVictoryTimer ()

int	GetControlPointTreshold ()

int	GetMinStartingSupplies ()

int	GetMaxStartingSupplies ()

int	GetStartingSuppliesInterval ()

float	GetSupplyOffloadAssistanceReward ()

ResourceName	GetSeekDestroyWaypointPrefab ()

bool	GetCommanderRoleEnabled ()

int	GetWinningFactionId ()

WorldTimestamp	GetVictoryTimestamp ()

WorldTimestamp	GetVictoryPauseTimestamp ()

bool	IsTutorial ()

bool	GetIsMatchOver ()

bool	HasStarted ()

int	GetCallsignOffset ()

void	OnMatchSituationChanged ()

override bool	RplSave (ScriptBitWriter writer)

override bool	RplLoad (ScriptBitReader reader)

SCR_CampaignClientData	GetClientData (int playerId, bool create=false)
	Get corresponding client data.

void	SetControlPointsHeld (SCR_CampaignFaction faction, int newCount)

void	BroadcastMHQFeedback (SCR_EMobileAssemblyStatus msgID, int playerID, int factionID)

void	RpcDo_BroadcastMHQFeedback (SCR_EMobileAssemblyStatus msgID, int playerID, int factionID)

override void	OnPlayerRegistered (int playerId)
	Called on every machine after a player is registered (identity, name etc.).

void	OnCallsignOffsetChanged ()

override void	OnGameStart ()
	Gets called after world is initialized but before first ticks.

FactionKey	GetFactionKeyByEnum (SCR_ECampaignFaction faction)

SCR_CampaignFaction	GetFactionByEnum (SCR_ECampaignFaction faction)

bool	IsProxy ()

bool	CanRequestVehicleWithoutRank ()
	Getter for "Rank required" parameter for spawning vehicles.

void	SetIsTutorial (bool isTutorial)

override void	OnPlayerAuditSuccess (int iPlayerID)

override void	OnPlayerDisconnected (int playerId, KickCauseCode cause, int timeout)
	Called after a player is disconnected.

override void	OnPlayerEntityChanged_S (int playerId, IEntity previousEntity, IEntity newEntity)
	Authority: Callback raised when the spawn system causes provided player's controlled entity to change.

override void	OnPlayerSpawnOnPoint_S (SCR_SpawnRequestComponent requestComponent, SCR_SpawnHandlerComponent handlerComponent, IEntity entity, SCR_SpawnPointSpawnData spawnPointData)
	Authority: Callback raised when the spawn system causes provided player to spawn with an entity at given spawn point.

void	OnSpawnPointFactionAssigned (SCR_SpawnPoint spawnpoint)

override void	OnPlayerKilledEx (notnull SCR_InstigatorContextData instigatorContextData)
	Extended OnPlayer Kill, called after BaseGamemode has executed the OnPlayerKilled Param[in] instigatorContextData Instigator context data of the killer and victim.

override bool	CanPlayerSpawn_S (SCR_SpawnRequestComponent requestComponent, SCR_SpawnHandlerComponent handlerComponent, SCR_SpawnData data, out SCR_ESpawnResult result=SCR_ESpawnResult.SPAWN_NOT_ALLOWED)
	Disable spawning on contested bases and with custom loadout on bases with no armories.

override void	OnControllableDestroyedEx (notnull SCR_InstigatorContextData instigatorContextData)
	Award additional XP for enemies killed in friendly bases.

void	OnEntityRequested (notnull IEntity spawnedEntity, IEntity user, SCR_Faction faction, SCR_MilitaryBaseLogicComponent service)
	Called when an entity is spawned by Free Roam Building.

void	SCR_GameModeCampaign (IEntitySource src, IEntity parent)

void	~SCR_GameModeCampaign ()

Public Member Functions inherited from SCR_BaseGameMode
bool	IsResourceTypeEnabled (EResourceType resourceType=EResourceType.SUPPLIES)

int	GetDisabledResourceTypes (inout notnull array< EResourceType > disabledResourceTypes)

void	SetResourceTypeEnabled (bool enable, EResourceType resourceType=EResourceType.SUPPLIES, int playerID=-1)
	Change if supplies are enabled or not.

ScriptInvokerBase< SCR_BaseGameMode_OnResourceEnabledChanged >	GetOnResourceTypeEnabledChanged ()

bool	CanStartSpawnPreload ()

bool	IsRunning ()
	Returns whether current game mode is running its game loop.

SCR_EGameModeState	GetState ()
	Returns current game state.

bool	IsMaster ()
	Returns whether the owner of this instance is authority or not.

float	GetElapsedTime ()
	Returns elapsed time from the start of this game in seconds.

float	GetTimeLimit ()
	Returns the game duration from the start of game in seconds or 0 if none.

float	GetRemainingTime ()
	Returns the remaining time of this game in seconds or -1 if none or undefined.

bool	IsHosted ()

void	CachePlayerSpawnPosition (int playerID, vector position)

SCR_RespawnSystemComponent	GetRespawnSystemComponent ()
	Returns respawn system component attached to this gamemode.

SCR_GameModeHealthSettings	GetGameModeHealthSettings ()

SCR_BaseScoringSystemComponent	GetScoringSystemComponent ()
	Returns scoring system component attached to this game mode or null if none.

void	StartGameMode ()
	Server-only call that starts current session.

void	EndGameMode (SCR_GameModeEndData endData)
	Server-only call that marks current session as complete.

SCR_GameModeEndData	GetEndGameData ()
	Get end game data will return null if game has not ended.

ScriptInvoker	GetOnGameStart ()

ScriptInvoker	GetOnGameEnd ()

ScriptInvokerBase< SCR_BaseGameMode_PlayerId >	GetOnPlayerAuditSuccess ()

ScriptInvokerBase< SCR_BaseGameMode_PlayerId >	GetOnPlayerAuditFail ()

ScriptInvokerBase< SCR_BaseGameMode_PlayerId >	GetOnPlayerAuditTimeouted ()

ScriptInvokerBase< SCR_BaseGameMode_PlayerId >	GetOnPlayerAuditRevived ()

ScriptInvokerBase< SCR_BaseGameMode_PlayerId >	GetOnPlayerConnected ()

ScriptInvokerBase< SCR_BaseGameMode_PlayerId >	GetOnPlayerRegistered ()

ScriptInvokerBase< SCR_BaseGameMode_OnPlayerDisconnected >	GetOnPlayerDisconnected ()

ScriptInvokerBase< SCR_BaseGameMode_OnPlayerDisconnected >	GetOnPostCompPlayerDisconnected ()
	Called on player disconnect and after Gamemode components are notified.

ScriptInvokerBase< SCR_BaseGameMode_PlayerIdAndEntity >	GetOnPlayerSpawned ()

ScriptInvokerBase< SCR_BaseGameMode_OnControllableDestroyed >	GetOnPlayerKilled ()

ScriptInvokerBase< SCR_BaseGameMode_PlayerIdAndEntity >	GetOnPlayerDeleted ()

ScriptInvokerBase< SCR_BaseGameMode_OnPlayerRoleChanged >	GetOnPlayerRoleChange ()

ScriptInvoker	GetOnWorldPostProcess ()

ScriptInvoker	GetOnControllableSpawned ()

ScriptInvokerBase< SCR_BaseGameMode_OnControllableDestroyed >	GetOnControllableDestroyed ()

ScriptInvoker	GetOnControllableDeleted ()

ScriptInvoker	GetOnGameModeEnd ()
	Get on game end script invoker called on every machine.

WorldTimestamp	GetGameEndTimeStamp ()
	Returns local timestamp when endgame was called.

float	GetAutoReloadDelay ()
	Returns delay of mission reload (if enabled) in seconds or else 0 if disabled.

void	OnGameEnd ()

bool	IsFactionChangeAllowed ()

override void	OnPlayerAuditFail (int iPlayerID)

override void	OnPlayerAuditTimeouted (int iPlayerID)

override void	OnPlayerAuditRevived (int iPlayerID)

override void	OnPlayerConnected (int playerId)
	Called after a player is connected.

override void	OnWorldPostProcess (World world)
	Called once loading of all entities of the world have been finished (still within the loading)

void	OnSpawnPlayerEntityFailure_S (SCR_SpawnRequestComponent requestComponent, SCR_SpawnHandlerComponent handlerComponent, IEntity entity, SCR_SpawnData data, SCR_ESpawnResult reason)
	Authority: Callback raised when the spawn process failed.

bool	PreparePlayerEntity_S (SCR_SpawnRequestComponent requestComponent, SCR_SpawnHandlerComponent handlerComponent, SCR_SpawnData data, IEntity entity)
	Authority only: During the spawn process (after validation pass), the SCR_SpawnHandlerComponent can opt to prepare spawned entity.

void	OnPlayerSpawnFinalize_S (SCR_SpawnRequestComponent requestComponent, SCR_SpawnHandlerComponent handlerComponent, SCR_SpawnData data, IEntity entity)
	Authority only: Whenever a SCR_SpawnHandlerComponent processes a spawn request and finished the finalization stage (awaits finalization, passes control to client) this method is called.

void	OnPlayerLoadoutSet_S (SCR_PlayerLoadoutComponent loadoutComponent, SCR_BasePlayerLoadout loadout)
	Authority: Callback raised when provided player (SCR_PlayerLoadoutComponent.GetPlayerController()) has their loadout set.

void	OnPlayerFactionSet_S (SCR_PlayerFactionAffiliationComponent factionComponent, Faction faction)
	Authority: Callback raised when provided player (SCR_PlayerFactionAffiliationComponent.GetPlayerController()) has their faction set.

int	GetPlayerRemainingRespawnTime (int playerID)
	Returns remaining respawn time in seconds for given player.

void	HandleOnTasksInitialized ()
	Called once tasks are initialized.

bool	GetAllowControls ()

SCR_BaseGameModeStateComponent	GetStateComponent (SCR_EGameModeState state)

bool	PauseGame (bool pause, SCR_EPauseReason reason=SCR_EPauseReason.SYSTEM)
	Pause or unpause game.

bool	CanBePaused ()
	Return true if client is offline.

override void	EOnFrame (IEntity owner, float timeSlice)

override void	EOnInit (IEntity owner)

OnPreloadFinishedInvoker	GetOnPreloadFinished ()

void	StartSpawnPreload (vector position)

bool	GetAutotuneEnabled ()

void	SCR_BaseGameMode (IEntitySource src, IEntity parent)

void	~SCR_BaseGameMode ()

Static Public Member Functions
static SCR_GameModeCampaign	GetInstance ()

Static Public Attributes
static const int	MINIMUM_DELAY = 100

static const int	UI_UPDATE_DELAY = 250

static const int	MEDIUM_DELAY = 1000

static const int	DEFAULT_DELAY = 2000

static const int	BACKEND_DELAY = 25000

Static Public Attributes inherited from SCR_BaseGameMode
const static string	WB_GAME_MODE_CATEGORY = "Game Mode"

Protected Member Functions
void	SetCallsignOffset (int offset)

void	RPC_DoSetControlPointsHeld (int factionIndex, int count)

void	Start ()

void	InitalBaseSetup ()

void	OnStarted ()

void	DisableExtraSpawnpoint (SCR_SpawnPoint spawnpoint)

void	SetPrioritySpawnpoint (SCR_SpawnPoint spawnpoint)

void	CheckForWinner ()
	Find out if any faction has won and it's time to end the match.

void	RPC_DoEndMatch (int winningFactionId)

void	OnAmbientVehicleSpawned (SCR_AmbientVehicleSpawnPointComponent spawnpoint, Vehicle vehicle)

void	OnRankChanged (SCR_ECharacterRank oldRank, SCR_ECharacterRank newRank, notnull IEntity owner, bool silent)

void	SetStartingRank (notnull PlayerController playerController)

void	UpdateRespawnPenalty (int playerId)
	Handles forgiving of post-suicide deploy timer penalties.

void	OnSuicide (int playerId)

void	OnLocalPlayerFactionAssigned (SCR_PlayerFactionAffiliationComponent component, Faction previous, Faction current)

void	UpdateClientData (int playerID)
	Save object with player's current data.

void	ApplyClientData (int playerId)

Protected Member Functions inherited from SCR_BaseGameMode
void	OnResourceTypeEnabledChanged ()
	\Called when Global Supplies is set to enabled or disabled (Server and client)

void	OnGameStateChanged ()
	Called when game state changed, i.e.

bool	CanStartGameMode ()
	Server-only logic that implements whether we can transition from pre-game (if enabled) to game loop.

void	OnGameModeStart ()
	Called on every machine when game mode starts by OnGameStateChanged.

void	OnGameModeEnd (SCR_GameModeEndData endData)
	Called on every machine when game mode ends by OnGameStateChanged.

void	HandleOnGameModeEndSaveData ()

void	RestartSession ()
	Reloads current session (authority only).

bool	TryShutdownServer ()

override bool	HandlePlayerKilled (int playerId, IEntity playerEntity, IEntity killerEntity, notnull Instigator killer)
	Called after a player is killed, but before 'OnPlayerKilled'.

override void	OnPlayerKilled (int playerId, IEntity playerEntity, IEntity killerEntity, notnull Instigator killer)
	Default player kill behaviour. Called when a player is killed (and HandlePlayerKilled returns true).

void	OnPlayerKilledHandled (int playerId, IEntity playerEntity, IEntity killerEntity, notnull Instigator killer)
	Called after player kill behaviour is handled by a component overriding the generic logic.

void	OnPlayerDeleted (int playerId, IEntity player)

override void	OnPlayerRoleChange (int playerId, EPlayerRole roleFlags)
	Called when player role changes.

override void	OnControllableSpawned (IEntity entity)
	When a controllable entity is spawned, this event is raised.

override void	OnControllableDestroyed (IEntity entity, IEntity killerEntity, notnull Instigator instigator)

override void	OnControllableDeleted (IEntity entity)

void	ConsumeSuppliesOnPlayerSpawn_S (int playerID, IEntity spawnPoint, SCR_PlayerLoadoutComponent loadoutComp)

void	ConsumeMilitarySupplyAllocationOnPlayerSpawn_S (SCR_SpawnRequestComponent requestComponent, IEntity spawnPoint, SCR_PlayerLoadoutComponent loadoutComponent)

void	SetLocalControls (bool enabled)
	Enable or disable controls for the local client.

bool	GetAllowControlsTarget ()

void	HandleSpawnPreload (float timeSlice)

Protected Member Functions inherited from BaseGameMode
void	OnPlayerSpawned (int playerId, IEntity controlledEntity)
	Called after a player is spawned.

Protected Attributes
bool	m_bTerminateScenario

int	m_iControlPointsThreshold

float	m_fVictoryTimer

int	m_iSuppliesReplenishThreshold

int	m_iQuickSuppliesReplenishThreshold

float	m_fQuickSuppliesReplenishMultiplier

int	m_iSuppliesArrivalInterval

int	m_iRegularSuppliesIncome

int	m_iRegularSuppliesIncomeBase

int	m_iRegularSuppliesIncomeExtra

int	m_iHQStartingSupplies

int	m_iMinStartingSupplies

int	m_iMaxStartingSupplies

int	m_iStartingSuppliesInterval

float	m_fSupplyOffloadAssistanceReward

FactionKey	m_sBLUFORFactionKey

FactionKey	m_sOPFORFactionKey

FactionKey	m_sINDFORFactionKey

bool	m_bRandomizeSupplies

int	m_iSupplyDepotIconThreshold

ResourceName	m_sSeekDestroyWaypointPrefab

int	m_iSuicidePenaltyCooldown

int	m_iSuicideRespawnDelay

int	m_iSuicideForgiveCooldown

bool	m_bCommanderRoleEnabled

float	m_fAcceptableDistanceBetweenFactionHQs

float	m_fPreferredDistanceBetweenFactionHQs

bool	m_bEstablishingBasesEnabled

bool	m_bSuppliesAutoRegenerationEnabled

int	m_iSuppliesArrivalIntervalSource

int	m_iRegularSuppliesIncomeSource

int	m_iHQSpawnPointPriority

SCR_ECharacterRank	m_eStartingRank

int	m_iFactionEstablishBaseLimit

ResourceName	m_sHQRadioSoundEntityPrefab

ref ScriptInvoker	m_OnFactionAssignedLocalPlayer

ref ScriptInvoker	m_OnStarted

ref ScriptInvoker	m_OnMatchSituationChanged

ref ScriptInvoker	m_OnCallsignOffsetChanged

ref ScriptInvokerEntity2	s_OnEntityRequested

ref array< SCR_PlayerRadioSpawnPointCampaign >	m_aRadioSpawnPoints = {}

ref array< ref SCR_CampaignClientData >	m_aRegisteredClients = {}

bool	m_bIgnoreMinimumVehicleRank

bool	m_bIsTutorial

bool	m_bMatchOver

ref SCR_CampaignMilitaryBaseManager	m_BaseManager = new SCR_CampaignMilitaryBaseManager(this)

bool	m_bStarted

WorldTimestamp	m_fVictoryTimestamp

WorldTimestamp	m_fVictoryPauseTimestamp

int	m_iWinningFactionId = SCR_CampaignMilitaryBaseComponent.INVALID_FACTION_INDEX

int	m_iCallsignOffset = SCR_MilitaryBaseComponent.INVALID_BASE_CALLSIGN

Protected Attributes inherited from SCR_BaseGameMode
ref ScriptInvoker	Event_OnGameStart = new ScriptInvoker()

ref ScriptInvoker	m_OnGameEnd = new ScriptInvoker()

ref ScriptInvokerBase< SCR_BaseGameMode_PlayerId >	m_OnPlayerAuditSuccess = new ScriptInvokerBase<SCR_BaseGameMode_PlayerId>()

ref ScriptInvokerBase< SCR_BaseGameMode_PlayerId >	m_OnPlayerAuditFail = new ScriptInvokerBase<SCR_BaseGameMode_PlayerId>()

ref ScriptInvokerBase< SCR_BaseGameMode_PlayerId >	m_OnPlayerAuditTimeouted = new ScriptInvokerBase<SCR_BaseGameMode_PlayerId>()

ref ScriptInvokerBase< SCR_BaseGameMode_PlayerId >	m_OnPlayerAuditRevived = new ScriptInvokerBase<SCR_BaseGameMode_PlayerId>()

ref ScriptInvokerBase< SCR_BaseGameMode_PlayerId >	m_OnPlayerConnected = new ScriptInvokerBase<SCR_BaseGameMode_PlayerId>()

ref ScriptInvokerBase< SCR_BaseGameMode_PlayerId >	m_OnPlayerRegistered = new ScriptInvokerBase<SCR_BaseGameMode_PlayerId>()

ref ScriptInvokerBase< SCR_BaseGameMode_OnPlayerDisconnected >	m_OnPlayerDisconnected = new ScriptInvokerBase<SCR_BaseGameMode_OnPlayerDisconnected>()

ref ScriptInvokerBase< SCR_BaseGameMode_OnPlayerDisconnected >	m_OnPostCompPlayerDisconnected = new ScriptInvokerBase<SCR_BaseGameMode_OnPlayerDisconnected>()

ref ScriptInvokerBase< SCR_BaseGameMode_PlayerIdAndEntity >	m_OnPlayerSpawned = new ScriptInvokerBase<SCR_BaseGameMode_PlayerIdAndEntity>()

ref ScriptInvokerBase< SCR_BaseGameMode_OnControllableDestroyed >	m_OnPlayerKilled = new ScriptInvokerBase<SCR_BaseGameMode_OnControllableDestroyed>()

ref ScriptInvokerBase< SCR_BaseGameMode_OnControllableDestroyed >	m_OnControllableDestroyed = new ScriptInvokerBase<SCR_BaseGameMode_OnControllableDestroyed>()

ref ScriptInvokerBase< SCR_BaseGameMode_PlayerIdAndEntity >	m_OnPlayerDeleted = new ScriptInvokerBase<SCR_BaseGameMode_PlayerIdAndEntity>()

ref ScriptInvokerBase< SCR_BaseGameMode_OnPlayerRoleChanged >	m_OnPlayerRoleChange = new ScriptInvokerBase<SCR_BaseGameMode_OnPlayerRoleChanged>()

ref ScriptInvoker	m_OnWorldPostProcess = new ScriptInvoker()

ref ScriptInvoker	m_OnControllableSpawned = new ScriptInvoker()

ref ScriptInvoker	m_OnControllableDeleted = new ScriptInvoker()

ref ScriptInvoker	m_OnGameModeEnd = new ScriptInvoker()

ref ScriptInvokerBase< SCR_BaseGameMode_OnResourceEnabledChanged >	m_OnResourceTypeEnabledChanged

SCR_EPauseReason	m_ePauseReasons

EGameFlags	m_eTestGameFlags

bool	m_bAutoPlayerRespawn

bool	m_bAllowFactionChange

bool	m_bAdvanceTimeRequiresPlayers

float	m_fTimeElapsed
	Elapsed time from the beginning of the game mode in seconds.

bool	m_bAllowControls = true
	If false, controls are disable for the time being.

float	m_fTimeCorrectionInterval = 10.0
	Interval of time synchronization in seconds.

float	m_fLastTimeCorrection
	Last timestamp of sent time correction for the server.

bool	m_bIsHosted
	Is the session hosted by a player?

RplComponent	m_RplComponent

SCR_GameModeHealthSettings	m_pGameModeHealthSettings

SCR_RespawnSystemComponent	m_pRespawnSystemComponent

SCR_BaseScoringSystemComponent	m_ScoringSystemComponent

SCR_RespawnTimerComponent	m_RespawnTimerComponent

ref array< SCR_BaseGameModeComponent >	m_aAdditionalGamemodeComponents = new array<SCR_BaseGameModeComponent>()
	Additional game mode components attached to this gamemode where we dispatch all our game mode related events to.

ref map< int, vector >	m_mPlayerSpawnPosition = new map<int, vector>()
	Used on server to respawn player on their original position after reconnecting.

ref map< SCR_EGameModeState, SCR_BaseGameModeStateComponent >	m_mStateComponents = new map<SCR_EGameModeState, SCR_BaseGameModeStateComponent>()
	Map of components per state.

bool	m_bUseSpawnPreload
	Spawn location preload.

bool	m_bAutotuneEnabled
	is the autotune radio feature enabled

ref SCR_SpawnPreload	m_SpawnPreload

ref OnPreloadFinishedInvoker	m_OnPreloadFinished

ref array< EResourceType >	m_aDisabledResourceTypes

WorldTimestamp	m_GameEndTimeStamp = null

Constructor & Destructor Documentation

◆ SCR_GameModeCampaign()

void SCR_GameModeCampaign.SCR_GameModeCampaign	(	IEntitySource	src,
		IEntity	parent )

◆ ~SCR_GameModeCampaign()

void SCR_GameModeCampaign.~SCR_GameModeCampaign ( )

Member Function Documentation

◆ ApplyClientData()

void SCR_GameModeCampaign.ApplyClientData ( int playerId )

protected

◆ BroadcastMHQFeedback()

void SCR_GameModeCampaign.BroadcastMHQFeedback	(	SCR_EMobileAssemblyStatus	msgID,
		int	playerID,
		int	factionID )

◆ CanPlayerSpawn_S()

override bool SCR_GameModeCampaign.CanPlayerSpawn_S	(	SCR_SpawnRequestComponent	requestComponent,
		SCR_SpawnHandlerComponent	handlerComponent,
		SCR_SpawnData	data,
		out SCR_ESpawnResult	result = SCR_ESpawnResult::SPAWN_NOT_ALLOWED )

Disable spawning on contested bases and with custom loadout on bases with no armories.

Authority: Override and implement logic for whether provided player can spawn.

Parameters

	requestComponent	The player request component instigating this spawn.
	handlerComponent	The spawn handler component handling this spawn.
	data	The request payload.
[out]	result	Reason why respawn is disabled. Note that if returns true the reason will always be OK

Returns: True when spawn is allowed, false otherwise.

Implements SCR_BaseGameMode.

◆ CanRequestVehicleWithoutRank()

bool SCR_GameModeCampaign.CanRequestVehicleWithoutRank ( )

Getter for "Rank required" parameter for spawning vehicles.

◆ CheckForWinner()

void SCR_GameModeCampaign.CheckForWinner ( )

protected

Find out if any faction has won and it's time to end the match.

◆ DisableExtraSpawnpoint()

void SCR_GameModeCampaign.DisableExtraSpawnpoint ( SCR_SpawnPoint spawnpoint )

protected

◆ GetAcceptableDistanceBetweenFactionHQs()

float SCR_GameModeCampaign.GetAcceptableDistanceBetweenFactionHQs ( )

◆ GetBaseManager()

SCR_CampaignMilitaryBaseManager SCR_GameModeCampaign.GetBaseManager ( )

◆ GetCallsignOffset()

int SCR_GameModeCampaign.GetCallsignOffset ( )

◆ GetClientData()

SCR_CampaignClientData SCR_GameModeCampaign.GetClientData	(	int	playerId,
		bool	create = false )

Get corresponding client data.

Optionally: create new object if not found

Parameters

[in]	playerId
[in]	create

◆ GetCommanderRoleEnabled()

bool SCR_GameModeCampaign.GetCommanderRoleEnabled ( )

◆ GetControlPointTreshold()

int SCR_GameModeCampaign.GetControlPointTreshold ( )

◆ GetEstablishingBasesEnabled()

bool SCR_GameModeCampaign.GetEstablishingBasesEnabled ( )

◆ GetFactionByEnum()

SCR_CampaignFaction SCR_GameModeCampaign.GetFactionByEnum ( SCR_ECampaignFaction faction )

◆ GetFactionEstablishBaseLimit()

int SCR_GameModeCampaign.GetFactionEstablishBaseLimit ( )

◆ GetFactionKeyByEnum()

FactionKey SCR_GameModeCampaign.GetFactionKeyByEnum ( SCR_ECampaignFaction faction )

◆ GetHQRadioSoundEntityPrefab()

ResourceName SCR_GameModeCampaign.GetHQRadioSoundEntityPrefab ( )

◆ GetHQSpawnPointPriority()

int SCR_GameModeCampaign.GetHQSpawnPointPriority ( )

◆ GetInstance()

static SCR_GameModeCampaign SCR_GameModeCampaign.GetInstance ( )

static

◆ GetIsMatchOver()

bool SCR_GameModeCampaign.GetIsMatchOver ( )

◆ GetMaxStartingSupplies()

int SCR_GameModeCampaign.GetMaxStartingSupplies ( )

◆ GetMinStartingSupplies()

int SCR_GameModeCampaign.GetMinStartingSupplies ( )

◆ GetOnCallsignOffsetChanged()

ScriptInvoker SCR_GameModeCampaign.GetOnCallsignOffsetChanged ( )

◆ GetOnEntityRequested()

ScriptInvokerEntity2 SCR_GameModeCampaign.GetOnEntityRequested ( )

◆ GetOnFactionAssignedLocalPlayer()

ScriptInvoker SCR_GameModeCampaign.GetOnFactionAssignedLocalPlayer ( )

Triggered when the local player picks a faction.

◆ GetOnMatchSituationChanged()

ScriptInvoker SCR_GameModeCampaign.GetOnMatchSituationChanged ( )

Triggered when an event happened which should be communicated to players (i.e. amount of control points held etc.)

◆ GetOnStarted()

ScriptInvoker SCR_GameModeCampaign.GetOnStarted ( )

Triggered when Conflict gamemode has started.

◆ GetPreferredDistanceBetweenFactionHQs()

float SCR_GameModeCampaign.GetPreferredDistanceBetweenFactionHQs ( )

◆ GetQuickSuppliesReplenishMultiplier()

float SCR_GameModeCampaign.GetQuickSuppliesReplenishMultiplier ( )

◆ GetQuickSuppliesReplenishThreshold()

int SCR_GameModeCampaign.GetQuickSuppliesReplenishThreshold ( )

◆ GetRegularSuppliesIncome()

int SCR_GameModeCampaign.GetRegularSuppliesIncome ( )

◆ GetRegularSuppliesIncomeBase()

int SCR_GameModeCampaign.GetRegularSuppliesIncomeBase ( )

◆ GetRegularSuppliesIncomeExtra()

int SCR_GameModeCampaign.GetRegularSuppliesIncomeExtra ( )

◆ GetRegularSuppliesIncomeSource()

int SCR_GameModeCampaign.GetRegularSuppliesIncomeSource ( )

◆ GetSeekDestroyWaypointPrefab()

ResourceName SCR_GameModeCampaign.GetSeekDestroyWaypointPrefab ( )

◆ GetStartingRank()

SCR_ECharacterRank SCR_GameModeCampaign.GetStartingRank ( )

◆ GetStartingSuppliesInterval()

int SCR_GameModeCampaign.GetStartingSuppliesInterval ( )

◆ GetSuppliesArrivalInterval()

int SCR_GameModeCampaign.GetSuppliesArrivalInterval ( )

◆ GetSuppliesArrivalIntervalSource()

int SCR_GameModeCampaign.GetSuppliesArrivalIntervalSource ( )

◆ GetSuppliesAutoRegenerationEnabled()

bool SCR_GameModeCampaign.GetSuppliesAutoRegenerationEnabled ( )

◆ GetSuppliesReplenishThreshold()

int SCR_GameModeCampaign.GetSuppliesReplenishThreshold ( )

◆ GetSupplyDepotIconThreshold()

int SCR_GameModeCampaign.GetSupplyDepotIconThreshold ( )

◆ GetSupplyOffloadAssistanceReward()

float SCR_GameModeCampaign.GetSupplyOffloadAssistanceReward ( )

◆ GetVictoryPauseTimestamp()

WorldTimestamp SCR_GameModeCampaign.GetVictoryPauseTimestamp ( )

◆ GetVictoryTimer()

float SCR_GameModeCampaign.GetVictoryTimer ( )

◆ GetVictoryTimestamp()

WorldTimestamp SCR_GameModeCampaign.GetVictoryTimestamp ( )

◆ GetWinningFactionId()

int SCR_GameModeCampaign.GetWinningFactionId ( )

◆ HasStarted()

bool SCR_GameModeCampaign.HasStarted ( )

◆ InitalBaseSetup()

void SCR_GameModeCampaign.InitalBaseSetup ( )

protected

◆ IsProxy()

bool SCR_GameModeCampaign.IsProxy ( )

◆ IsTutorial()

bool SCR_GameModeCampaign.IsTutorial ( )

◆ OnAmbientVehicleSpawned()

void SCR_GameModeCampaign.OnAmbientVehicleSpawned	(	SCR_AmbientVehicleSpawnPointComponent	spawnpoint,
		Vehicle	vehicle )

protected

◆ OnCallsignOffsetChanged()

void SCR_GameModeCampaign.OnCallsignOffsetChanged ( )

◆ OnControllableDestroyedEx()

override void SCR_GameModeCampaign.OnControllableDestroyedEx ( notnull SCR_InstigatorContextData instigatorContextData )

Award additional XP for enemies killed in friendly bases.

Implements SCR_BaseGameMode.

◆ OnEntityRequested()

void SCR_GameModeCampaign.OnEntityRequested	(	notnull IEntity	spawnedEntity,
		IEntity	user,
		SCR_Faction	faction,
		SCR_MilitaryBaseLogicComponent	service )

Called when an entity is spawned by Free Roam Building.

◆ OnGameStart()

override void SCR_GameModeCampaign.OnGameStart ( )

Gets called after world is initialized but before first ticks.

Implements SCR_BaseGameMode.

◆ OnLocalPlayerFactionAssigned()

void SCR_GameModeCampaign.OnLocalPlayerFactionAssigned	(	SCR_PlayerFactionAffiliationComponent	component,
		Faction	previous,
		Faction	current )

protected

◆ OnMatchSituationChanged()

void SCR_GameModeCampaign.OnMatchSituationChanged ( )

◆ OnPlayerAuditSuccess()

override void SCR_GameModeCampaign.OnPlayerAuditSuccess ( int iPlayerID )

Implements SCR_BaseGameMode.

◆ OnPlayerDisconnected()

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

Called after a player is disconnected.

Parameters

playerId PlayerId of disconnected player.

Implements SCR_BaseGameMode.

◆ OnPlayerEntityChanged_S()

override void SCR_GameModeCampaign.OnPlayerEntityChanged_S	(	int	playerId,
		IEntity	previousEntity,
		IEntity	newEntity )

Authority: Callback raised when the spawn system causes provided player's controlled entity to change.

Implements SCR_BaseGameMode.

◆ OnPlayerKilledEx()

override void SCR_GameModeCampaign.OnPlayerKilledEx ( notnull SCR_InstigatorContextData instigatorContextData )

Extended OnPlayer Kill, called after BaseGamemode has executed the OnPlayerKilled Param[in] instigatorContextData Instigator context data of the killer and victim.

Implements SCR_BaseGameMode.

◆ OnPlayerRegistered()

override void SCR_GameModeCampaign.OnPlayerRegistered ( int playerId )

Called on every machine after a player is registered (identity, name etc.).

Always called after OnPlayerConnected.

Parameters

playerId PlayerId of registered player.

Implements SCR_BaseGameMode.

◆ OnPlayerSpawnOnPoint_S()

override void SCR_GameModeCampaign.OnPlayerSpawnOnPoint_S	(	SCR_SpawnRequestComponent	requestComponent,
		SCR_SpawnHandlerComponent	handlerComponent,
		IEntity	entity,
		SCR_SpawnPointSpawnData	spawnPointData )

Authority: Callback raised when the spawn system causes provided player to spawn with an entity at given spawn point.

See: SCR_BaseGameMode.OnPlayerSpawnFinalize_S

Implements SCR_BaseGameMode.

◆ OnRankChanged()

void SCR_GameModeCampaign.OnRankChanged	(	SCR_ECharacterRank	oldRank,
		SCR_ECharacterRank	newRank,
		notnull IEntity	owner,
		bool	silent )

protected

◆ OnSpawnPointFactionAssigned()

void SCR_GameModeCampaign.OnSpawnPointFactionAssigned ( SCR_SpawnPoint spawnpoint )

◆ OnStarted()

void SCR_GameModeCampaign.OnStarted ( )

protected

◆ OnSuicide()

void SCR_GameModeCampaign.OnSuicide ( int playerId )

protected

◆ RPC_DoEndMatch()

void SCR_GameModeCampaign.RPC_DoEndMatch ( int winningFactionId )

protected

◆ RPC_DoSetControlPointsHeld()

void SCR_GameModeCampaign.RPC_DoSetControlPointsHeld	(	int	factionIndex,
		int	count )

protected

◆ RpcDo_BroadcastMHQFeedback()

void SCR_GameModeCampaign.RpcDo_BroadcastMHQFeedback	(	SCR_EMobileAssemblyStatus	msgID,
		int	playerID,
		int	factionID )

◆ RplLoad()

override bool SCR_GameModeCampaign.RplLoad ( ScriptBitReader reader )

Implements SCR_BaseGameMode.

◆ RplSave()

override bool SCR_GameModeCampaign.RplSave ( ScriptBitWriter writer )

Implements SCR_BaseGameMode.

◆ SetCallsignOffset()

void SCR_GameModeCampaign.SetCallsignOffset ( int offset )

protected

◆ SetControlPointsHeld()

void SCR_GameModeCampaign.SetControlPointsHeld	(	SCR_CampaignFaction	faction,
		int	newCount )

◆ SetIsTutorial()

void SCR_GameModeCampaign.SetIsTutorial ( bool isTutorial )

◆ SetPrioritySpawnpoint()

void SCR_GameModeCampaign.SetPrioritySpawnpoint ( SCR_SpawnPoint spawnpoint )

protected

◆ SetStartingRank()

void SCR_GameModeCampaign.SetStartingRank ( notnull PlayerController playerController )

protected

◆ Start()

void SCR_GameModeCampaign.Start ( )

protected

◆ UpdateClientData()

void SCR_GameModeCampaign.UpdateClientData ( int playerID )

protected

Save object with player's current data.

◆ UpdateRespawnPenalty()

void SCR_GameModeCampaign.UpdateRespawnPenalty ( int playerId )

protected

Handles forgiving of post-suicide deploy timer penalties.

Member Data Documentation

◆ BACKEND_DELAY

const int SCR_GameModeCampaign.BACKEND_DELAY = 25000

static

◆ DEFAULT_DELAY

const int SCR_GameModeCampaign.DEFAULT_DELAY = 2000

static

◆ m_aRadioSpawnPoints

ref array<SCR_PlayerRadioSpawnPointCampaign> SCR_GameModeCampaign.m_aRadioSpawnPoints = {}

protected

◆ m_aRegisteredClients

ref array<ref SCR_CampaignClientData> SCR_GameModeCampaign.m_aRegisteredClients = {}

protected

◆ m_BaseManager

ref SCR_CampaignMilitaryBaseManager SCR_GameModeCampaign.m_BaseManager = new SCR_CampaignMilitaryBaseManager(this)

protected

◆ m_bCommanderRoleEnabled

bool SCR_GameModeCampaign.m_bCommanderRoleEnabled

protected

◆ m_bEstablishingBasesEnabled

bool SCR_GameModeCampaign.m_bEstablishingBasesEnabled

protected

◆ m_bIgnoreMinimumVehicleRank

bool SCR_GameModeCampaign.m_bIgnoreMinimumVehicleRank

protected

◆ m_bIsTutorial

bool SCR_GameModeCampaign.m_bIsTutorial

protected

◆ m_bMatchOver

bool SCR_GameModeCampaign.m_bMatchOver

protected

◆ m_bRandomizeSupplies

bool SCR_GameModeCampaign.m_bRandomizeSupplies

protected

◆ m_bStarted

bool SCR_GameModeCampaign.m_bStarted

protected

◆ m_bSuppliesAutoRegenerationEnabled

bool SCR_GameModeCampaign.m_bSuppliesAutoRegenerationEnabled

protected

◆ m_bTerminateScenario

bool SCR_GameModeCampaign.m_bTerminateScenario

protected

◆ m_eStartingRank

SCR_ECharacterRank SCR_GameModeCampaign.m_eStartingRank

protected

◆ m_fAcceptableDistanceBetweenFactionHQs

float SCR_GameModeCampaign.m_fAcceptableDistanceBetweenFactionHQs

protected

◆ m_fPreferredDistanceBetweenFactionHQs

float SCR_GameModeCampaign.m_fPreferredDistanceBetweenFactionHQs

protected

◆ m_fQuickSuppliesReplenishMultiplier

float SCR_GameModeCampaign.m_fQuickSuppliesReplenishMultiplier

protected

◆ m_fSupplyOffloadAssistanceReward

float SCR_GameModeCampaign.m_fSupplyOffloadAssistanceReward

protected

◆ m_fVictoryPauseTimestamp

WorldTimestamp SCR_GameModeCampaign.m_fVictoryPauseTimestamp

protected

◆ m_fVictoryTimer

float SCR_GameModeCampaign.m_fVictoryTimer

protected

◆ m_fVictoryTimestamp

WorldTimestamp SCR_GameModeCampaign.m_fVictoryTimestamp

protected

◆ m_iCallsignOffset

int SCR_GameModeCampaign.m_iCallsignOffset = SCR_MilitaryBaseComponent.INVALID_BASE_CALLSIGN

protected

◆ m_iControlPointsThreshold

int SCR_GameModeCampaign.m_iControlPointsThreshold

protected

◆ m_iFactionEstablishBaseLimit

int SCR_GameModeCampaign.m_iFactionEstablishBaseLimit

protected

◆ m_iHQSpawnPointPriority

int SCR_GameModeCampaign.m_iHQSpawnPointPriority

protected

◆ m_iHQStartingSupplies

int SCR_GameModeCampaign.m_iHQStartingSupplies

protected

◆ m_iMaxStartingSupplies

int SCR_GameModeCampaign.m_iMaxStartingSupplies

protected

◆ m_iMinStartingSupplies

int SCR_GameModeCampaign.m_iMinStartingSupplies

protected

◆ m_iQuickSuppliesReplenishThreshold

int SCR_GameModeCampaign.m_iQuickSuppliesReplenishThreshold

protected

◆ m_iRegularSuppliesIncome

int SCR_GameModeCampaign.m_iRegularSuppliesIncome

protected

◆ m_iRegularSuppliesIncomeBase

int SCR_GameModeCampaign.m_iRegularSuppliesIncomeBase

protected

◆ m_iRegularSuppliesIncomeExtra

int SCR_GameModeCampaign.m_iRegularSuppliesIncomeExtra

protected

◆ m_iRegularSuppliesIncomeSource

int SCR_GameModeCampaign.m_iRegularSuppliesIncomeSource

protected

◆ m_iStartingSuppliesInterval

int SCR_GameModeCampaign.m_iStartingSuppliesInterval

protected

◆ m_iSuicideForgiveCooldown

int SCR_GameModeCampaign.m_iSuicideForgiveCooldown

protected

◆ m_iSuicidePenaltyCooldown

int SCR_GameModeCampaign.m_iSuicidePenaltyCooldown

protected

◆ m_iSuicideRespawnDelay

int SCR_GameModeCampaign.m_iSuicideRespawnDelay

protected

◆ m_iSuppliesArrivalInterval

int SCR_GameModeCampaign.m_iSuppliesArrivalInterval

protected

◆ m_iSuppliesArrivalIntervalSource

int SCR_GameModeCampaign.m_iSuppliesArrivalIntervalSource

protected

◆ m_iSuppliesReplenishThreshold

int SCR_GameModeCampaign.m_iSuppliesReplenishThreshold

protected

◆ m_iSupplyDepotIconThreshold

int SCR_GameModeCampaign.m_iSupplyDepotIconThreshold

protected

◆ m_iWinningFactionId

int SCR_GameModeCampaign.m_iWinningFactionId = SCR_CampaignMilitaryBaseComponent.INVALID_FACTION_INDEX

protected

◆ m_OnCallsignOffsetChanged

ref ScriptInvoker SCR_GameModeCampaign.m_OnCallsignOffsetChanged

protected

◆ m_OnFactionAssignedLocalPlayer

ref ScriptInvoker SCR_GameModeCampaign.m_OnFactionAssignedLocalPlayer

protected

◆ m_OnMatchSituationChanged

ref ScriptInvoker SCR_GameModeCampaign.m_OnMatchSituationChanged

protected

◆ m_OnStarted

ref ScriptInvoker SCR_GameModeCampaign.m_OnStarted

protected

◆ m_sBLUFORFactionKey

FactionKey SCR_GameModeCampaign.m_sBLUFORFactionKey

protected

◆ m_sHQRadioSoundEntityPrefab

ResourceName SCR_GameModeCampaign.m_sHQRadioSoundEntityPrefab

protected

◆ m_sINDFORFactionKey

FactionKey SCR_GameModeCampaign.m_sINDFORFactionKey

protected

◆ m_sOPFORFactionKey

FactionKey SCR_GameModeCampaign.m_sOPFORFactionKey

protected

◆ m_sSeekDestroyWaypointPrefab

ResourceName SCR_GameModeCampaign.m_sSeekDestroyWaypointPrefab

protected

◆ MEDIUM_DELAY

const int SCR_GameModeCampaign.MEDIUM_DELAY = 1000

static

◆ MINIMUM_DELAY

const int SCR_GameModeCampaign.MINIMUM_DELAY = 100

static

◆ s_OnEntityRequested

ref ScriptInvokerEntity2 SCR_GameModeCampaign.s_OnEntityRequested

protected

◆ UI_UPDATE_DELAY

const int SCR_GameModeCampaign.UI_UPDATE_DELAY = 250

static

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

Game/GameMode/SCR_GameModeCampaign.c

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ SCR_GameModeCampaign()

◆ ~SCR_GameModeCampaign()

Member Function Documentation

◆ ApplyClientData()

◆ BroadcastMHQFeedback()

◆ CanPlayerSpawn_S()

◆ CanRequestVehicleWithoutRank()

◆ CheckForWinner()

◆ DisableExtraSpawnpoint()

◆ GetAcceptableDistanceBetweenFactionHQs()

◆ GetBaseManager()

◆ GetCallsignOffset()

◆ GetClientData()

◆ GetCommanderRoleEnabled()

◆ GetControlPointTreshold()

◆ GetEstablishingBasesEnabled()

◆ GetFactionByEnum()

◆ GetFactionEstablishBaseLimit()

◆ GetFactionKeyByEnum()

◆ GetHQRadioSoundEntityPrefab()

◆ GetHQSpawnPointPriority()

◆ GetInstance()

◆ GetIsMatchOver()

◆ GetMaxStartingSupplies()

◆ GetMinStartingSupplies()

◆ GetOnCallsignOffsetChanged()

◆ GetOnEntityRequested()

◆ GetOnFactionAssignedLocalPlayer()

◆ GetOnMatchSituationChanged()

◆ GetOnStarted()

◆ GetPreferredDistanceBetweenFactionHQs()

◆ GetQuickSuppliesReplenishMultiplier()

◆ GetQuickSuppliesReplenishThreshold()

◆ GetRegularSuppliesIncome()

◆ GetRegularSuppliesIncomeBase()

◆ GetRegularSuppliesIncomeExtra()

◆ GetRegularSuppliesIncomeSource()

◆ GetSeekDestroyWaypointPrefab()

◆ GetStartingRank()

◆ GetStartingSuppliesInterval()

◆ GetSuppliesArrivalInterval()

◆ GetSuppliesArrivalIntervalSource()

◆ GetSuppliesAutoRegenerationEnabled()

◆ GetSuppliesReplenishThreshold()

◆ GetSupplyDepotIconThreshold()

◆ GetSupplyOffloadAssistanceReward()

◆ GetVictoryPauseTimestamp()

◆ GetVictoryTimer()

◆ GetVictoryTimestamp()

◆ GetWinningFactionId()

◆ HasStarted()

◆ InitalBaseSetup()

◆ IsProxy()

◆ IsTutorial()

◆ OnAmbientVehicleSpawned()

◆ OnCallsignOffsetChanged()

◆ OnControllableDestroyedEx()

◆ OnEntityRequested()

◆ OnGameStart()

◆ OnLocalPlayerFactionAssigned()

◆ OnMatchSituationChanged()

◆ OnPlayerAuditSuccess()

◆ OnPlayerDisconnected()

◆ OnPlayerEntityChanged_S()

◆ OnPlayerKilledEx()

◆ OnPlayerRegistered()

◆ OnPlayerSpawnOnPoint_S()

◆ OnRankChanged()

◆ OnSpawnPointFactionAssigned()

◆ OnStarted()

◆ OnSuicide()

◆ RPC_DoEndMatch()

◆ RPC_DoSetControlPointsHeld()

◆ RpcDo_BroadcastMHQFeedback()