#include <BGSScene.h>

Inheritance diagram for RE::BGSScene:

Classes
struct	ChangeFlags

struct	RecordFlags

Public Types
enum class	Flag { kNone = 0 , kBeginOnQuestStart = 1 << 0 , kStopOnQuestEnd = 1 << 1 , kRepeatConditionsWhileTrue = 1 << 3 , kInterruptible = 1 << 4 }

enum class	BehaviourFlag { kNone = 0 , kDeathPause = 1 << 0 , kDeathEnd = 1 << 1 , kCombatPause = 1 << 2 , kCombatEnd = 1 << 3 , kDialoguePause = 1 << 4 , kDialogueEnd = 1 << 5 , kOBS_COMPause = 1 << 6 , kOBS_COMEnd = 1 << 7 }

Public Types inherited from RE::TESForm
enum class	InGameFormFlag { kNone = 0 , kWantsDelete = 1 << 0 , kForcedPersistent = 1 << 1 , kNoFavorAllowed = 1 << 4 , kIsSkyObject = 1 << 5 , kRefOriginalPersistent = 1 << 6 , kRefPermanentlyDeleted = 1 << 7 }

Public Member Functions
	~BGSScene () override

void	InitializeData () override

bool	Load (TESFile *a_mod) override

void	SaveGame (BGSSaveFormBuffer *a_buf) override

void	LoadGame (BGSLoadFormBuffer *a_buf) override

void	InitLoadGame (BGSLoadFormBuffer *a_buf) override

void	Revert (BGSLoadFormBuffer *a_buf) override

void	InitItemImpl () override

Public Member Functions inherited from RE::TESForm
	~TESForm () override

void	InitializeDataComponent () override

void	ClearDataComponent () override

void	CopyComponent (BaseFormComponent *a_rhs) override

virtual void	ClearData ()

virtual bool	LoadPartial (TESFile *a_mod)

virtual bool	LoadEdit (TESFile *a_mod)

virtual TESForm *	CreateDuplicateForm (bool a_createEditorID, void *a_arg2)

virtual bool	AddChange (std::uint32_t a_changeFlags)

virtual void	RemoveChange (std::uint32_t a_changeFlags)

virtual bool	FindInFileFast (TESFile *a_mod)

virtual bool	CheckSaveGame (BGSSaveFormBuffer *a_buf)

virtual void	FinishLoadGame (BGSLoadFormBuffer *a_buf)

virtual TESFile *	GetDescriptionOwnerFile () const

virtual FormType	GetSavedFormType () const

virtual void	GetFormDetailedString (char *a_buf, std::uint32_t a_bufLen)

virtual bool	GetKnown () const

virtual bool	GetRandomAnim () const

virtual bool	GetPlayable () const

virtual bool	IsHeadingMarker () const

virtual bool	GetDangerous () const

virtual bool	QHasCurrents () const

virtual bool	GetObstacle () const

virtual bool	QIsLODLandObject () const

virtual bool	GetOnLocalMap () const

virtual bool	GetMustUpdate () const

virtual void	SetOnLocalMap (bool a_set)

virtual bool	GetIgnoredBySandbox () const

virtual void	SetDelete (bool a_set)

virtual void	SetAltered (bool a_set)

virtual void	SaveObjectBound ()

virtual void	LoadObjectBound (TESFile *a_mod)

virtual bool	IsBoundObject () const

virtual bool	IsObject () const

virtual bool	IsMagicItem () const

virtual bool	IsWater () const

virtual TESObjectREFR *	AsReference1 ()

virtual const TESObjectREFR *	AsReference2 () const

virtual std::uint32_t	GetRefCount () const

virtual const char *	GetTextForParsedSubTag (const BSFixedString &a_tag) const

virtual void	Copy (TESForm *a_srcForm)

virtual bool	BelongsInGroup (FORM *a_form, bool a_allowParentGroups, bool a_currentOnly)

virtual void	CreateGroupData (FORM a_form, FORM_GROUP a_group)

virtual const char *	GetFormEditorID () const

virtual bool	SetFormEditorID (const char *a_str)

virtual bool	IsParentForm ()

virtual bool	IsParentFormTree ()

virtual bool	IsFormTypeChild (FormType a_type)

virtual bool	Activate (TESObjectREFR a_targetRef, TESObjectREFR a_activatorRef, std::uint8_t a_arg3, TESBoundObject *a_object, std::int32_t a_targetCount)

virtual void	SetFormID (FormID a_id, bool a_updateFile)

virtual const char *	GetObjectTypeName () const

virtual bool	QAvailableInGame () const

template<class T >
	requires (std::is_class_v< T >) T *As() noexcept

template<class T >
	requires (requires { T::FORMTYPE;}) const T *As() const noexcept

template<class T >
	requires (!requires { T::FORMTYPE;}) const T *As() const noexcept

TESObjectREFR *	AsReference ()

const TESObjectREFR *	AsReference () const

TESFile *	GetFile (std::int32_t a_idx=-1) const

std::uint32_t	GetFormFlags () const noexcept

FormID	GetFormID () const noexcept

FormType	GetFormType () const noexcept

std::int32_t	GetGoldValue () const

const char *	GetName () const

float	GetWeight () const

bool	HasVMAD () const

bool	HasWorldModel () const noexcept

void	InitItem ()

bool	Is (FormType a_type) const noexcept

template<class... Args>
bool	Is (Args... a_args) const noexcept requires(std

bool	IsAmmo () const noexcept

bool	IsArmor () const noexcept

bool	IsBook () const noexcept

bool	IsDeleted () const noexcept

bool	IsDynamicForm () const noexcept

bool	IsGold () const noexcept

bool	IsIgnored () const noexcept

bool	IsInitialized () const noexcept

bool	IsKey () const noexcept

bool	IsLockpick () const noexcept

bool	IsNot (FormType a_type) const noexcept

template<class... Args>
bool	IsNot (Args... a_args) const noexcept requires(std

bool	IsNote () const noexcept

bool	IsPlayer () const noexcept

bool	IsPlayerRef () const noexcept

bool	IsSoulGem () const noexcept

bool	IsWeapon () const noexcept

Public Member Functions inherited from RE::BaseFormComponent
virtual	~BaseFormComponent ()

	TES_HEAP_REDEFINE_NEW ()

Public Attributes
BSTArray< BGSScenePhase * >	phases

BSTArray< FormID >	actors

BSTArray< stl::enumeration< SCENE_ACTOR_FLAG, std::uint32_t > >	actorFlags

BSTArray< stl::enumeration< BehaviourFlag, std::uint32_t > >	actorProgressionFlags

BSTArray< BGSSceneAction * >	actions

TESQuest *	parentQuest

stl::enumeration< Flag, std::uint32_t >	flags

std::uint32_t	padA4

TESCondition	conditions

std::uint32_t	unkB0

std::uint32_t	unkB4

std::uint32_t	unkB8

std::uint32_t	unkBC

std::uint32_t	unkC0

std::uint32_t	padC4

Public Attributes inherited from RE::TESForm
TESFileContainer	sourceFiles

std::uint32_t	formFlags

FormID	formID

stl::enumeration< InGameFormFlag, std::uint16_t >	inGameFormFlags

stl::enumeration< FormType, std::uint8_t >	formType

std::uint8_t	pad1B

std::uint32_t	pad1C

Static Public Attributes
static constexpr auto	RTTI = RTTI_BGSScene

static constexpr auto	FORMTYPE = FormType::Scene

Static Public Attributes inherited from RE::TESForm
static constexpr auto	RTTI = RTTI_TESForm

static constexpr auto	FORMTYPE = FormType::None

Static Public Attributes inherited from RE::BaseFormComponent
static constexpr auto	RTTI = RTTI_BaseFormComponent

Additional Inherited Members
Static Public Member Functions inherited from RE::TESForm
static void	AddCompileIndex (FormID &a_id, TESFile *a_file)

static auto	GetAllForms () -> std::pair< BSTHashMap< FormID, TESForm * > *, std::reference_wrapper< BSReadWriteLock >>

static auto	GetAllFormsByEditorID () -> std::pair< BSTHashMap< BSFixedString, TESForm * > *, std::reference_wrapper< BSReadWriteLock >>

static TESForm *	LookupByID (FormID a_formID)

template<class T >
static T *	LookupByID (FormID a_formID)

static TESForm *	LookupByEditorID (const std::string_view &a_editorID)

template<class T >
static T *	LookupByEditorID (const std::string_view &a_editorID)

Member Enumeration Documentation

◆ BehaviourFlag

enum RE::BGSScene::BehaviourFlag

strong

Enumerator
kNone
kDeathPause
kDeathEnd
kCombatPause
kCombatEnd
kDialoguePause
kDialogueEnd
kOBS_COMPause
kOBS_COMEnd

◆ Flag

enum RE::BGSScene::Flag

strong

Enumerator
kNone
kBeginOnQuestStart
kStopOnQuestEnd
kRepeatConditionsWhileTrue
kInterruptible

Constructor & Destructor Documentation

◆ ~BGSScene()

RE::BGSScene::~BGSScene ( )

override

Member Function Documentation

◆ InitializeData()

void RE::BGSScene::InitializeData ( )

overridevirtual

Reimplemented from RE::TESForm.

◆ InitItemImpl()

void RE::BGSScene::InitItemImpl ( )

overridevirtual

Reimplemented from RE::TESForm.

◆ InitLoadGame()

void RE::BGSScene::InitLoadGame ( BGSLoadFormBuffer * a_buf )

overridevirtual

Reimplemented from RE::TESForm.

◆ Load()

bool RE::BGSScene::Load ( TESFile * a_mod )

overridevirtual

Reimplemented from RE::TESForm.

◆ LoadGame()

void RE::BGSScene::LoadGame ( BGSLoadFormBuffer * a_buf )

overridevirtual

Reimplemented from RE::TESForm.

◆ Revert()

void RE::BGSScene::Revert ( BGSLoadFormBuffer * a_buf )

overridevirtual

Reimplemented from RE::TESForm.

◆ SaveGame()

void RE::BGSScene::SaveGame ( BGSSaveFormBuffer * a_buf )

overridevirtual

Reimplemented from RE::TESForm.

Member Data Documentation

◆ actions

BSTArray<BGSSceneAction*> RE::BGSScene::actions

◆ actorFlags

BSTArray<stl::enumeration<SCENE_ACTOR_FLAG, std::uint32_t> > RE::BGSScene::actorFlags

◆ actorProgressionFlags

BSTArray<stl::enumeration<BehaviourFlag, std::uint32_t> > RE::BGSScene::actorProgressionFlags

◆ actors

BSTArray<FormID> RE::BGSScene::actors

◆ conditions

TESCondition RE::BGSScene::conditions

◆ flags

stl::enumeration<Flag, std::uint32_t> RE::BGSScene::flags

◆ FORMTYPE

constexpr auto RE::BGSScene::FORMTYPE = FormType::Scene

inlinestaticconstexpr

◆ padA4

std::uint32_t RE::BGSScene::padA4

◆ padC4

std::uint32_t RE::BGSScene::padC4

◆ parentQuest

TESQuest* RE::BGSScene::parentQuest

◆ phases

BSTArray<BGSScenePhase*> RE::BGSScene::phases

◆ RTTI

constexpr auto RE::BGSScene::RTTI = RTTI_BGSScene

inlinestaticconstexpr

◆ unkB0

std::uint32_t RE::BGSScene::unkB0

◆ unkB4

std::uint32_t RE::BGSScene::unkB4

◆ unkB8

std::uint32_t RE::BGSScene::unkB8

◆ unkBC

std::uint32_t RE::BGSScene::unkBC

◆ unkC0

std::uint32_t RE::BGSScene::unkC0

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

CommonLibSSE/include/RE/B/BGSScene.h

Classes

Public Types

Public Member Functions

Public Attributes

Static Public Attributes

Additional Inherited Members

Member Enumeration Documentation

◆ BehaviourFlag

◆ Flag

Constructor & Destructor Documentation

◆ ~BGSScene()

Member Function Documentation

◆ InitializeData()

◆ InitItemImpl()

◆ InitLoadGame()

◆ Load()

◆ LoadGame()

◆ Revert()

◆ SaveGame()

Member Data Documentation

◆ actions

◆ actorFlags

◆ actorProgressionFlags

◆ actors

◆ conditions

◆ flags

◆ FORMTYPE

◆ padA4

◆ padC4

◆ parentQuest

◆ phases

◆ RTTI

◆ unkB0

◆ unkB4

◆ unkB8

◆ unkBC

◆ unkC0