Inheritance diagram for SCR_TutorialGamemodeComponent:

[legend]

Public Member Functions
void	BlockBuildingModeAccess (notnull IEntity providerEntity, bool block)

void	EnableRefunding (IEntity ent, bool enable)

void	SaveViewDistance (float distance)

float	GetSavedViewDistance ()

void	SetupTargets (string parentTargetName, out array< SCR_FiringRangeTarget > targets=null, ETargetState setupState=-1, bool setupAutoReset=true)

void	RepairWorldVehicles ()

void	HandleGarbage (bool force=false)

void	RemoveFromGarbage (IEntity ent)

void	InsertIntoGarbage (string entityName)

void	InsertIntoGarbage (IEntity ent)

void	ChangeVehicleLockState (notnull IEntity vehicle, bool lock)

int	GetRemainingAmmo ()

int	GetAmmoCountForWeapon (IEntity weapon)

void	LoadProgress (SCR_ETutorialCourses completedCourses)

void	SetSavedTime (float time)

float	GetSavedTime ()

SCR_ETutorialCourses	GetFinishedCourses ()

void	MoveCharacterIntoVehicle (notnull ChimeraCharacter character, notnull Vehicle vehicle, ECompartmentType compartmentType, int compartmentIndex=0)

ScriptInvoker	GetOnPlayerSpawned ()

void	HealPlayer ()

void	RequestBreakCourse (SCR_ETutorialBreakType breakType)

void	FinalizeBreak ()

bool	IsCourseBreaking ()

void	EnableControls (bool enable)

Widget	CreateWarningOverlay (bool killedNPC)

bool	CanBreakCourse ()

SCR_BaseTutorialStage	GetCurrentStage ()

WidgetAnimationOpacity	GetOngoingFadeAnimation ()

void	PlayNarrativeCharacterStageDelayed (string characterName, int stage)

void	RegisterMarker (notnull SCR_MapMarkerBase marker)

ScriptInvoker	GetOnFastTravelDone ()

IEntity	FindPrefabInPlayerInventory (ResourceName prefabName)

bool	IsEntityInPlayerInventory (string entityName)

bool	IsEntityInPlayerInventory (IEntity entity)

SCR_InventoryStorageManagerComponent	GetPlayerInventory ()

void	HandlePlayerGroup ()

void	EnableArsenal (string entityName, bool enable)

SCR_TutorialCoursesConfig	GetCoursesConfig ()

SCR_TutorialCourseTask	GetCourseTask (SCR_ETutorialCourses course)

bool	IsFastTraveling ()

void	SpawnPlayer (string spawnPositionName)

SCR_TutorialInstructorComponent	GetCourseInstructor (SCR_ETutorialCourses course)

void	GetInstructors (notnull array< SCR_TutorialInstructorComponent > instructors)

void	UnregisterInstructor (notnull SCR_TutorialInstructorComponent instructor)

void	RegisterInstructor (notnull SCR_TutorialInstructorComponent instructor)

bool	IsCourseAvailable (SCR_ETutorialCourses courseType)

void	FastTravelToCourse (SCR_ETutorialCourses course)

void	FastTravel (notnull IEntity toEnt)

SCR_TutorialCourse	GetActiveConfig ()

void	HandleAchievement ()

void	ShowMapDescriptor (string descriptorOwnerName, bool enable)

bool	IsPlayerAimingInAngle (float angle, int tolerance)

void	OnModeAdded (SCR_EditorModeEntity modeEntity)

SCR_PreviewEntityEditorComponent	GetPreviewEntityComponent ()

void	SetupEditorModeListener ()

ScriptInvoker	GetOnEntitySpawned ()

void	OnInputDeviceChangedDelayed ()

ChimeraCharacter	GetPlayer ()

bool	GamepadUsed ()

WidgetAnimationOpacity	Fadeout (bool fadeOut, float duration=1, float soundDuration=duration)

IEntity	SpawnAsset (string name, ResourceName type, IEntity spawnpoint=null, bool respawn=true)

void	OnMapOpen (MapConfiguration config)

void	OnMapClose (MapConfiguration config)

bool	GetIsMapOpen ()

bool	CheckCharacterStance (ECharacterCommandIDs command)
	TODO> MOVE TO OBSTACLE COURSE LOGIC.

int	GetFreeRoamActivations ()

void	SetFreeRoamActivation (int activations)

void	IncrementFreeRoamActivation ()

void	Check3rdPersonViewUsed ()

bool	GetWas3rdPersonViewUsed ()

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

void	OnStructureBuilt (SCR_CampaignMilitaryBaseComponent base, IEntity structure)

SCR_WaypointDisplay	GetWaypointDisplay ()

void	InsertStage (string stageName, int position=-1)

int	GetActiveStageIndex ()

void	FinishStage ()

int	GetStageIndexByName (string name)

void	SetStage (string stageName)

void	SetStage (int stage)

void	SetCourseConfig (SCR_ETutorialCourses config, string stageName=string.Empty, bool spawnAssets=true)

void	OnCharacterDamaged (BaseDamageContext damageContext)

bool	IsDamagedOrDestroyed (notnull IEntity ent)

void	SpawnCourseAssets (SCR_ETutorialCourses courseType=-1)

void	DespawnCourseAssets ()

override void	OnPlayerRegistered (int playerId)
	Called on every machine after a player is registered (identity, name etc.).

override void	OnPlayerSpawnFinalize_S (SCR_SpawnRequestComponent requestComponent, SCR_SpawnHandlerComponent handlerComponent, SCR_SpawnData data, IEntity entity)

void	PlayBedAnimation (bool fast)

override void	OnControllableDestroyed (notnull SCR_InstigatorContextData instigatorContextData)
	When a controllable entity is destroyed, this event is raised.

void	HideTasks (bool hide)

override void	OnDelete (IEntity owner)

void	~SCR_TutorialGamemodeComponent ()

Public Member Functions inherited from SCR_BaseGameModeComponent
SCR_BaseGameMode	GetGameMode ()

void	OnGameEnd ()
	Called on all machines when the world ends.

void	OnGameStateChanged (SCR_EGameModeState state)
	Called when game mode state changes called on all machines.

void	OnGameModeStart ()
	Called on every machine when game mode starts.

void	OnGameModeEnd (SCR_GameModeEndData data)
	Called when game mode ends.

void	OnPlayerConnected (int playerId)
	Called after a player is connected.

void	OnPlayerAuditSuccess (int playerId)
	Event is called when player connecting Session hosting current Game Mode where is required authentication verification via.

void	OnPlayerAuditFail (int playerId)
	Event is called when player connecting Session hosting current Game Mode AuditFail() call may be called under two occasions: 1) verification is required but failed (account is not valid, player is banned, internet issues) 2) player cannot be verified as authentication is not required or possible - where it may be valid behavior (server online connectivity turned off for example) Basically non-audited player cannot access persistency/ etc.

void	OnPlayerAuditTimeouted (int playerId)
	Event is called when player connected to Session was kicked and did not reconnected in time This mean that slot reservation can be canceled.

void	OnPlayerAuditRevived (int playerId)
	Event is called when player reconnected successfully back to Session after kick This mean that slot reservation need to be finished (closed).

void	OnPlayerRegistered (int playerId)
	Called on every machine after a player is registered (identity, name etc.).

void	OnPlayerDisconnected (int playerId, KickCauseCode cause, int timeout)
	Called after a player is disconnected.

void	OnPlayerSpawned (int playerId, IEntity controlledEntity)
	Called after a player is spawned.

bool	PreparePlayerEntity_S (SCR_SpawnRequestComponent requestComponent, SCR_SpawnHandlerComponent handlerComponent, SCR_SpawnData data, IEntity entity)

void	OnSpawnPlayerEntityFailure_S (SCR_SpawnRequestComponent requestComponent, SCR_SpawnHandlerComponent handlerComponent, IEntity entity, SCR_SpawnData data, SCR_ESpawnResult reason)

void	OnPlayerSpawnFinalize_S (SCR_SpawnRequestComponent requestComponent, SCR_SpawnHandlerComponent handlerComponent, SCR_SpawnData data, IEntity entity)

bool	HandlePlayerKilled (int playerId, IEntity playerEntity, IEntity killerEntity, notnull Instigator instigator)
	See SCR_BaseGameMode.HandlePlayerKilled.

void	OnPlayerKilled (notnull SCR_InstigatorContextData instigatorContextData)
	Called after a player gets killed.

void	OnPlayerKilledHandled (int playerId, IEntity playerEntity, IEntity killerEntity, notnull Instigator instigator)
	Called after player gets killed in cases where the kill was handled by the game mode, supressing the default OnPlayerKilled behaviour.

void	OnPlayerDeleted (int playerId, IEntity player)
	Called after a player gets deleted.

void	OnPlayerRoleChange (int playerId, EPlayerRole roleFlags)
	Called when player role changes.

void	OnWorldPostProcess (World world)
	Called once loading of all entities of the world have been finished (still within the loading)

void	HandleOnLoadoutAssigned (int playerID, SCR_BasePlayerLoadout assignedLoadout)
	What happens when a player is assigned a loadout.

void	HandleOnFactionAssigned (int playerID, Faction assignedFaction)
	What happens when a player is assigned a faction.

void	HandleOnSpawnPointAssigned (int playerID, SCR_SpawnPoint spawnPoint)
	What happens when a player is assigned a spawn point.

void	OnControllableSpawned (IEntity entity)
	When a controllable entity is spawned, this event is raised.

void	OnControllableDestroyed (notnull SCR_InstigatorContextData instigatorContextData)
	When a controllable entity is destroyed, this event is raised.

void	OnControllableDeleted (IEntity entity)
	Prior to a controllable entity being DELETED, this event is raised.

void	SCR_BaseGameModeComponent (IEntityComponentSource src, IEntity ent, IEntity parent)

Static Public Member Functions
static SCR_TutorialGamemodeComponent	GetInstance ()

Protected Member Functions
void	OnVehicleDamaged (SCR_VehicleDamageManagerComponent damageManager)

void	HandleRespawnBreak ()

void	CreateCourseTask (SCR_ETutorialCourses courseType)

void	OnFastTravelFadeoutCompleted ()

void	OnFastTravelPreloadFinished ()

void	SetupVoiceSystem ()

void	RemovePlayerMapMarkers ()

SCR_PlacingEditorComponent	GetPlacingComponent ()

void	OnEntitySpawned (int prefabID, SCR_EditableEntityComponent ent)

void	OnObjectDestroyed (EDamageState state)

void	OnInputDeviceIsGamepad (bool isGamepad)

override void	OnGameModeStart ()
	Called on every machine when game mode starts.

void	GenerateTasks ()

void	CheckAreaRestrictions ()

void	SetSoundFade (bool fadeOut, float duration=0)

void	HandleSoundFade (float timeSlice)

override void	EOnFrame (IEntity owner, float timeSlice)

override void	OnPostInit (IEntity owner)

void	LoadCoursesConfig ()

Protected Attributes
ResourceName	m_sCoursesConfigResourceName

ResourceName	m_sPlayerVehicleResourceName

ChimeraCharacter	m_Player

ref SCR_TutorialCoursesConfig	m_CoursesConfig

ref array< ref SCR_TutorialStageInfo >	m_aStageInfos = {}

ref array< ref SCR_MapMarkerBase >	m_aMarkers = {}

int	m_iActiveStage

SCR_BaseTutorialStage	m_Stage

ImageWidget	m_wFadeOut

bool	m_bFirstStageSet

bool	m_bIsMapOpen = false

bool	m_bUsed3PV = false

bool	m_fDelayedControlSchemeChangeRunning = false

bool	m_bIsUsingGamepad

bool	m_bProtectionWarning

SCR_TutorialCourse	m_ActiveConfig

SCR_PlacingEditorComponent	m_PlacingComponent

int	m_iFreeRoamActivations

bool	m_bStagesComplete = false

SCR_VoiceoverSystem	m_VoiceoverSystem

IEntity	m_FastTravelPosition

WidgetAnimationOpacity	m_OngoingFadeAnimation

float	m_fSavedTime

ref array< SCR_TutorialInstructorComponent >	m_aInstructors = {}

ref ScriptInvoker	m_OnPlayerSpawned = new ScriptInvoker()

ref ScriptInvoker	m_OnEntitySpawned = new ScriptInvoker()

ref ScriptInvoker	m_OnFastTravelDone = new ScriptInvoker()

bool	m_bIsFastTraveling

bool	m_bCourseBreaking

SCR_WaypointDisplay	m_WaypointDisplay

SCR_ETutorialCourses	m_eFinishedCourses

ref array< SCR_TutorialCourseTask >	m_aCourseTasks = {}

ref array< IEntity >	m_aGarbage

ref array< SCR_VehicleDamageManagerComponent >	m_aDamagedVehicles

ref array< SCR_NarrativeComponent >	m_aNarratedCharacters

SCR_ETutorialBreakType	m_iBreakType

Widget	m_wPunishmentScreen

bool	m_bOutroBreak

IEntity	m_AreaRestrictionCenter

float	m_fSavedViewDistance

float	m_fSoundInterpolationSpeed

float	m_fSoundVolume

bool	m_bApplySoundFade

Protected Attributes inherited from SCR_BaseGameModeComponent
SCR_BaseGameMode	m_pGameMode
	The game mode entity this component is attached to.

Static Protected Attributes
const int	GARBAGE_DESPAWN_DISTANCE_SQ = 200*200

const int	PUNISHMENT_TIMEOUT = 5000

const string	FADEOUTLAYOUT = "{265245C299401BF6}UI/layouts/Menus/ContentBrowser/DownloadManager/ScrollBackground.layout"

Constructor & Destructor Documentation

◆ ~SCR_TutorialGamemodeComponent()

void SCR_TutorialGamemodeComponent.~SCR_TutorialGamemodeComponent ( )

Member Function Documentation

◆ BlockBuildingModeAccess()

void SCR_TutorialGamemodeComponent.BlockBuildingModeAccess	(	notnull IEntity	providerEntity,
		bool	block
	)

◆ CanBreakCourse()

bool SCR_TutorialGamemodeComponent.CanBreakCourse ( )

◆ ChangeVehicleLockState()

void SCR_TutorialGamemodeComponent.ChangeVehicleLockState	(	notnull IEntity	vehicle,
		bool	lock
	)

◆ Check3rdPersonViewUsed()

void SCR_TutorialGamemodeComponent.Check3rdPersonViewUsed ( )

◆ CheckAreaRestrictions()

void SCR_TutorialGamemodeComponent.CheckAreaRestrictions ( )

protected

◆ CheckCharacterStance()

bool SCR_TutorialGamemodeComponent.CheckCharacterStance ( ECharacterCommandIDs command )

TODO> MOVE TO OBSTACLE COURSE LOGIC.

Parameters

[in] command

Returns

◆ CreateCourseTask()

void SCR_TutorialGamemodeComponent.CreateCourseTask ( SCR_ETutorialCourses courseType )

protected

◆ CreateWarningOverlay()

Widget SCR_TutorialGamemodeComponent.CreateWarningOverlay ( bool killedNPC )

◆ DelayedPopup()

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

Parameters

[in]	text
[in]	subtitle
[in]	duration
[in]	param1
[in]	param2
[in]	subtitleParam1
[in]	subtitleParam2

◆ DespawnCourseAssets()

void SCR_TutorialGamemodeComponent.DespawnCourseAssets ( )

◆ EnableArsenal()

void SCR_TutorialGamemodeComponent.EnableArsenal	(	string	entityName,
		bool	enable
	)

◆ EnableControls()

void SCR_TutorialGamemodeComponent.EnableControls ( bool enable )

◆ EnableRefunding()

void SCR_TutorialGamemodeComponent.EnableRefunding	(	IEntity	ent,
		bool	enable
	)

◆ EOnFrame()

override void SCR_TutorialGamemodeComponent.EOnFrame	(	IEntity	owner,
		float	timeSlice
	)

protected

◆ Fadeout()

WidgetAnimationOpacity SCR_TutorialGamemodeComponent.Fadeout	(	bool	fadeOut,
		float	duration = `1`,
		float	soundDuration = `duration`
	)

Parameters

[in] fadeOut - if true, screen will fadeout to black, false does the opposite

◆ FastTravel()

void SCR_TutorialGamemodeComponent.FastTravel ( notnull IEntity toEnt )

◆ FastTravelToCourse()

void SCR_TutorialGamemodeComponent.FastTravelToCourse ( SCR_ETutorialCourses course )

◆ FinalizeBreak()

void SCR_TutorialGamemodeComponent.FinalizeBreak ( )

◆ FindPrefabInPlayerInventory()

IEntity SCR_TutorialGamemodeComponent.FindPrefabInPlayerInventory ( ResourceName prefabName )

◆ FinishStage()

void SCR_TutorialGamemodeComponent.FinishStage ( )

◆ GamepadUsed()

bool SCR_TutorialGamemodeComponent.GamepadUsed ( )

◆ GenerateTasks()

void SCR_TutorialGamemodeComponent.GenerateTasks ( )

protected

◆ GetActiveConfig()

SCR_TutorialCourse SCR_TutorialGamemodeComponent.GetActiveConfig ( )

◆ GetActiveStageIndex()

int SCR_TutorialGamemodeComponent.GetActiveStageIndex ( )

Returns

◆ GetAmmoCountForWeapon()

int SCR_TutorialGamemodeComponent.GetAmmoCountForWeapon ( IEntity weapon )

◆ GetCourseInstructor()

SCR_TutorialInstructorComponent SCR_TutorialGamemodeComponent.GetCourseInstructor ( SCR_ETutorialCourses course )

◆ GetCoursesConfig()

SCR_TutorialCoursesConfig SCR_TutorialGamemodeComponent.GetCoursesConfig ( )

◆ GetCourseTask()

SCR_TutorialCourseTask SCR_TutorialGamemodeComponent.GetCourseTask ( SCR_ETutorialCourses course )

◆ GetCurrentStage()

SCR_BaseTutorialStage SCR_TutorialGamemodeComponent.GetCurrentStage ( )

◆ GetFinishedCourses()

SCR_ETutorialCourses SCR_TutorialGamemodeComponent.GetFinishedCourses ( )

◆ GetFreeRoamActivations()

int SCR_TutorialGamemodeComponent.GetFreeRoamActivations ( )

Returns

◆ GetInstance()

static SCR_TutorialGamemodeComponent SCR_TutorialGamemodeComponent.GetInstance ( )

static

◆ GetInstructors()

void SCR_TutorialGamemodeComponent.GetInstructors ( notnull array< SCR_TutorialInstructorComponent > instructors )

◆ GetIsMapOpen()

bool SCR_TutorialGamemodeComponent.GetIsMapOpen ( )

Returns

◆ GetOnEntitySpawned()

ScriptInvoker SCR_TutorialGamemodeComponent.GetOnEntitySpawned ( )

◆ GetOnFastTravelDone()

ScriptInvoker SCR_TutorialGamemodeComponent.GetOnFastTravelDone ( )

◆ GetOngoingFadeAnimation()

WidgetAnimationOpacity SCR_TutorialGamemodeComponent.GetOngoingFadeAnimation ( )

◆ GetOnPlayerSpawned()

ScriptInvoker SCR_TutorialGamemodeComponent.GetOnPlayerSpawned ( )

◆ GetPlacingComponent()

SCR_PlacingEditorComponent SCR_TutorialGamemodeComponent.GetPlacingComponent ( )

protected

Returns

◆ GetPlayer()

ChimeraCharacter SCR_TutorialGamemodeComponent.GetPlayer ( )

Returns

◆ GetPlayerInventory()

SCR_InventoryStorageManagerComponent SCR_TutorialGamemodeComponent.GetPlayerInventory ( )

◆ GetPreviewEntityComponent()

SCR_PreviewEntityEditorComponent SCR_TutorialGamemodeComponent.GetPreviewEntityComponent ( )

◆ GetRemainingAmmo()

int SCR_TutorialGamemodeComponent.GetRemainingAmmo ( )

◆ GetSavedTime()

float SCR_TutorialGamemodeComponent.GetSavedTime ( )

◆ GetSavedViewDistance()

float SCR_TutorialGamemodeComponent.GetSavedViewDistance ( )

◆ GetStageIndexByName()

int SCR_TutorialGamemodeComponent.GetStageIndexByName ( string name )

◆ GetWas3rdPersonViewUsed()

bool SCR_TutorialGamemodeComponent.GetWas3rdPersonViewUsed ( )

Returns

◆ GetWaypointDisplay()

SCR_WaypointDisplay SCR_TutorialGamemodeComponent.GetWaypointDisplay ( )

◆ HandleAchievement()

void SCR_TutorialGamemodeComponent.HandleAchievement ( )

◆ HandleGarbage()

void SCR_TutorialGamemodeComponent.HandleGarbage ( bool force = false )

◆ HandlePlayerGroup()

void SCR_TutorialGamemodeComponent.HandlePlayerGroup ( )

◆ HandleRespawnBreak()

void SCR_TutorialGamemodeComponent.HandleRespawnBreak ( )

protected

◆ HandleSoundFade()

void SCR_TutorialGamemodeComponent.HandleSoundFade ( float timeSlice )

protected

◆ HealPlayer()

void SCR_TutorialGamemodeComponent.HealPlayer ( )

◆ HideTasks()

void SCR_TutorialGamemodeComponent.HideTasks ( bool hide )

◆ IncrementFreeRoamActivation()

void SCR_TutorialGamemodeComponent.IncrementFreeRoamActivation ( )

◆ InsertIntoGarbage() [1/2]

void SCR_TutorialGamemodeComponent.InsertIntoGarbage ( IEntity ent )

◆ InsertIntoGarbage() [2/2]

void SCR_TutorialGamemodeComponent.InsertIntoGarbage ( string entityName )

◆ InsertStage()

void SCR_TutorialGamemodeComponent.InsertStage	(	string	stageName,
		int	position = `-1`
	)

Parameters

[in]	stageName	- name of stage in config
[in]	position	- position where stage should be put in order. If -1, stage is put in front of current stage.

◆ IsCourseAvailable()

bool SCR_TutorialGamemodeComponent.IsCourseAvailable ( SCR_ETutorialCourses courseType )

◆ IsCourseBreaking()

bool SCR_TutorialGamemodeComponent.IsCourseBreaking ( )

◆ IsDamagedOrDestroyed()

bool SCR_TutorialGamemodeComponent.IsDamagedOrDestroyed ( notnull IEntity ent )

◆ IsEntityInPlayerInventory() [1/2]

bool SCR_TutorialGamemodeComponent.IsEntityInPlayerInventory ( IEntity entity )

◆ IsEntityInPlayerInventory() [2/2]

bool SCR_TutorialGamemodeComponent.IsEntityInPlayerInventory ( string entityName )

◆ IsFastTraveling()

bool SCR_TutorialGamemodeComponent.IsFastTraveling ( )

◆ IsPlayerAimingInAngle()

bool SCR_TutorialGamemodeComponent.IsPlayerAimingInAngle	(	float	angle,
		int	tolerance
	)

◆ LoadCoursesConfig()

void SCR_TutorialGamemodeComponent.LoadCoursesConfig ( )

protected

◆ LoadProgress()

void SCR_TutorialGamemodeComponent.LoadProgress ( SCR_ETutorialCourses completedCourses )

◆ MoveCharacterIntoVehicle()

void SCR_TutorialGamemodeComponent.MoveCharacterIntoVehicle	(	notnull ChimeraCharacter	character,
		notnull Vehicle	vehicle,
		ECompartmentType	compartmentType,
		int	compartmentIndex = `0`
	)

◆ OnCharacterDamaged()

void SCR_TutorialGamemodeComponent.OnCharacterDamaged ( BaseDamageContext damageContext )

◆ OnControllableDestroyed()

override void SCR_TutorialGamemodeComponent.OnControllableDestroyed ( notnull SCR_InstigatorContextData instigatorContextData )

When a controllable entity is destroyed, this event is raised.

Parameters

[in] instigatorContextData Holds the data of the victim and killer

Implements SCR_BaseGameModeComponent.

◆ OnDelete()

override void SCR_TutorialGamemodeComponent.OnDelete ( IEntity owner )

◆ OnEntitySpawned()

void SCR_TutorialGamemodeComponent.OnEntitySpawned	(	int	prefabID,
		SCR_EditableEntityComponent	ent
	)

protected

◆ OnFastTravelFadeoutCompleted()

void SCR_TutorialGamemodeComponent.OnFastTravelFadeoutCompleted ( )

protected

◆ OnFastTravelPreloadFinished()

void SCR_TutorialGamemodeComponent.OnFastTravelPreloadFinished ( )

protected

◆ OnGameModeStart()

override void SCR_TutorialGamemodeComponent.OnGameModeStart ( )

protected

Called on every machine when game mode starts.

This can be immediate (if no pre-game period is set) or can happen after a certain delay, as deemed appropriate by the authority.

Implements SCR_BaseGameModeComponent.

◆ OnInputDeviceChangedDelayed()

void SCR_TutorialGamemodeComponent.OnInputDeviceChangedDelayed ( )

◆ OnInputDeviceIsGamepad()

void SCR_TutorialGamemodeComponent.OnInputDeviceIsGamepad ( bool isGamepad )

protected

◆ OnMapClose()

void SCR_TutorialGamemodeComponent.OnMapClose ( MapConfiguration config )

Parameters

[in] config

◆ OnMapOpen()

void SCR_TutorialGamemodeComponent.OnMapOpen ( MapConfiguration config )

Parameters

[in] config

◆ OnModeAdded()

void SCR_TutorialGamemodeComponent.OnModeAdded ( SCR_EditorModeEntity modeEntity )

Parameters

[in] modeEntity

◆ OnObjectDestroyed()

void SCR_TutorialGamemodeComponent.OnObjectDestroyed ( EDamageState state )

protected

◆ OnPlayerRegistered()

override void SCR_TutorialGamemodeComponent.OnPlayerRegistered ( int playerId )

Called on every machine after a player is registered (identity, name etc.).

Always called after OnPlayerConnected.

Parameters

[in] playerId PlayerId of registered player.

Implements SCR_BaseGameModeComponent.

◆ OnPlayerSpawnFinalize_S()

override void SCR_TutorialGamemodeComponent.OnPlayerSpawnFinalize_S	(	SCR_SpawnRequestComponent	requestComponent,
		SCR_SpawnHandlerComponent	handlerComponent,
		SCR_SpawnData	data,
		IEntity	entity
	)

Parameters

[in]	requestComponent
[in]	handlerComponent
[in]	data
[in]	entity

Implements SCR_BaseGameModeComponent.

◆ OnPostInit()

override void SCR_TutorialGamemodeComponent.OnPostInit ( IEntity owner )

protected

◆ OnStructureBuilt()

void SCR_TutorialGamemodeComponent.OnStructureBuilt	(	SCR_CampaignMilitaryBaseComponent	base,
		IEntity	structure
	)

Parameters

[in]	base
[in]	structure

◆ OnVehicleDamaged()

void SCR_TutorialGamemodeComponent.OnVehicleDamaged ( SCR_VehicleDamageManagerComponent damageManager )

protected

◆ PlayBedAnimation()

void SCR_TutorialGamemodeComponent.PlayBedAnimation ( bool fast )

◆ PlayNarrativeCharacterStageDelayed()

void SCR_TutorialGamemodeComponent.PlayNarrativeCharacterStageDelayed	(	string	characterName,
		int	stage
	)

◆ RegisterInstructor()

void SCR_TutorialGamemodeComponent.RegisterInstructor ( notnull SCR_TutorialInstructorComponent instructor )

◆ RegisterMarker()

void SCR_TutorialGamemodeComponent.RegisterMarker ( notnull SCR_MapMarkerBase marker )

◆ RemoveFromGarbage()

void SCR_TutorialGamemodeComponent.RemoveFromGarbage ( IEntity ent )

◆ RemovePlayerMapMarkers()

void SCR_TutorialGamemodeComponent.RemovePlayerMapMarkers ( )

protected

◆ RepairWorldVehicles()

void SCR_TutorialGamemodeComponent.RepairWorldVehicles ( )

◆ RequestBreakCourse()

void SCR_TutorialGamemodeComponent.RequestBreakCourse ( SCR_ETutorialBreakType breakType )

◆ SaveViewDistance()

void SCR_TutorialGamemodeComponent.SaveViewDistance ( float distance )

◆ SetCourseConfig()

void SCR_TutorialGamemodeComponent.SetCourseConfig	(	SCR_ETutorialCourses	config,
		string	stageName = `string::Empty`,
		bool	spawnAssets = `true`
	)

Parameters

[in] config

◆ SetFreeRoamActivation()

void SCR_TutorialGamemodeComponent.SetFreeRoamActivation ( int activations )

◆ SetSavedTime()

void SCR_TutorialGamemodeComponent.SetSavedTime ( float time )

◆ SetSoundFade()

void SCR_TutorialGamemodeComponent.SetSoundFade	(	bool	fadeOut,
		float	duration = `0`
	)

protected

◆ SetStage() [1/2]

void SCR_TutorialGamemodeComponent.SetStage ( int stage )

Parameters

[in] stage

◆ SetStage() [2/2]

void SCR_TutorialGamemodeComponent.SetStage ( string stageName )

◆ SetupEditorModeListener()

void SCR_TutorialGamemodeComponent.SetupEditorModeListener ( )

◆ SetupTargets()

void SCR_TutorialGamemodeComponent.SetupTargets	(	string	parentTargetName,
		out array< SCR_FiringRangeTarget >	targets = `null`,
		ETargetState	setupState = `-1`,
		bool	setupAutoReset = `true`
	)

◆ SetupVoiceSystem()

void SCR_TutorialGamemodeComponent.SetupVoiceSystem ( )

protected

◆ ShowMapDescriptor()

void SCR_TutorialGamemodeComponent.ShowMapDescriptor	(	string	descriptorOwnerName,
		bool	enable
	)

Parameters

[in]	descriptorOwnerName
[in]	enable

◆ SpawnAsset()

IEntity SCR_TutorialGamemodeComponent.SpawnAsset	(	string	name,
		ResourceName	type,
		IEntity	spawnpoint = `null`,
		bool	respawn = `true`
	)

Parameters

[in]	name
[in]	type
[in]	spawnpoint

Returns

◆ SpawnCourseAssets()

void SCR_TutorialGamemodeComponent.SpawnCourseAssets ( SCR_ETutorialCourses courseType = -1 )

◆ SpawnPlayer()

void SCR_TutorialGamemodeComponent.SpawnPlayer ( string spawnPositionName )

◆ UnregisterInstructor()

void SCR_TutorialGamemodeComponent.UnregisterInstructor ( notnull SCR_TutorialInstructorComponent instructor )

Member Data Documentation

◆ FADEOUTLAYOUT

const string SCR_TutorialGamemodeComponent.FADEOUTLAYOUT = "{265245C299401BF6}UI/layouts/Menus/ContentBrowser/DownloadManager/ScrollBackground.layout"

staticprotected

◆ GARBAGE_DESPAWN_DISTANCE_SQ

const int SCR_TutorialGamemodeComponent.GARBAGE_DESPAWN_DISTANCE_SQ = 200*200

staticprotected

◆ m_aCourseTasks

ref array<SCR_TutorialCourseTask> SCR_TutorialGamemodeComponent.m_aCourseTasks = {}

protected

◆ m_ActiveConfig

SCR_TutorialCourse SCR_TutorialGamemodeComponent.m_ActiveConfig

protected

◆ m_aDamagedVehicles

ref array<SCR_VehicleDamageManagerComponent> SCR_TutorialGamemodeComponent.m_aDamagedVehicles

protected

◆ m_aGarbage

ref array<IEntity> SCR_TutorialGamemodeComponent.m_aGarbage

protected

◆ m_aInstructors

ref array<SCR_TutorialInstructorComponent> SCR_TutorialGamemodeComponent.m_aInstructors = {}

protected

◆ m_aMarkers

ref array<ref SCR_MapMarkerBase> SCR_TutorialGamemodeComponent.m_aMarkers = {}

protected

◆ m_aNarratedCharacters

ref array<SCR_NarrativeComponent> SCR_TutorialGamemodeComponent.m_aNarratedCharacters

protected

◆ m_AreaRestrictionCenter

IEntity SCR_TutorialGamemodeComponent.m_AreaRestrictionCenter

protected

◆ m_aStageInfos

ref array<ref SCR_TutorialStageInfo> SCR_TutorialGamemodeComponent.m_aStageInfos = {}

protected

◆ m_bApplySoundFade

bool SCR_TutorialGamemodeComponent.m_bApplySoundFade

protected

◆ m_bCourseBreaking

bool SCR_TutorialGamemodeComponent.m_bCourseBreaking

protected

◆ m_bFirstStageSet

bool SCR_TutorialGamemodeComponent.m_bFirstStageSet

protected

◆ m_bIsFastTraveling

bool SCR_TutorialGamemodeComponent.m_bIsFastTraveling

protected

◆ m_bIsMapOpen

bool SCR_TutorialGamemodeComponent.m_bIsMapOpen = false

protected

◆ m_bIsUsingGamepad

bool SCR_TutorialGamemodeComponent.m_bIsUsingGamepad

protected

◆ m_bOutroBreak

bool SCR_TutorialGamemodeComponent.m_bOutroBreak

protected

◆ m_bProtectionWarning

bool SCR_TutorialGamemodeComponent.m_bProtectionWarning

protected

◆ m_bStagesComplete

bool SCR_TutorialGamemodeComponent.m_bStagesComplete = false

protected

◆ m_bUsed3PV

bool SCR_TutorialGamemodeComponent.m_bUsed3PV = false

protected

◆ m_CoursesConfig

ref SCR_TutorialCoursesConfig SCR_TutorialGamemodeComponent.m_CoursesConfig

protected

◆ m_eFinishedCourses

SCR_ETutorialCourses SCR_TutorialGamemodeComponent.m_eFinishedCourses

protected

◆ m_FastTravelPosition

IEntity SCR_TutorialGamemodeComponent.m_FastTravelPosition

protected

◆ m_fDelayedControlSchemeChangeRunning

bool SCR_TutorialGamemodeComponent.m_fDelayedControlSchemeChangeRunning = false

protected

◆ m_fSavedTime

float SCR_TutorialGamemodeComponent.m_fSavedTime

protected

◆ m_fSavedViewDistance

float SCR_TutorialGamemodeComponent.m_fSavedViewDistance

protected

◆ m_fSoundInterpolationSpeed

float SCR_TutorialGamemodeComponent.m_fSoundInterpolationSpeed

protected

◆ m_fSoundVolume

float SCR_TutorialGamemodeComponent.m_fSoundVolume

protected

◆ m_iActiveStage

int SCR_TutorialGamemodeComponent.m_iActiveStage

protected

◆ m_iBreakType

SCR_ETutorialBreakType SCR_TutorialGamemodeComponent.m_iBreakType

protected

◆ m_iFreeRoamActivations

int SCR_TutorialGamemodeComponent.m_iFreeRoamActivations

protected

◆ m_OnEntitySpawned

ref ScriptInvoker SCR_TutorialGamemodeComponent.m_OnEntitySpawned = new ScriptInvoker()

protected

◆ m_OnFastTravelDone

ref ScriptInvoker SCR_TutorialGamemodeComponent.m_OnFastTravelDone = new ScriptInvoker()

protected

◆ m_OngoingFadeAnimation

WidgetAnimationOpacity SCR_TutorialGamemodeComponent.m_OngoingFadeAnimation

protected

◆ m_OnPlayerSpawned

ref ScriptInvoker SCR_TutorialGamemodeComponent.m_OnPlayerSpawned = new ScriptInvoker()

protected

◆ m_PlacingComponent

SCR_PlacingEditorComponent SCR_TutorialGamemodeComponent.m_PlacingComponent

protected

◆ m_Player

ChimeraCharacter SCR_TutorialGamemodeComponent.m_Player

protected

◆ m_sCoursesConfigResourceName

ResourceName SCR_TutorialGamemodeComponent.m_sCoursesConfigResourceName

protected

◆ m_sPlayerVehicleResourceName

ResourceName SCR_TutorialGamemodeComponent.m_sPlayerVehicleResourceName

protected

◆ m_Stage

SCR_BaseTutorialStage SCR_TutorialGamemodeComponent.m_Stage

protected

◆ m_VoiceoverSystem

SCR_VoiceoverSystem SCR_TutorialGamemodeComponent.m_VoiceoverSystem

protected

◆ m_WaypointDisplay

SCR_WaypointDisplay SCR_TutorialGamemodeComponent.m_WaypointDisplay

protected

◆ m_wFadeOut

ImageWidget SCR_TutorialGamemodeComponent.m_wFadeOut

protected

◆ m_wPunishmentScreen

Widget SCR_TutorialGamemodeComponent.m_wPunishmentScreen

protected

◆ PUNISHMENT_TIMEOUT

const int SCR_TutorialGamemodeComponent.PUNISHMENT_TIMEOUT = 5000

staticprotected

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

Game/GameMode/Tutorial/Logic/SCR_TutorialGamemodeComponent.c

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Constructor & Destructor Documentation

◆ ~SCR_TutorialGamemodeComponent()

Member Function Documentation

◆ BlockBuildingModeAccess()

◆ CanBreakCourse()

◆ ChangeVehicleLockState()

◆ Check3rdPersonViewUsed()

◆ CheckAreaRestrictions()

◆ CheckCharacterStance()

◆ CreateCourseTask()

◆ CreateWarningOverlay()

◆ DelayedPopup()

◆ DespawnCourseAssets()

◆ EnableArsenal()

◆ EnableControls()

◆ EnableRefunding()

◆ EOnFrame()

◆ Fadeout()

◆ FastTravel()

◆ FastTravelToCourse()

◆ FinalizeBreak()

◆ FindPrefabInPlayerInventory()

◆ FinishStage()

◆ GamepadUsed()

◆ GenerateTasks()

◆ GetActiveConfig()

◆ GetActiveStageIndex()

◆ GetAmmoCountForWeapon()

◆ GetCourseInstructor()

◆ GetCoursesConfig()

◆ GetCourseTask()

◆ GetCurrentStage()

◆ GetFinishedCourses()

◆ GetFreeRoamActivations()

◆ GetInstance()

◆ GetInstructors()

◆ GetIsMapOpen()

◆ GetOnEntitySpawned()

◆ GetOnFastTravelDone()

◆ GetOngoingFadeAnimation()

◆ GetOnPlayerSpawned()

◆ GetPlacingComponent()

◆ GetPlayer()

◆ GetPlayerInventory()

◆ GetPreviewEntityComponent()

◆ GetRemainingAmmo()

◆ GetSavedTime()

◆ GetSavedViewDistance()

◆ GetStageIndexByName()

◆ GetWas3rdPersonViewUsed()

◆ GetWaypointDisplay()

◆ HandleAchievement()

◆ HandleGarbage()

◆ HandlePlayerGroup()

◆ HandleRespawnBreak()

◆ HandleSoundFade()

◆ HealPlayer()

◆ HideTasks()

◆ IncrementFreeRoamActivation()

◆ InsertIntoGarbage() [1/2]

◆ InsertIntoGarbage() [2/2]

◆ InsertStage()

◆ IsCourseAvailable()

◆ IsCourseBreaking()

◆ IsDamagedOrDestroyed()

◆ IsEntityInPlayerInventory() [1/2]

◆ IsEntityInPlayerInventory() [2/2]

◆ IsFastTraveling()

◆ IsPlayerAimingInAngle()

◆ LoadCoursesConfig()

◆ LoadProgress()

◆ MoveCharacterIntoVehicle()

◆ OnCharacterDamaged()

◆ OnControllableDestroyed()

◆ OnDelete()