SCR_FastTravelComponent Interface Reference

Inheritance diagram for SCR_FastTravelComponent:

Public Member Functions
void	SetDestination (RplId id, string name)
	Destination must be a replicated item with valid RplId.
string	GetDestinationName ()
int	GetCooldown ()
void	DisableAfterUse ()
void	OnSelectionChanged (MapItem item)
RplId	FindDestinationId (IEntity entity)
void	FastTravel ()
IEntity	GetEntityByDestinationId (RplId id)
WorldTimestamp	GetNextTransportTimestamp ()
void	SetNextTransportTimestamp (WorldTimestamp timestamp)
override void	OnPostInit (IEntity owner)
override void	EOnInit (IEntity owner)
void	~SCR_FastTravelComponent ()

Static Public Member Functions
static SCR_FastTravelComponent	GetLocalInstance ()
static void	ToggleMapDestinationSelection (bool enable, bool disableAfterUse=true)
	Toggle fast travel destination selection from the map.

Static Public Attributes
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

Protected Member Functions
void	RpcAsk_FastTravel (RplId destinationId)
bool	ServerSanityCheck (notnull IEntity target)
	Sanity check before the actual teleport.
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
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

Constructor & Destructor Documentation

~SCR_FastTravelComponent()

void SCR_FastTravelComponent.~SCR_FastTravelComponent

(

)

Member Function Documentation

CalculateDestinationVector() [1/2]

vector SCR_FastTravelComponent.CalculateDestinationVector ( notnull IEntity destination )

protected

Find coordinates for player teleport some distance away from the target, azimuth relative to previous player location.

Parameters

[in]

destination

CalculateDestinationVector() [2/2]

vector SCR_FastTravelComponent.CalculateDestinationVector ( vector targetOrigin )

protected

DisableAfterUse()

void SCR_FastTravelComponent.DisableAfterUse

(

)

EOnInit()

override void SCR_FastTravelComponent.EOnInit

(

IEntity

owner

)

Implemented in SCR_CampaignFastTravelComponent.

FadeOut()

void SCR_FastTravelComponent.FadeOut ( )

protected

FastTravel()

void SCR_FastTravelComponent.FastTravel

(

)

FindDestinationId()

RplId SCR_FastTravelComponent.FindDestinationId

(

IEntity

entity

)

Parameters

[in]

entity

Returns

GetCooldown()

int SCR_FastTravelComponent.GetCooldown

(

)

Returns

Implemented in SCR_CampaignFastTravelComponent.

GetDestinationName()

string SCR_FastTravelComponent.GetDestinationName

(

)

Returns

GetEntityByDestinationId()

IEntity SCR_FastTravelComponent.GetEntityByDestinationId

(

RplId

id

)

Parameters

[in]

id

Returns

GetLocalInstance()

static SCR_FastTravelComponent SCR_FastTravelComponent.GetLocalInstance ( )

static

Returns

GetNextTransportTimestamp()

WorldTimestamp SCR_FastTravelComponent.GetNextTransportTimestamp

(

)

OnPostInit()

override void SCR_FastTravelComponent.OnPostInit

(

IEntity

owner

)

OnSelectionChanged()

void SCR_FastTravelComponent.OnSelectionChanged

(

MapItem

item

)

Parameters

[in]

item

RpcAsk_FastTravel()

void SCR_FastTravelComponent.RpcAsk_FastTravel ( RplId destinationId )

protected

RpcDo_FastTravel()

void SCR_FastTravelComponent.RpcDo_FastTravel ( vector position )

protected

ServerSanityCheck()

bool SCR_FastTravelComponent.ServerSanityCheck ( notnull IEntity target )

protected

Sanity check before the actual teleport.

Parameters

[in]

target

Implemented in SCR_CampaignFastTravelComponent.

SetDestination()

void SCR_FastTravelComponent.SetDestination	(	RplId	id,
		string	name )

Destination must be a replicated item with valid RplId.

SetNextTransportTimestamp()

void SCR_FastTravelComponent.SetNextTransportTimestamp

(

WorldTimestamp

timestamp

)

Parameters

[in]

timestamp

Teleport()

void SCR_FastTravelComponent.Teleport ( )

protected

ToggleMapDestinationSelection()

static void SCR_FastTravelComponent.ToggleMapDestinationSelection ( bool enable, bool disableAfterUse = true )

static

Toggle fast travel destination selection from the map.

Parameters

[in]	enable
[in]	disableAfterUse

Member Data Documentation

BLACKSCREEN_DURATION

const float SCR_FastTravelComponent.BLACKSCREEN_DURATION = 1.0

static

CLOSE_MAP_DELAY

const float SCR_FastTravelComponent.CLOSE_MAP_DELAY = 0.75

static

FADE_DURATION

const float SCR_FastTravelComponent.FADE_DURATION = 1.5

static

m_bDisableAfterUse

bool SCR_FastTravelComponent.m_bDisableAfterUse

protected

m_bIsDestinationValid

bool SCR_FastTravelComponent.m_bIsDestinationValid

protected

m_fNextTravelAvailableAt

WorldTimestamp SCR_FastTravelComponent.m_fNextTravelAvailableAt

protected

m_iCooldown

int SCR_FastTravelComponent.m_iCooldown

protected

m_iDestinationId

RplId SCR_FastTravelComponent.m_iDestinationId = RplId.Invalid()

protected

m_iDistanceToTarget

int SCR_FastTravelComponent.m_iDistanceToTarget

protected

m_PlayerController

PlayerController SCR_FastTravelComponent.m_PlayerController

protected

m_sDestinationName

string SCR_FastTravelComponent.m_sDestinationName

protected

m_sDestinationType

string SCR_FastTravelComponent.m_sDestinationType

protected

m_vTeleportCoordinates

vector SCR_FastTravelComponent.m_vTeleportCoordinates

protected

SPAWNING_RADIUS

const int SCR_FastTravelComponent.SPAWNING_RADIUS = 10

static

---

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

• Game/Components/SCR_FastTravelComponent.c