MAGE  v0.171.0
Matthias Advanced Game Engine
mage::script::EditorScript Class Reference

#include <editor_script.hpp>

Inheritance diagram for mage::script::EditorScript:
mage::BehaviorScript mage::Component

Public Member Functions

 EditorScript () noexcept
 
 EditorScript (const EditorScript &script) noexcept
 
 EditorScript (EditorScript &&script) noexcept
 
virtual ~EditorScript ()
 
EditorScript & operator= (const EditorScript &script) noexcept
 
EditorScript & operator= (EditorScript &&script) noexcept
 
virtual void Load ([[maybe_unused]] Engine &engine) override
 
virtual void Update ([[maybe_unused]] Engine &engine) override
 
- Public Member Functions inherited from mage::BehaviorScript
virtual ~BehaviorScript ()
 
BehaviorScript & operator= (const BehaviorScript &script) noexcept
 
BehaviorScript & operator= (BehaviorScript &&script) noexcept
 
virtual void FixedUpdate ([[maybe_unused]] Engine &engine)
 
virtual void Close ([[maybe_unused]] Engine &engine)
 
- Public Member Functions inherited from mage::Component
virtual ~Component ()
 
Component & operator= (const Component &component) noexcept
 
Component & operator= (Component &&component) noexcept
 
State GetState () const noexcept
 
void SetState (State state) noexcept
 
U64 GetGuid () const noexcept
 
bool HasOwner () const noexcept
 
ProxyPtr< Node > GetOwner () noexcept
 
ProxyPtr< const Node > GetOwner () const noexcept
 

Private Attributes

ProxyPtr< Node > m_selected
 

Additional Inherited Members

- Protected Member Functions inherited from mage::BehaviorScript
 BehaviorScript () noexcept
 
 BehaviorScript (const BehaviorScript &script) noexcept
 
 BehaviorScript (BehaviorScript &&script) noexcept
 
- Protected Member Functions inherited from mage::Component
 Component () noexcept
 
 Component (const Component &component) noexcept
 
 Component (Component &&component) noexcept
 

Constructor & Destructor Documentation

◆ EditorScript() [1/3]

mage::script::EditorScript::EditorScript ( )
defaultnoexcept

◆ EditorScript() [2/3]

mage::script::EditorScript::EditorScript ( const EditorScript &  script)
defaultnoexcept

◆ EditorScript() [3/3]

mage::script::EditorScript::EditorScript ( EditorScript &&  script)
defaultnoexcept

◆ ~EditorScript()

mage::script::EditorScript::~EditorScript ( )
virtualdefault

Member Function Documentation

◆ Load()

void mage::script::EditorScript::Load ( [[maybe_unused] ] Engine &  engine)
overridevirtual

Loads this behavior script. Allows this behavior script to preform any pre-processing.

Parameters
[in,out]engineA reference to the engine.
Exceptions
ExceptionFailed to load this behavior script.

Reimplemented from mage::BehaviorScript.

◆ operator=() [1/2]

EditorScript & mage::script::EditorScript::operator= ( const EditorScript &  script)
defaultnoexcept

◆ operator=() [2/2]

EditorScript & mage::script::EditorScript::operator= ( EditorScript &&  script)
defaultnoexcept

◆ Update()

void mage::script::EditorScript::Update ( [[maybe_unused] ] Engine &  engine)
overridevirtual

Updates this behavior script.

This method is called once per frame.

Parameters
[in,out]engineA reference to the engine.
Exceptions
ExceptionFailed to update this behavior script.

Reimplemented from mage::BehaviorScript.

Member Data Documentation

◆ m_selected

ProxyPtr< Node > mage::script::EditorScript::m_selected
private