Inheritance diagram for SCR_CampaignFastTravelComponent:

Public Member Functions
void	OnMapOpen (MapConfiguration config)

void	OnMapClose (MapConfiguration config)

bool	IsDestinationReachable (RplId id)

bool	IsDestinationReachable (vector destination)

override void	EOnInit (IEntity owner)

Public Member Functions inherited from SCR_FastTravelComponent
void	SetDestination (RplId id, string name)
	Destination must be a replicated item with valid RplId.

string	GetDestinationName ()

void	DisableAfterUse ()

void	OnSelectionChanged (MapItem item)

RplId	FindDestinationId (IEntity entity)

void	FastTravel ()

IEntity	GetEntityByDestinationId (RplId id)

void	SetNextTransportTimestamp (WorldTimestamp timestamp)

override void	OnPostInit (IEntity owner)

void	~SCR_FastTravelComponent ()

Protected Member Functions
override bool	ServerSanityCheck (notnull IEntity target)
	Sanity check before the actual teleport.

override void	RpcAsk_FastTravel (RplId destinationId)

void	RpcAsk_CheckSpawnpointAvailability (RplId spawnpointId)

void	RpcDo_EnableDestination (RplId spawnpointId)

override int	GetCooldown ()
	Reads the cooldown value from player's rank.

bool	FilterEntity (IEntity ent)

bool	ProcessEntity (IEntity ent)

void	OnMapFastTravelRequested (SCR_SelectionMenuEntry element, float[] worldPos)

void	SendPlayerCoords (vector coords)

void	SetupMapRadialMenuEntries ()

bool	RefreshMainEntry ()

void	CenterMapOnDestination (SCR_SelectionMenuEntry entry, int id)

void	ComposeDestinationList ()

void	RefreshDestinationList ()

void	RefreshShownCooldown ()

void	OnSpawnpointRemoved (SCR_SpawnPoint spawnpoint)

void	OnSpawnpointAdded (SCR_SpawnPoint spawnpoint)

void	ToggleDestinationSelection (bool enable)

Protected Member Functions inherited from SCR_FastTravelComponent
void	RpcDo_FastTravel (vector position)

void	FadeOut ()

void	Teleport ()

vector	CalculateDestinationVector (notnull IEntity destination)
	Find coordinates for player teleport some distance away from the target, azimuth relative to previous player location.

vector	CalculateDestinationVector (vector targetOrigin)

Protected Attributes
bool	m_bSelectionInProgress

bool	m_bEnemiesNearby

SCR_MapRadialUI	m_MapContextualMenu

SCR_SelectionMenuCategoryEntry	m_MainEntry

SCR_CampaignFaction	m_PlayerFaction

ref map< SCR_SelectionMenuEntry, SCR_DeployableSpawnPoint >	m_mMenuEntries = new map<SCR_SelectionMenuEntry, SCR_DeployableSpawnPoint>()

Protected Attributes inherited from SCR_FastTravelComponent
PlayerController	m_PlayerController

RplId	m_iDestinationId = RplId.Invalid()

string	m_sDestinationName

bool	m_bIsDestinationValid

bool	m_bDisableAfterUse

vector	m_vTeleportCoordinates

int	m_iCooldown

int	m_iDistanceToTarget

string	m_sDestinationType

WorldTimestamp	m_fNextTravelAvailableAt

Additional Inherited Members
Static Public Member Functions inherited from SCR_FastTravelComponent
static SCR_FastTravelComponent	GetLocalInstance ()

static void	ToggleMapDestinationSelection (bool enable, bool disableAfterUse=true)
	Toggle fast travel destination selection from the map.

Static Public Attributes inherited from SCR_FastTravelComponent
static const int	SPAWNING_RADIUS = 10

static const float	FADE_DURATION = 1.5

static const float	BLACKSCREEN_DURATION = 1.0

static const float	CLOSE_MAP_DELAY = 0.75

Member Function Documentation

◆ CenterMapOnDestination()

void SCR_CampaignFastTravelComponent.CenterMapOnDestination	(	SCR_SelectionMenuEntry	entry,
		int	id )

protected

◆ ComposeDestinationList()

void SCR_CampaignFastTravelComponent.ComposeDestinationList ( )

protected

◆ EOnInit()

override void SCR_CampaignFastTravelComponent.EOnInit ( IEntity owner )

Implements SCR_FastTravelComponent.

◆ FilterEntity()

bool SCR_CampaignFastTravelComponent.FilterEntity ( IEntity ent )

protected

◆ GetCooldown()

override int SCR_CampaignFastTravelComponent.GetCooldown ( )

protected

Reads the cooldown value from player's rank.

Implements SCR_FastTravelComponent.

◆ IsDestinationReachable() [1/2]

bool SCR_CampaignFastTravelComponent.IsDestinationReachable ( RplId id )

Parameters

[in] id

Returns

◆ IsDestinationReachable() [2/2]

bool SCR_CampaignFastTravelComponent.IsDestinationReachable ( vector destination )

Parameters

[in] destination

Returns

◆ OnMapClose()

void SCR_CampaignFastTravelComponent.OnMapClose ( MapConfiguration config )

Parameters

[in] config

◆ OnMapFastTravelRequested()

void SCR_CampaignFastTravelComponent.OnMapFastTravelRequested	(	SCR_SelectionMenuEntry	element,
		float[]	worldPos )

protected

◆ OnMapOpen()

void SCR_CampaignFastTravelComponent.OnMapOpen ( MapConfiguration config )

Parameters

[in] config

◆ OnSpawnpointAdded()

void SCR_CampaignFastTravelComponent.OnSpawnpointAdded ( SCR_SpawnPoint spawnpoint )

protected

◆ OnSpawnpointRemoved()

void SCR_CampaignFastTravelComponent.OnSpawnpointRemoved ( SCR_SpawnPoint spawnpoint )

protected

◆ ProcessEntity()

bool SCR_CampaignFastTravelComponent.ProcessEntity ( IEntity ent )

protected

◆ RefreshDestinationList()

void SCR_CampaignFastTravelComponent.RefreshDestinationList ( )

protected

◆ RefreshMainEntry()

bool SCR_CampaignFastTravelComponent.RefreshMainEntry ( )

protected

◆ RefreshShownCooldown()

void SCR_CampaignFastTravelComponent.RefreshShownCooldown ( )

protected

◆ RpcAsk_CheckSpawnpointAvailability()

void SCR_CampaignFastTravelComponent.RpcAsk_CheckSpawnpointAvailability ( RplId spawnpointId )

protected

◆ RpcAsk_FastTravel()

override void SCR_CampaignFastTravelComponent.RpcAsk_FastTravel ( RplId destinationId )

protected

Implements SCR_FastTravelComponent.

◆ RpcDo_EnableDestination()

void SCR_CampaignFastTravelComponent.RpcDo_EnableDestination ( RplId spawnpointId )

protected

◆ SendPlayerCoords()

void SCR_CampaignFastTravelComponent.SendPlayerCoords ( vector coords )

protected

◆ ServerSanityCheck()

override bool SCR_CampaignFastTravelComponent.ServerSanityCheck ( notnull IEntity target )

protected

Sanity check before the actual teleport.

Parameters

[in] target

Implements SCR_FastTravelComponent.

◆ SetupMapRadialMenuEntries()

void SCR_CampaignFastTravelComponent.SetupMapRadialMenuEntries ( )

protected

◆ ToggleDestinationSelection()

void SCR_CampaignFastTravelComponent.ToggleDestinationSelection ( bool enable )

protected

Member Data Documentation

◆ m_bEnemiesNearby

bool SCR_CampaignFastTravelComponent.m_bEnemiesNearby

protected

◆ m_bSelectionInProgress

bool SCR_CampaignFastTravelComponent.m_bSelectionInProgress

protected

◆ m_MainEntry

SCR_SelectionMenuCategoryEntry SCR_CampaignFastTravelComponent.m_MainEntry

protected

◆ m_MapContextualMenu

SCR_MapRadialUI SCR_CampaignFastTravelComponent.m_MapContextualMenu

protected

◆ m_mMenuEntries

ref map<SCR_SelectionMenuEntry, SCR_DeployableSpawnPoint> SCR_CampaignFastTravelComponent.m_mMenuEntries = new map<SCR_SelectionMenuEntry, SCR_DeployableSpawnPoint>()

protected

◆ m_PlayerFaction

SCR_CampaignFaction SCR_CampaignFastTravelComponent.m_PlayerFaction

protected

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

Game/Components/SCR_CampaignFastTravelComponent.c

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Function Documentation

◆ CenterMapOnDestination()

◆ ComposeDestinationList()

◆ EOnInit()

◆ FilterEntity()

◆ GetCooldown()

◆ IsDestinationReachable() [1/2]

◆ IsDestinationReachable() [2/2]

◆ OnMapClose()

◆ OnMapFastTravelRequested()

◆ OnMapOpen()

◆ OnSpawnpointAdded()

◆ OnSpawnpointRemoved()

◆ ProcessEntity()

◆ RefreshDestinationList()

◆ RefreshMainEntry()

◆ RefreshShownCooldown()

◆ RpcAsk_CheckSpawnpointAvailability()

◆ RpcAsk_FastTravel()

◆ RpcDo_EnableDestination()

◆ SendPlayerCoords()

◆ ServerSanityCheck()

◆ SetupMapRadialMenuEntries()

◆ ToggleDestinationSelection()

Member Data Documentation

◆ m_bEnemiesNearby

◆ m_bSelectionInProgress

◆ m_MainEntry

◆ m_MapContextualMenu

◆ m_mMenuEntries

◆ m_PlayerFaction