SCR_BaseTourStage Interface Reference

Inheritance diagram for SCR_BaseTourStage:

Public Member Functions
void	~SCR_BaseTourStage ()
Public Member Functions inherited from SCR_BaseCampaignTutorialArlandStage
void	PlaySoundSystem (string audio, bool line=false)
void	Reset ()
void	OnInputDeviceChanged (bool switchedToKeyboard)
void	FlushWaypoints ()
IEntity	GetWaypoint (int index=0)
void	GetWaypointArray (out array< IEntity > arrays)
void	SetPlayer (ChimeraCharacter player)
void	OnStructureBuilt (SCR_CampaignMilitaryBaseComponent base, IEntity structure)
string	CreateString (string description, string keybind, string keybind2="")
bool	IsBuildingModeOpen ()
void	SetupHintConfig ()
override void	EOnPostFrame (IEntity owner, float timeSlice)
override void	EOnFrame (IEntity owner, float timeSlice)
void	SCR_BaseCampaignTutorialArlandStage (IEntitySource src, IEntity parent)

Public Attributes
IEntity	m_AntennaPos
IEntity	m_ArmoryPos
IEntity	m_FieldHospitalPos
IEntity	m_FuelDepotPos
IEntity	m_HQPos
IEntity	m_LivingQuartersPos
IEntity	m_LightVehDepotPos
IEntity	m_HeavyVehDepotPos
IEntity	m_HeliportPos
ref array< IEntity >	m_aVisitedServices = {}
bool	m_bIsShowingHint

Protected Member Functions
override void	Setup ()
bool	IsInRange (IEntity ent, float range)
void	ShowServiceHint (string serviceName)
void	CheckVicinity ()
override bool	GetIsFinished ()
Protected Member Functions inherited from SCR_BaseCampaignTutorialArlandStage
void	CancelHintOnVoiceOver ()
void	HintOnVoiceOver ()
void	ShowHintOnVoiceOver ()
bool	IsSupplyTruckInArea ()
void	Setup ()
bool	GetIsFinished ()
void	DelayedPopup (string text="", string subtitle="", float duration=SCR_PopUpNotification.DEFAULT_DURATION, string param1="", string param2="", string subtitleParam1="", string subtitleParam2="")
void	RegisterWaypoint (string entityName)
void	RegisterWaypoint (IEntity entity)

Additional Inherited Members
Protected Attributes inherited from SCR_BaseCampaignTutorialArlandStage
float	m_fTimer
float	m_fConditionCheckPeriod = 0.25
float	m_fDuration
float	m_fDelay
float	m_fWaypointCompletionRadius = 1
float	m_fWaypointHeightOffset = 0
bool	m_bShowWaypoint = true
bool	m_bCheckWaypoint = true
bool	m_bConditionPassCheck = false
ChimeraCharacter	m_Player
ref array< IEntity >	m_WaypointEntities = {}
SCR_CampaignTutorialArlandComponent	m_TutorialComponent
bool	m_bFinished
Resource	m_HintsConfig
ref SCR_HintTutorialList	m_TutorialHintList
SCR_VoiceoverSystem	m_System
Static Protected Attributes inherited from SCR_BaseCampaignTutorialArlandStage
static const int	DESIRED_FREQUENCY = 60000

Constructor & Destructor Documentation

~SCR_BaseTourStage()

void SCR_BaseTourStage.~SCR_BaseTourStage

(

)

Member Function Documentation

CheckVicinity()

void SCR_BaseTourStage.CheckVicinity ( )

protected

GetIsFinished()

override bool SCR_BaseTourStage.GetIsFinished ( )

protected

Implements SCR_BaseCampaignTutorialArlandStage.

IsInRange()

bool SCR_BaseTourStage.IsInRange ( IEntity  ent, float  range  )

protected

Setup()

override void SCR_BaseTourStage.Setup ( )

protected

Implements SCR_BaseCampaignTutorialArlandStage.

ShowServiceHint()

void SCR_BaseTourStage.ShowServiceHint ( string  serviceName )

protected

Member Data Documentation

m_AntennaPos

IEntity SCR_BaseTourStage.m_AntennaPos

m_ArmoryPos

IEntity SCR_BaseTourStage.m_ArmoryPos

m_aVisitedServices

ref array<IEntity> SCR_BaseTourStage.m_aVisitedServices = {}

m_bIsShowingHint

bool SCR_BaseTourStage.m_bIsShowingHint

m_FieldHospitalPos

IEntity SCR_BaseTourStage.m_FieldHospitalPos

m_FuelDepotPos

IEntity SCR_BaseTourStage.m_FuelDepotPos

m_HeavyVehDepotPos

IEntity SCR_BaseTourStage.m_HeavyVehDepotPos

m_HeliportPos

IEntity SCR_BaseTourStage.m_HeliportPos

m_HQPos

IEntity SCR_BaseTourStage.m_HQPos

m_LightVehDepotPos

IEntity SCR_BaseTourStage.m_LightVehDepotPos

m_LivingQuartersPos

IEntity SCR_BaseTourStage.m_LivingQuartersPos

---

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

• Game/GameMode/Tutorial/Stages/BaseTour/SCR_BaseTourStage.c