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

#include <character_motor_script.hpp>

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

Public Member Functions

 CharacterMotorScript ()
 
 CharacterMotorScript (const CharacterMotorScript &script) noexcept
 
 CharacterMotorScript (CharacterMotorScript &&script) noexcept
 
virtual ~CharacterMotorScript ()
 
CharacterMotorScriptoperator= (const CharacterMotorScript &script) noexcept
 
CharacterMotorScriptoperator= (CharacterMotorScript &&script) noexcept
 
virtual void Load ([[maybe_unused]] Engine &engine) override
 
virtual void Update ([[maybe_unused]] Engine &engine) override
 
F32 GetVelocity () const noexcept
 
void SetVelocity (F32 velocity) noexcept
 
- Public Member Functions inherited from mage::BehaviorScript
virtual ~BehaviorScript ()
 
BehaviorScriptoperator= (const BehaviorScript &script) noexcept
 
BehaviorScriptoperator= (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 ()
 
Componentoperator= (const Component &component) noexcept
 
Componentoperator= (Component &&component) noexcept
 
State GetState () const noexcept
 
void SetState (State state) noexcept
 
U64 GetGuid () const noexcept
 
bool HasOwner () const noexcept
 
ProxyPtr< NodeGetOwner () noexcept
 
ProxyPtr< const NodeGetOwner () const noexcept
 

Private Attributes

F32 m_velocity
 

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

◆ CharacterMotorScript() [1/3]

mage::script::CharacterMotorScript::CharacterMotorScript ( )

◆ CharacterMotorScript() [2/3]

mage::script::CharacterMotorScript::CharacterMotorScript ( const CharacterMotorScript script)
defaultnoexcept

◆ CharacterMotorScript() [3/3]

mage::script::CharacterMotorScript::CharacterMotorScript ( CharacterMotorScript &&  script)
defaultnoexcept

◆ ~CharacterMotorScript()

mage::script::CharacterMotorScript::~CharacterMotorScript ( )
virtualdefault

Member Function Documentation

◆ GetVelocity()

F32 mage::script::CharacterMotorScript::GetVelocity ( ) const
noexcept

◆ Load()

void mage::script::CharacterMotorScript::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]

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

◆ operator=() [2/2]

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

◆ SetVelocity()

void mage::script::CharacterMotorScript::SetVelocity ( F32  velocity)
noexcept

◆ Update()

void mage::script::CharacterMotorScript::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_velocity

F32 mage::script::CharacterMotorScript::m_velocity
private