TrinityCore: SceneMgr Class Reference

TrinityCore

Loading...

Searching...

No Matches

#include <SceneMgr.h>

Public Member Functions
	SceneMgr (Player *player)

	~SceneMgr ()

	SceneMgr (SceneMgr const &)=delete

	SceneMgr (SceneMgr &&)=delete

Player *	GetPlayer () const

uint32	PlayScene (uint32 sceneId, Position const *position=nullptr)

uint32	PlaySceneByTemplate (SceneTemplate const sceneTemplate, Position const position=nullptr)

uint32	PlaySceneByPackageId (uint32 sceneScriptPackageId, EnumFlag< SceneFlag > playbackflags, Position const *position=nullptr)

void	CancelScene (uint32 sceneInstanceID, bool removeFromMap=true)

void	OnSceneTrigger (uint32 sceneInstanceID, std::string const &triggerName)

void	OnSceneCancel (uint32 sceneInstanceID)

void	OnSceneComplete (uint32 sceneInstanceID)

void	RecreateScene (uint32 sceneScriptPackageId, EnumFlag< SceneFlag > playbackflags, Position const *position=nullptr)

bool	HasScene (uint32 sceneInstanceID, uint32 sceneScriptPackageId=0) const

void	AddInstanceIdToSceneMap (uint32 sceneInstanceID, SceneTemplate const *sceneTemplate)

void	CancelSceneBySceneId (uint32 sceneId)

void	CancelSceneByPackageId (uint32 sceneScriptPackageId)

void	RemoveSceneInstanceId (uint32 sceneInstanceID)

void	RemoveAurasDueToSceneId (uint32 sceneId)

SceneTemplate const *	GetSceneTemplateFromInstanceId (uint32 sceneInstanceID) const

uint32	GetActiveSceneCount (uint32 sceneScriptPackageId=0) const

SceneTemplateByInstance const &	GetSceneTemplateByInstanceMap () const

Optional< uint32 >	GetInstanceIdBySceneId (uint32 sceneId) const

uint32	GetNewStandaloneSceneInstanceID ()

void	TriggerDelayedScenes ()

void	ToggleDebugSceneMode ()

bool	IsInDebugSceneMode () const

Private Attributes
Player *	_player

SceneTemplateByInstance	_scenesByInstance

uint32	_standaloneSceneInstanceID

std::vector< WorldPacket >	_delayedScenes

bool	_isDebuggingScenes

Detailed Description

Definition at line 35 of file SceneMgr.h.

Constructor & Destructor Documentation

◆ SceneMgr() [1/3]

SceneMgr::SceneMgr ( Player * player )

Definition at line 28 of file SceneMgr.cpp.

References _isDebuggingScenes, and _standaloneSceneInstanceID.

◆ ~SceneMgr()

SceneMgr::~SceneMgr ( )

default

◆ SceneMgr() [2/3]

SceneMgr::SceneMgr ( SceneMgr const & )

delete

◆ SceneMgr() [3/3]

SceneMgr::SceneMgr ( SceneMgr && )

delete

Member Function Documentation

◆ AddInstanceIdToSceneMap()

void SceneMgr::AddInstanceIdToSceneMap	(	uint32	sceneInstanceID,
		SceneTemplate const *	sceneTemplate
	)

Definition at line 173 of file SceneMgr.cpp.

References _scenesByInstance.

Referenced by PlaySceneByTemplate().

◆ CancelScene()

void SceneMgr::CancelScene	(	uint32	sceneInstanceID,
		bool	removeFromMap = `true`
	)

Definition at line 95 of file SceneMgr.cpp.

References GetPlayer(), RemoveSceneInstanceId(), WorldPackets::Scenes::CancelScene::SceneInstanceID, Player::SendDirectMessage(), and WorldPackets::Scenes::CancelScene::Write().

Referenced by CancelSceneByPackageId(), CancelSceneBySceneId(), OnSceneCancel(), and OnSceneComplete().

◆ CancelSceneByPackageId()

void SceneMgr::CancelSceneByPackageId ( uint32 sceneScriptPackageId )

Definition at line 190 of file SceneMgr.cpp.

References _scenesByInstance, and CancelScene().

Referenced by scene_commandscript::HandleCancelSceneCommand().

◆ CancelSceneBySceneId()

void SceneMgr::CancelSceneBySceneId ( uint32 sceneId )

Definition at line 178 of file SceneMgr.cpp.

References _scenesByInstance, and CancelScene().

Referenced by AuraEffect::HandlePlayScene().

◆ GetActiveSceneCount()

uint32 SceneMgr::GetActiveSceneCount ( uint32 sceneScriptPackageId = 0 ) const

Definition at line 230 of file SceneMgr.cpp.

References _scenesByInstance.

Referenced by list_commandscript::HandleListScenesCommand().

◆ GetInstanceIdBySceneId()

Optional< uint32 > SceneMgr::GetInstanceIdBySceneId ( uint32 sceneId ) const

Definition at line 241 of file SceneMgr.cpp.

References _scenesByInstance.

Referenced by AuraEffect::HandlePlayScene().

◆ GetNewStandaloneSceneInstanceID()

uint32 SceneMgr::GetNewStandaloneSceneInstanceID ( )

inline

Definition at line 74 of file SceneMgr.h.

Referenced by PlaySceneByTemplate().

◆ GetPlayer()

Player * SceneMgr::GetPlayer ( ) const

inline

Definition at line 44 of file SceneMgr.h.

Referenced by CancelScene(), OnSceneCancel(), OnSceneComplete(), OnSceneTrigger(), PlaySceneByTemplate(), RemoveAurasDueToSceneId(), and TriggerDelayedScenes().

◆ GetSceneTemplateByInstanceMap()

SceneTemplateByInstance const & SceneMgr::GetSceneTemplateByInstanceMap ( ) const

inline

Definition at line 71 of file SceneMgr.h.

Referenced by BaseEntity::BuildMovementUpdate(), and list_commandscript::HandleListScenesCommand().

◆ GetSceneTemplateFromInstanceId()

SceneTemplate const * SceneMgr::GetSceneTemplateFromInstanceId ( uint32 sceneInstanceID ) const

Definition at line 220 of file SceneMgr.cpp.

References _scenesByInstance.

Referenced by OnSceneCancel(), OnSceneComplete(), and OnSceneTrigger().

◆ HasScene()

bool SceneMgr::HasScene	(	uint32	sceneInstanceID,
		uint32	sceneScriptPackageId = `0`
	)		const

Definition at line 163 of file SceneMgr.cpp.

References _scenesByInstance.

Referenced by OnSceneCancel(), OnSceneComplete(), and OnSceneTrigger().

◆ IsInDebugSceneMode()

bool SceneMgr::IsInDebugSceneMode ( ) const

inline

Definition at line 79 of file SceneMgr.h.

◆ OnSceneCancel()

void SceneMgr::OnSceneCancel ( uint32 sceneInstanceID )

Definition at line 117 of file SceneMgr.cpp.

References _isDebuggingScenes, CancelScene(), FadeToBlackscreenOnCancel, GetPlayer(), GetSceneTemplateFromInstanceId(), EnumFlag< T >::HasFlag(), HasScene(), LANG_COMMAND_SCENE_DEBUG_CANCEL, NotCancelable, SceneTemplate::PlaybackFlags, ChatHandler::PSendSysMessage(), RemoveAurasDueToSceneId(), RemoveSceneInstanceId(), SceneTemplate::SceneId, and sScriptMgr.

Referenced by WorldSession::HandleScenePlaybackCanceled().

◆ OnSceneComplete()

void SceneMgr::OnSceneComplete ( uint32 sceneInstanceID )

Definition at line 141 of file SceneMgr.cpp.

References _isDebuggingScenes, CancelScene(), FadeToBlackscreenOnComplete, GetPlayer(), GetSceneTemplateFromInstanceId(), EnumFlag< T >::HasFlag(), HasScene(), LANG_COMMAND_SCENE_DEBUG_COMPLETE, SceneTemplate::PlaybackFlags, ChatHandler::PSendSysMessage(), RemoveAurasDueToSceneId(), RemoveSceneInstanceId(), SceneTemplate::SceneId, and sScriptMgr.

Referenced by AuraEffect::HandlePlayScene(), and WorldSession::HandleScenePlaybackComplete().

◆ OnSceneTrigger()

void SceneMgr::OnSceneTrigger	(	uint32	sceneInstanceID,
		std::string const &	triggerName
	)

Definition at line 105 of file SceneMgr.cpp.

References _isDebuggingScenes, GetPlayer(), GetSceneTemplateFromInstanceId(), HasScene(), LANG_COMMAND_SCENE_DEBUG_TRIGGER, ChatHandler::PSendSysMessage(), and sScriptMgr.

Referenced by WorldSession::HandleSceneTriggerEvent().

◆ PlayScene()

uint32 SceneMgr::PlayScene	(	uint32	sceneId,
		Position const *	position = `nullptr`
	)

Definition at line 36 of file SceneMgr.cpp.

References PlaySceneByTemplate(), and sObjectMgr.

Referenced by Spell::EffectPlayScene(), WorldSession::HandlePlayerLogin(), AuraEffect::HandlePlayScene(), and scene_commandscript::HandlePlaySceneCommand().

◆ PlaySceneByPackageId()

uint32 SceneMgr::PlaySceneByPackageId	(	uint32	sceneScriptPackageId,
		EnumFlag< SceneFlag >	playbackflags,
		Position const *	position = `nullptr`
	)

Definition at line 83 of file SceneMgr.cpp.

References SceneTemplate::Encrypted, SceneTemplate::PlaybackFlags, PlaySceneByTemplate(), SceneTemplate::SceneId, SceneTemplate::ScenePackageId, and SceneTemplate::ScriptId.

Referenced by Spell::EffectPlaySceneScriptPackage(), and scene_commandscript::HandlePlayScenePackageCommand().

◆ PlaySceneByTemplate()

uint32 SceneMgr::PlaySceneByTemplate	(	SceneTemplate const *	sceneTemplate,
		Position const *	position = `nullptr`
	)

Definition at line 42 of file SceneMgr.cpp.

References _delayedScenes, _isDebuggingScenes, AddInstanceIdToSceneMap(), EnumFlag< T >::AsUnderlyingType(), SceneTemplate::Encrypted, WorldPackets::Scenes::PlayScene::Encrypted, GetNewStandaloneSceneInstanceID(), GetPlayer(), WorldPackets::Packet::GetRawPacket(), Unit::GetTransGUID(), LANG_COMMAND_SCENE_DEBUG_PLAY, WorldPackets::Scenes::PlayScene::Location, WorldPackets::ServerPacket::Move(), SceneTemplate::PlaybackFlags, WorldPackets::Scenes::PlayScene::PlaybackFlags, ChatHandler::PSendSysMessage(), SceneTemplate::SceneId, WorldPackets::Scenes::PlayScene::SceneID, WorldPackets::Scenes::PlayScene::SceneInstanceID, SceneTemplate::ScenePackageId, WorldPackets::Scenes::PlayScene::SceneScriptPackageID, Player::SendDirectMessage(), sSceneScriptPackageStore, sScriptMgr, WorldPackets::Scenes::PlayScene::TransportGUID, and WorldPackets::Scenes::PlayScene::Write().

Referenced by PlayScene(), and PlaySceneByPackageId().

◆ RecreateScene()

void SceneMgr::RecreateScene	(	uint32	sceneScriptPackageId,
		EnumFlag< SceneFlag >	playbackflags,
		Position const *	position = `nullptr`
	)

inline

Definition at line 55 of file SceneMgr.h.

◆ RemoveAurasDueToSceneId()

void SceneMgr::RemoveAurasDueToSceneId ( uint32 sceneId )

Definition at line 207 of file SceneMgr.cpp.

References Unit::GetAuraEffectsByType(), GetPlayer(), Unit::RemoveAura(), and SPELL_AURA_PLAY_SCENE.

Referenced by OnSceneCancel(), and OnSceneComplete().

◆ RemoveSceneInstanceId()

void SceneMgr::RemoveSceneInstanceId ( uint32 sceneInstanceID )

Definition at line 202 of file SceneMgr.cpp.

References _scenesByInstance.

Referenced by CancelScene(), OnSceneCancel(), and OnSceneComplete().

◆ ToggleDebugSceneMode()

void SceneMgr::ToggleDebugSceneMode ( )

inline

Definition at line 78 of file SceneMgr.h.

◆ TriggerDelayedScenes()

void SceneMgr::TriggerDelayedScenes ( )

Definition at line 251 of file SceneMgr.cpp.

References _delayedScenes, GetPlayer(), and Player::SendDirectMessage().

Referenced by Player::SendInitialPacketsAfterAddToMap().

Member Data Documentation

◆ _delayedScenes

std::vector<WorldPacket> SceneMgr::_delayedScenes

private

Definition at line 85 of file SceneMgr.h.

Referenced by PlaySceneByTemplate(), and TriggerDelayedScenes().

◆ _isDebuggingScenes

bool SceneMgr::_isDebuggingScenes

private

Definition at line 86 of file SceneMgr.h.

Referenced by OnSceneCancel(), OnSceneComplete(), OnSceneTrigger(), PlaySceneByTemplate(), and SceneMgr().

◆ _player

Player* SceneMgr::_player

private

Definition at line 82 of file SceneMgr.h.

◆ _scenesByInstance

SceneTemplateByInstance SceneMgr::_scenesByInstance

private

Definition at line 83 of file SceneMgr.h.

Referenced by AddInstanceIdToSceneMap(), CancelSceneByPackageId(), CancelSceneBySceneId(), GetActiveSceneCount(), GetInstanceIdBySceneId(), GetSceneTemplateFromInstanceId(), HasScene(), and RemoveSceneInstanceId().

◆ _standaloneSceneInstanceID

uint32 SceneMgr::_standaloneSceneInstanceID

private

Definition at line 84 of file SceneMgr.h.

Referenced by SceneMgr().

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

server/game/Entities/Player/SceneMgr.h
server/game/Entities/Player/SceneMgr.cpp

SceneMgr
Generated by 1.9.8