SCR_FastTravelComponent.c File Reference

Go to the source code of this file.

Data Structures
class	SCR_FastTravelComponentClass

Functions
void	SetDestination (RplId id, string name)
	Destination must be a replicated item with valid RplId. More...
string	GetDestinationName ()
int	GetCooldown ()
void	DisableAfterUse ()
void	OnSelectionChanged (MapItem item)
RplId	FindDestinationId (IEntity entity)
void	FastTravel ()
protected void	RpcAsk_FastTravel (RplId destinationId)
IEntity	GetEntityByDestinationId (RplId id)
protected bool	ServerSanityCheck (notnull IEntity target)
void	SetNextTransportTimestamp (WorldTimestamp timestamp)
protected void	RpcDo_FastTravel (vector position)
protected void	FadeOut ()
protected void	Teleport ()
protected vector	CalculateDestinationVector (notnull IEntity destination)
protected vector	CalculateDestinationVector (vector targetOrigin)
override void	OnPostInit (IEntity owner)
	Called on PostInit when all components are added. More...
override void	EOnInit (IEntity owner)
void	~SCR_FastTravelComponent ()

Variables
SCR_FastTravelComponentClass	m_PlayerController
protected RplId	m_iDestinationId = RplId.Invalid()
protected string	m_sDestinationName
protected bool	m_bIsDestinationValid
protected bool	m_bDisableAfterUse
protected vector	m_vTeleportCoordinates
protected int	m_iCooldown
protected int	m_iDistanceToTarget
protected string	m_sDestinationType
protected WorldTimestamp	m_fNextTravelAvailableAt

Function Documentation

CalculateDestinationVector() [1/2]

protected vector CalculateDestinationVector

(

notnull IEntity

destination

)

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

Parameters

[in]

destination

Definition at line 285 of file SCR_FastTravelComponent.c.

CalculateDestinationVector() [2/2]

protected vector CalculateDestinationVector

(

vector

targetOrigin

)

Definition at line 291 of file SCR_FastTravelComponent.c.

DisableAfterUse()

void DisableAfterUse

(

)

Definition at line 74 of file SCR_FastTravelComponent.c.

FadeOut()

protected void FadeOut

(

)

Definition at line 258 of file SCR_FastTravelComponent.c.

FastTravel()

void FastTravel

(

)

Definition at line 168 of file SCR_FastTravelComponent.c.

FindDestinationId()

RplId FindDestinationId

(

IEntity

entity

)

Parameters

[in]

entity

Returns

Definition at line 151 of file SCR_FastTravelComponent.c.

GetCooldown()

int GetCooldown

(

)

Returns

Definition at line 67 of file SCR_FastTravelComponent.c.

GetDestinationName()

string GetDestinationName

(

)

Returns

Definition at line 60 of file SCR_FastTravelComponent.c.

GetEntityByDestinationId()

IEntity GetEntityByDestinationId

(

RplId

id

)

Parameters

[in]

id

Returns

Definition at line 206 of file SCR_FastTravelComponent.c.

OnSelectionChanged()

void OnSelectionChanged

(

MapItem

item

)

Parameters

[in]

item

Definition at line 108 of file SCR_FastTravelComponent.c.

RpcAsk_FastTravel()

protected void RpcAsk_FastTravel

(

RplId

destinationId

)

Definition at line 178 of file SCR_FastTravelComponent.c.

RpcDo_FastTravel()

protected void RpcDo_FastTravel

(

vector

position

)

Definition at line 246 of file SCR_FastTravelComponent.c.

ServerSanityCheck()

protected bool ServerSanityCheck

(

notnull IEntity

target

)

Sanity check before the actual teleport

Parameters

[in]

target

Definition at line 229 of file SCR_FastTravelComponent.c.

SetDestination()

void SetDestination	(	RplId	id,
		string	name
	)

Destination must be a replicated item with valid RplId.

Definition at line 51 of file SCR_FastTravelComponent.c.

SetNextTransportTimestamp()

void SetNextTransportTimestamp

(

WorldTimestamp

timestamp

)

Parameters

[in]

timestamp

Definition at line 238 of file SCR_FastTravelComponent.c.

Teleport()

protected void Teleport

(

)

Definition at line 268 of file SCR_FastTravelComponent.c.

~SCR_FastTravelComponent()

void ~SCR_FastTravelComponent

(

)

Definition at line 331 of file SCR_FastTravelComponent.c.

Variable Documentation

m_bDisableAfterUse

protected bool m_bDisableAfterUse

Definition at line 15 of file SCR_FastTravelComponent.c.

m_bIsDestinationValid

protected bool m_bIsDestinationValid

Definition at line 14 of file SCR_FastTravelComponent.c.

m_fNextTravelAvailableAt

protected WorldTimestamp m_fNextTravelAvailableAt

Definition at line 29 of file SCR_FastTravelComponent.c.

m_iCooldown

protected int m_iCooldown

Definition at line 19 of file SCR_FastTravelComponent.c.

m_iDestinationId

protected RplId m_iDestinationId = RplId.Invalid()

Definition at line 10 of file SCR_FastTravelComponent.c.

m_iDistanceToTarget

protected int m_iDistanceToTarget

Definition at line 22 of file SCR_FastTravelComponent.c.

m_PlayerController

SCR_FastTravelComponentClass m_PlayerController

m_sDestinationName

protected string m_sDestinationName

Definition at line 12 of file SCR_FastTravelComponent.c.

m_sDestinationType

protected string m_sDestinationType

Definition at line 25 of file SCR_FastTravelComponent.c.

m_vTeleportCoordinates

protected vector m_vTeleportCoordinates

Definition at line 17 of file SCR_FastTravelComponent.c.