Classes
class	SCR_AdditionalGameModeSettingsComponentClass

Functions
bool	GetProjectileBallisticInfoVisibility ()
ScriptInvokerVoid	GetOnChangeAdditionalSettingsInvoker ()
void	OnAdditionalSettingsChanged ()
void	OnNametagRelationFilterUpdated ()
	On Updated function for relation filters.
ScriptInvokerInt	GetOnNametagRelationFilterUpdated ()
void	OnNametagControllerFilterUpdated ()
	On Updated function for controller filters.
ScriptInvokerInt	GetOnNametagControllerFilterUpdated ()
bool	HasNametagRelationFilters (SCR_ENametagRelationFilter filter)
SCR_ENametagRelationFilter	GetNametagRelationFilters ()
void	SetNametagRelationFilters (SCR_ENametagRelationFilter filters, int playerId=-1)
bool	HasNametagControllerFilter (SCR_ENametagControllerFilter filter)
SCR_ENametagControllerFilter	GetNametagControllerFilters ()
void	SetNametagControllerFilters (SCR_ENametagControllerFilter filters, int playerId=-1)
bool	IsAdditionalArtileryOrderDistancePenaltyEnabled ()
void	SetEnableTeamKillPunishment_S (bool enablePunishment, int playerID=-1)
bool	IsTeamKillingPunished ()
void	SetAllowEntityRefundingAction_S (bool allowRefunding, int playerID=-1)
bool	IsEntityRefundingActionAllowed ()
string	GetEntityRefundingDisabledReason ()
void	SetProjectileBallisticInfoVisibility_S (bool shouldShow, int playerID=-1)
bool	IsVehicleSalvageEnabled ()
void	SetEnableVehicleSalvage_S (bool enableSetting, int playerID=-1)
void	SetNightNoiseEffectState_S (bool disabled)
void	OnNightNoiseSettingChanged ()
void	OnPostInit (IEntity owner)
	Editable Mine.
void	SCR_AdditionalGameModeSettingsComponent (IEntityComponentSource src, IEntity ent, IEntity parent)

Variables
SCR_AdditionalGameModeSettingsComponentClass	SHOW_HOSTILE = 1 << 0
	Show nametags of hostile entities.
SCR_AdditionalGameModeSettingsComponentClass	SHOW_SAME_FACTION = 1 << 1
	Show nametags of members of own faction.
SCR_AdditionalGameModeSettingsComponentClass	SHOW_MILITARY_ALLIES = 1 << 2
	show nametags of military allies of a different faction
SCR_AdditionalGameModeSettingsComponentClass	SHOW_CIVILIAN_ALLIES = 1 << 3
	show nametags of non-military allies of a different faction
SCR_AdditionalGameModeSettingsComponentClass	SHOW_GROUP_MEMBERS = 1 << 4
	Show nametags of members of own group.
SCR_AdditionalGameModeSettingsComponentClass	SHOW_PLAYERS = 1 << 0
	Show nametags of players.
SCR_AdditionalGameModeSettingsComponentClass	SHOW_AI = 1 << 1
	Show nametags of AI.
SCR_AdditionalGameModeSettingsComponentClass	s_Instance = 1 << 1
bool	m_bEnableTeamKillPunishment
bool	m_bAllowEntityRefundingAction
LocalizedString	m_sEntityRefundingDisabledReason
bool	m_bProjectileBallisticInfoVisibility
bool	m_bEnableVehicleSalvage
SCR_ENametagRelationFilter	m_eNametagRelationFilters
SCR_ENametagControllerFilter	m_eNametagControllerFilters
bool	m_bAdditionalArtilleryOrderDistancePenalty
bool	m_bDisableNightNoiseEffect
ref ScriptInvokerInt	m_OnNametagRelationFilterUpdated
ref ScriptInvokerInt	m_OnNametagControllerFilterUpdated
ref ScriptInvokerVoid	m_OnChangeAdditionalSettingsInvoker

Function Documentation

◆ GetEntityRefundingDisabledReason()

string GetEntityRefundingDisabledReason ( )

protected

Returns: Disable reason for action when the player cannot refund. If empty will simply not show the action

Definition at line 271 of file SCR_AdditionalGameModeSettingsComponent.c.

◆ GetNametagControllerFilters()

SCR_ENametagControllerFilter GetNametagControllerFilters ( )

protected

Returns: Current nametag controller filters

Definition at line 175 of file SCR_AdditionalGameModeSettingsComponent.c.

◆ GetNametagRelationFilters()

SCR_ENametagRelationFilter GetNametagRelationFilters ( )

protected

Returns: Current nametag relation filters

Definition at line 138 of file SCR_AdditionalGameModeSettingsComponent.c.

◆ GetOnChangeAdditionalSettingsInvoker()

ScriptInvokerVoid GetOnChangeAdditionalSettingsInvoker ( )

protected

Definition at line 73 of file SCR_AdditionalGameModeSettingsComponent.c.

◆ GetOnNametagControllerFilterUpdated()

ScriptInvokerInt GetOnNametagControllerFilterUpdated ( )

protected

Gets nametag controller filter invoker

Returns: Invoker for when nametag controller filter is updated

Definition at line 120 of file SCR_AdditionalGameModeSettingsComponent.c.

◆ GetOnNametagRelationFilterUpdated()

ScriptInvokerInt GetOnNametagRelationFilterUpdated ( )

protected

Gets nametag relation filter invoker

Returns: Invoker for when nametag relation filter is updated

Definition at line 101 of file SCR_AdditionalGameModeSettingsComponent.c.

◆ GetProjectileBallisticInfoVisibility()

bool GetProjectileBallisticInfoVisibility ( )

protected

Definition at line 67 of file SCR_AdditionalGameModeSettingsComponent.c.

◆ HasNametagControllerFilter()

bool HasNametagControllerFilter ( SCR_ENametagControllerFilter filter )

protected

Checks for given controller filter

Parameters

[in] filter The filter that it checks for

Returns: true or false based on if it has the filter

Definition at line 168 of file SCR_AdditionalGameModeSettingsComponent.c.

◆ HasNametagRelationFilters()

bool HasNametagRelationFilters ( SCR_ENametagRelationFilter filter )

protected

Checks for given relation filter

Parameters

[in] filter The filter that it checks for

Definition at line 131 of file SCR_AdditionalGameModeSettingsComponent.c.

◆ IsAdditionalArtileryOrderDistancePenaltyEnabled()

bool IsAdditionalArtileryOrderDistancePenaltyEnabled ( )

protected

State of the scenario setting that dictates if game should add an additional offset to the position of the artillery command issued by the player

Returns: true if position of the artillery command issued by the player should be spoofed with random offset

Definition at line 204 of file SCR_AdditionalGameModeSettingsComponent.c.

◆ IsEntityRefundingActionAllowed()

bool IsEntityRefundingActionAllowed ( )

protected

Returns: If players are allowed to refund entities

Definition at line 264 of file SCR_AdditionalGameModeSettingsComponent.c.

◆ IsTeamKillingPunished()

bool IsTeamKillingPunished ( )

protected

Returns: whether team killing punishment is enabled.

Definition at line 234 of file SCR_AdditionalGameModeSettingsComponent.c.

◆ IsVehicleSalvageEnabled()

bool IsVehicleSalvageEnabled ( )

protected

Checks if vehicle salvage is enabled

Returns: whether vehicle salvage is enabled

Definition at line 302 of file SCR_AdditionalGameModeSettingsComponent.c.

◆ OnAdditionalSettingsChanged()

void OnAdditionalSettingsChanged ( )

protected

Definition at line 82 of file SCR_AdditionalGameModeSettingsComponent.c.

◆ OnNametagControllerFilterUpdated()

void OnNametagControllerFilterUpdated ( )

protected

On Updated function for controller filters.

Definition at line 111 of file SCR_AdditionalGameModeSettingsComponent.c.

◆ OnNametagRelationFilterUpdated()

void OnNametagRelationFilterUpdated ( )

protected

On Updated function for relation filters.

Definition at line 92 of file SCR_AdditionalGameModeSettingsComponent.c.

◆ OnNightNoiseSettingChanged()

void OnNightNoiseSettingChanged ( )

protected

Definition at line 340 of file SCR_AdditionalGameModeSettingsComponent.c.

◆ SCR_AdditionalGameModeSettingsComponent()

void SCR_AdditionalGameModeSettingsComponent	(	IEntityComponentSource	src,
		IEntity	ent,
		IEntity	parent )

protected

Parameters

[in]	src
[in]	ent
[in]	parent

Definition at line 356 of file SCR_AdditionalGameModeSettingsComponent.c.

◆ SetAllowEntityRefundingAction_S()

void SetAllowEntityRefundingAction_S	(	bool	allowRefunding,
		int	playerID = -1 )

protected

Set if players are allowed to refund entities or not. Note currently only vehicles can be refunded. (Server only)

Parameters

[in]	allowRefunding	Set if vehicles are allowed to be refunded
[in]	playerID	Optional, will send a notification when a player (GM) changes this setting. No notifications are send if playerID is -1

Definition at line 243 of file SCR_AdditionalGameModeSettingsComponent.c.

◆ SetEnableTeamKillPunishment_S()

void SetEnableTeamKillPunishment_S	(	bool	enablePunishment,
		int	playerID = -1 )

protected

Sets team kill punishment is enabled or disabled and notifies players if playerID is provided. (Server only)

Parameters

[in]	enablePunishment	Enable punishment setting for team kills, toggles team kill punishment on or off for all players
[in]	playerID	Player ID is an optional parameter representing the ID of the GM changing the setting. Will send notification if changed

Definition at line 213 of file SCR_AdditionalGameModeSettingsComponent.c.

◆ SetEnableVehicleSalvage_S()

void SetEnableVehicleSalvage_S	(	bool	enableSetting,
		int	playerID = -1 )

protected

Enables or disables vehicle salvage

Parameters

enableSetting	Saves the setting's state
playerID	The ID of the player

Definition at line 311 of file SCR_AdditionalGameModeSettingsComponent.c.

◆ SetNametagControllerFilters()

void SetNametagControllerFilters	(	SCR_ENametagControllerFilter	filters,
		int	playerId = -1 )

protected

Sets controller filter & handles replication

Parameters

[in]	filters	Controller filters to set
[in]	playerId	The ID of the player

Definition at line 184 of file SCR_AdditionalGameModeSettingsComponent.c.

◆ SetNametagRelationFilters()

void SetNametagRelationFilters	(	SCR_ENametagRelationFilter	filters,
		int	playerId = -1 )

protected

Sets relation filter & handles replication

Parameters

[in]	filters	Relation filters to set
[in]	playerId	The ID of the player

Definition at line 147 of file SCR_AdditionalGameModeSettingsComponent.c.

◆ SetNightNoiseEffectState_S()

void SetNightNoiseEffectState_S ( bool disabled )

protected

Parameters

[in] disabled set to true will disable night grain effect for the host and all clients

Definition at line 332 of file SCR_AdditionalGameModeSettingsComponent.c.

◆ SetProjectileBallisticInfoVisibility_S()

void SetProjectileBallisticInfoVisibility_S	(	bool	shouldShow,
		int	playerID = -1 )

protected

Set if game should show ui elements that provide projectile ballistic data.

Parameters

[in]	shouldShow	Set if such ui elements should be visible
[in]	playerID	Optional, will send a notification when a player (GM) changes this setting. No notifications are send if playerID is -1

Definition at line 280 of file SCR_AdditionalGameModeSettingsComponent.c.