SCR_BaseTutorialStage Class Reference

Inheritance diagram for SCR_BaseTutorialStage:

Protected Member Functions
SCR_TutorialStageInfo	GetStageInfo ()
float	GetDuration ()
void	CreateMarkerPath (string pathEntityName)
SCR_MapMarkerBase	CreateMarkerCustom (string entityName, SCR_EScenarioFrameworkMarkerCustom icon, SCR_EScenarioFrameworkMarkerCustomColor color, string name=string.Empty)
SCR_MapMarkerBase	CreateMarkerCustom (notnull IEntity entity, SCR_EScenarioFrameworkMarkerCustom icon, SCR_EScenarioFrameworkMarkerCustomColor color, string name=string.Empty)
SCR_MapMarkerBase	CreateMarkerMilitary (string entityName, SCR_EScenarioFrameworkMarkerCustom icon, SCR_EScenarioFrameworkMarkerCustomColor color, string name=string.Empty)
SCR_MapMarkerBase	CreateMarkerMilitary (notnull IEntity entity, EMilitarySymbolIdentity factionIdentity, EMilitarySymbolDimension dimension, EMilitarySymbolIcon typeFlags, string name=string.Empty)
void	RegisterMarker (notnull SCR_MapMarkerBase marker, notnull IEntity entity)
void	DeleteMarker (SCR_MapMarkerBase marker)
int	GetQuickslotIndexByPrefab (ResourceName prefabName)
void	ShowHint (int index=0)
void	Setup ()
bool	GetIsFinished ()
void	Reset ()
void	OnInputDeviceChanged (bool switchedToKeyboard)
void	OnVoiceoverEventFinishedBase (string eventName)
void	OnVoiceoverEventFinished (string eventName)
void	HintGamepad (bool isSilent=false)
void	HintKeyboard (bool isSilent=false)
void	DelayedPopup (string text="", string subtitle="", float duration=SCR_PopUpNotification.DEFAULT_DURATION, string param1="", string param2="", string subtitleParam1="", string subtitleParam2="")
void	UnregisterWaypoint (IEntity waypointEntity)
void	UnregisterWaypoint (string waypointName)
SCR_Waypoint	RegisterWaypoint (string entityName, string title=string.Empty, string icon="MISC")
SCR_Waypoint	RegisterWaypoint (notnull IEntity entity, string title=string.Empty, string icon="MISC")
SCR_Waypoint	GetWaypoint (int index=0)
void	OnStructureBuilt (SCR_CampaignMilitaryBaseComponent base, IEntity structure)
bool	IsBuildingModeOpen ()
override void	EOnFrame (IEntity owner, float timeSlice)
void	OnStageFinished ()
bool	CheckWaypoints ()
void	Init (SCR_TutorialStageInfo stageInfo)
void	~SCR_BaseTutorialStage ()
void	PlayNarrativeCharacterStage (string characterName, int stage)
void	SetPermanentNarrativeStage (string characterName, int stage)
int	GetSuppliesInInventory ()
void	FinishStage ()

Protected Attributes
float	m_fTimer
float	m_fStageTimer
float	m_fConditionCheckPeriod = 0.25
float	m_fDuration
float	m_fDelay
float	m_fWaypointCompletionRadius = 1
bool	m_bShowWaypoint = true
bool	m_bCheckWaypoint = true
bool	m_bConditionCheckOnSetDuration
bool	m_bAutoShowHint = true
bool	m_bInstantConditionCheck
string	m_sLastFinishedEvent
float	m_fStartTimestamp
string	m_sHintSoundEvent
SCR_Waypoint	m_ReachedWaypoint
ChimeraCharacter	m_Player
ref array< SCR_Waypoint >	m_aStageWaypoints
SCR_TutorialGamemodeComponent	m_TutorialComponent
bool	m_bFinished
Resource	m_HintsConfig
SCR_TutorialStageInfo	m_StageInfo
SCR_BaseTutorialCourseLogic	m_Logic

Detailed Description

Definition at line 7 of file SCR_BaseTutorialStage.c.

Constructor & Destructor Documentation

~SCR_BaseTutorialStage()

void SCR_BaseTutorialStage::~SCR_BaseTutorialStage ( )

inlineprotected

Definition at line 491 of file SCR_BaseTutorialStage.c.

Member Function Documentation

CheckWaypoints()

bool SCR_BaseTutorialStage::CheckWaypoints ( )

inlineprotected

Definition at line 436 of file SCR_BaseTutorialStage.c.

CreateMarkerCustom() [1/2]

SCR_MapMarkerBase SCR_BaseTutorialStage::CreateMarkerCustom ( notnull IEntity entity, SCR_EScenarioFrameworkMarkerCustom icon, SCR_EScenarioFrameworkMarkerCustomColor color, string name = string.Empty )

inlineprotected

Definition at line 75 of file SCR_BaseTutorialStage.c.

CreateMarkerCustom() [2/2]

SCR_MapMarkerBase SCR_BaseTutorialStage::CreateMarkerCustom ( string entityName, SCR_EScenarioFrameworkMarkerCustom icon, SCR_EScenarioFrameworkMarkerCustomColor color, string name = string.Empty )

inlineprotected

Definition at line 65 of file SCR_BaseTutorialStage.c.

CreateMarkerMilitary() [1/2]

SCR_MapMarkerBase SCR_BaseTutorialStage::CreateMarkerMilitary ( notnull IEntity entity, EMilitarySymbolIdentity factionIdentity, EMilitarySymbolDimension dimension, EMilitarySymbolIcon typeFlags, string name = string.Empty )

inlineprotected

Definition at line 104 of file SCR_BaseTutorialStage.c.

CreateMarkerMilitary() [2/2]

SCR_MapMarkerBase SCR_BaseTutorialStage::CreateMarkerMilitary ( string entityName, SCR_EScenarioFrameworkMarkerCustom icon, SCR_EScenarioFrameworkMarkerCustomColor color, string name = string.Empty )

inlineprotected

Definition at line 93 of file SCR_BaseTutorialStage.c.

CreateMarkerPath()

void SCR_BaseTutorialStage::CreateMarkerPath ( string pathEntityName )

inlineprotected

Definition at line 48 of file SCR_BaseTutorialStage.c.

DelayedPopup()

void SCR_BaseTutorialStage::DelayedPopup ( string text = "", string subtitle = "", float duration = SCR_PopUpNotification.DEFAULT_DURATION, string param1 = "", string param2 = "", string subtitleParam1 = "", string subtitleParam2 = "" )

inlineprotected

Definition at line 264 of file SCR_BaseTutorialStage.c.

DeleteMarker()

void SCR_BaseTutorialStage::DeleteMarker ( SCR_MapMarkerBase marker )

inlineprotected

Definition at line 142 of file SCR_BaseTutorialStage.c.

EOnFrame()

override void SCR_BaseTutorialStage::EOnFrame ( IEntity owner, float timeSlice )

inlineprotected

Definition at line 364 of file SCR_BaseTutorialStage.c.

FinishStage()

void SCR_BaseTutorialStage::FinishStage ( )

inlineprotected

Definition at line 557 of file SCR_BaseTutorialStage.c.

GetDuration()

float SCR_BaseTutorialStage::GetDuration ( )

inlineprotected

Definition at line 42 of file SCR_BaseTutorialStage.c.

GetIsFinished()

bool SCR_BaseTutorialStage::GetIsFinished ( )

inlineprotected

Definition at line 214 of file SCR_BaseTutorialStage.c.

GetQuickslotIndexByPrefab()

int SCR_BaseTutorialStage::GetQuickslotIndexByPrefab ( ResourceName prefabName )

inlineprotected

Definition at line 159 of file SCR_BaseTutorialStage.c.

GetStageInfo()

SCR_TutorialStageInfo SCR_BaseTutorialStage::GetStageInfo ( )

inlineprotected

Definition at line 36 of file SCR_BaseTutorialStage.c.

GetSuppliesInInventory()

int SCR_BaseTutorialStage::GetSuppliesInInventory ( )

inlineprotected

Definition at line 534 of file SCR_BaseTutorialStage.c.

GetWaypoint()

SCR_Waypoint SCR_BaseTutorialStage::GetWaypoint ( int index = 0 )

inlineprotected

Definition at line 329 of file SCR_BaseTutorialStage.c.

HintGamepad()

void SCR_BaseTutorialStage::HintGamepad ( bool isSilent = false )

inlineprotected

Definition at line 254 of file SCR_BaseTutorialStage.c.

HintKeyboard()

void SCR_BaseTutorialStage::HintKeyboard ( bool isSilent = false )

inlineprotected

Definition at line 259 of file SCR_BaseTutorialStage.c.

Init()

void SCR_BaseTutorialStage::Init ( SCR_TutorialStageInfo stageInfo )

inlineprotected

Definition at line 454 of file SCR_BaseTutorialStage.c.

IsBuildingModeOpen()

bool SCR_BaseTutorialStage::IsBuildingModeOpen ( )

inlineprotected

Definition at line 343 of file SCR_BaseTutorialStage.c.

OnInputDeviceChanged()

void SCR_BaseTutorialStage::OnInputDeviceChanged ( bool switchedToKeyboard )

inlineprotected

Definition at line 225 of file SCR_BaseTutorialStage.c.

OnStageFinished()

void SCR_BaseTutorialStage::OnStageFinished ( )

inlineprotected

Definition at line 427 of file SCR_BaseTutorialStage.c.

OnStructureBuilt()

void SCR_BaseTutorialStage::OnStructureBuilt ( SCR_CampaignMilitaryBaseComponent base, IEntity structure )

inlineprotected

Definition at line 338 of file SCR_BaseTutorialStage.c.

OnVoiceoverEventFinished()

void SCR_BaseTutorialStage::OnVoiceoverEventFinished ( string eventName )

inlineprotected

Definition at line 249 of file SCR_BaseTutorialStage.c.

OnVoiceoverEventFinishedBase()

void SCR_BaseTutorialStage::OnVoiceoverEventFinishedBase ( string eventName )

inlineprotected

Definition at line 234 of file SCR_BaseTutorialStage.c.

PlayNarrativeCharacterStage()

void SCR_BaseTutorialStage::PlayNarrativeCharacterStage ( string characterName, int stage )

inlineprotected

Definition at line 510 of file SCR_BaseTutorialStage.c.

RegisterMarker()

void SCR_BaseTutorialStage::RegisterMarker ( notnull SCR_MapMarkerBase marker, notnull IEntity entity )

inlineprotected

Definition at line 119 of file SCR_BaseTutorialStage.c.

RegisterWaypoint() [1/2]

SCR_Waypoint SCR_BaseTutorialStage::RegisterWaypoint ( notnull IEntity entity, string title = string.Empty, string icon = "MISC" )

inlineprotected

Definition at line 303 of file SCR_BaseTutorialStage.c.

RegisterWaypoint() [2/2]

SCR_Waypoint SCR_BaseTutorialStage::RegisterWaypoint ( string entityName, string title = string.Empty, string icon = "MISC" )

inlineprotected

Definition at line 293 of file SCR_BaseTutorialStage.c.

Reset()

void SCR_BaseTutorialStage::Reset ( )

inlineprotected

Definition at line 220 of file SCR_BaseTutorialStage.c.

SetPermanentNarrativeStage()

void SCR_BaseTutorialStage::SetPermanentNarrativeStage ( string characterName, int stage )

inlineprotected

Definition at line 518 of file SCR_BaseTutorialStage.c.

Setup()

void SCR_BaseTutorialStage::Setup ( )

inlineprotected

Definition at line 208 of file SCR_BaseTutorialStage.c.

ShowHint()

void SCR_BaseTutorialStage::ShowHint ( int index = 0 )

inlineprotected

Definition at line 192 of file SCR_BaseTutorialStage.c.

UnregisterWaypoint() [1/2]

void SCR_BaseTutorialStage::UnregisterWaypoint ( IEntity waypointEntity )

inlineprotected

Definition at line 270 of file SCR_BaseTutorialStage.c.

UnregisterWaypoint() [2/2]

void SCR_BaseTutorialStage::UnregisterWaypoint ( string waypointName )

inlineprotected

Definition at line 285 of file SCR_BaseTutorialStage.c.

Member Data Documentation

m_aStageWaypoints

ref array<SCR_Waypoint> SCR_BaseTutorialStage::m_aStageWaypoints

protected

Definition at line 28 of file SCR_BaseTutorialStage.c.

m_bAutoShowHint

bool SCR_BaseTutorialStage::m_bAutoShowHint = true

protected

Definition at line 19 of file SCR_BaseTutorialStage.c.

m_bCheckWaypoint

bool SCR_BaseTutorialStage::m_bCheckWaypoint = true

protected

Definition at line 17 of file SCR_BaseTutorialStage.c.

m_bConditionCheckOnSetDuration

bool SCR_BaseTutorialStage::m_bConditionCheckOnSetDuration

protected

Definition at line 18 of file SCR_BaseTutorialStage.c.

m_bFinished

bool SCR_BaseTutorialStage::m_bFinished

protected

Definition at line 30 of file SCR_BaseTutorialStage.c.

m_bInstantConditionCheck

bool SCR_BaseTutorialStage::m_bInstantConditionCheck

protected

Definition at line 20 of file SCR_BaseTutorialStage.c.

m_bShowWaypoint

bool SCR_BaseTutorialStage::m_bShowWaypoint = true

protected

Definition at line 16 of file SCR_BaseTutorialStage.c.

m_fConditionCheckPeriod

float SCR_BaseTutorialStage::m_fConditionCheckPeriod = 0.25

protected

Definition at line 11 of file SCR_BaseTutorialStage.c.

m_fDelay

float SCR_BaseTutorialStage::m_fDelay

protected

Definition at line 13 of file SCR_BaseTutorialStage.c.

m_fDuration

float SCR_BaseTutorialStage::m_fDuration

protected

Definition at line 12 of file SCR_BaseTutorialStage.c.

m_fStageTimer

float SCR_BaseTutorialStage::m_fStageTimer

protected

Definition at line 10 of file SCR_BaseTutorialStage.c.

m_fStartTimestamp

float SCR_BaseTutorialStage::m_fStartTimestamp

protected

Definition at line 22 of file SCR_BaseTutorialStage.c.

m_fTimer

float SCR_BaseTutorialStage::m_fTimer

protected

Definition at line 9 of file SCR_BaseTutorialStage.c.

m_fWaypointCompletionRadius

float SCR_BaseTutorialStage::m_fWaypointCompletionRadius = 1

protected

Definition at line 14 of file SCR_BaseTutorialStage.c.

m_HintsConfig

Resource SCR_BaseTutorialStage::m_HintsConfig

protected

Definition at line 31 of file SCR_BaseTutorialStage.c.

m_Logic

SCR_BaseTutorialCourseLogic SCR_BaseTutorialStage::m_Logic

protected

Definition at line 33 of file SCR_BaseTutorialStage.c.

m_Player

ChimeraCharacter SCR_BaseTutorialStage::m_Player

protected

Definition at line 27 of file SCR_BaseTutorialStage.c.

m_ReachedWaypoint

SCR_Waypoint SCR_BaseTutorialStage::m_ReachedWaypoint

protected

Definition at line 25 of file SCR_BaseTutorialStage.c.

m_sHintSoundEvent

string SCR_BaseTutorialStage::m_sHintSoundEvent

protected

Definition at line 23 of file SCR_BaseTutorialStage.c.

m_sLastFinishedEvent

string SCR_BaseTutorialStage::m_sLastFinishedEvent

protected

Definition at line 21 of file SCR_BaseTutorialStage.c.

m_StageInfo

SCR_TutorialStageInfo SCR_BaseTutorialStage::m_StageInfo

protected

Definition at line 32 of file SCR_BaseTutorialStage.c.

m_TutorialComponent

SCR_TutorialGamemodeComponent SCR_BaseTutorialStage::m_TutorialComponent

protected

Definition at line 29 of file SCR_BaseTutorialStage.c.

---

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

• scripts/Game/GameMode/Tutorial/Logic/SCR_BaseTutorialStage.c