VoltAir
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Groups Pages
Signals | Public Member Functions | Properties | List of all members

Non-visual entities in the QML item tree that define behavior for their parent Actor. More...

Inheritance diagram for Logic:
QObject AcceleratorLogic CameraMovementLogic EmitterLogic GameInputLogic InterpolationLogic JavaScriptLogic MagneticAttractorLogic MagneticHighlightLogic PickupLogic RollingMovementLogic StopwatchLogic Trigger

Signals

void activeChanged ()
 Emitted when active changes. More...
 

Public Member Functions

 Logic (QObject *parent=nullptr)
 Constructs a Logic. More...
 
ActorgetActor () const
 Returns actor. More...
 
bool isActive () const
 Returns active. More...
 
void setActive (bool value)
 Sets active. More...
 
virtual void init ()
 Performs initialization of this Logic. More...
 
virtual void update ()
 Performs the update (i.e. execution of behavior) of this Logic. More...
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
virtual const QMetaObjectmetaObject () const
 
QString objectName () const
 
void setObjectName (const QString &name)
 
bool isWidgetType () const
 
bool isWindowType () const
 
bool signalsBlocked () const
 
bool blockSignals (bool block)
 
QThreadthread () const
 
void moveToThread (QThread *targetThread)
 
int startTimer (int interval, Qt::TimerType timerType)
 
void killTimer (int id)
 
findChild (const QString &name, QFlags< Qt::FindChildOption > options) const
 
QList< T > findChildren (const QString &name, QFlags< Qt::FindChildOption > options) const
 
QList< T > findChildren (const QRegExp &regExp, QFlags< Qt::FindChildOption > options) const
 
QList< T > findChildren (const QRegularExpression &re, QFlags< Qt::FindChildOption > options) const
 
const QObjectList & children () const
 
void setParent (QObject *parent)
 
void installEventFilter (QObject *filterObj)
 
void removeEventFilter (QObject *obj)
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const
 
bool disconnect (const QObject *receiver, const char *method) const
 
void dumpObjectTree ()
 
void dumpObjectInfo ()
 
bool setProperty (const char *name, const QVariant &value)
 
QVariant property (const char *name) const
 
QList< QByteArraydynamicPropertyNames () const
 
void destroyed (QObject *obj)
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const
 
bool inherits (const char *className) const
 
void deleteLater ()
 

Properties

Actor actor
 Parent actor that is affected by this Logic's behavior. More...
 
bool active
 Whether or not Engine calls update() on this Logic during the Engine::LOGICS_PHASE. More...
 
- Properties inherited from QObject
 objectName
 

Additional Inherited Members

- Static Public Member Functions inherited from QObject
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
bool disconnect (const QMetaObject::Connection &connection)
 
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
- Protected Member Functions inherited from QObject
QObjectsender () const
 
int senderSignalIndex () const
 
int receivers (const char *signal) const
 
bool isSignalConnected (const QMetaMethod &signal) const
 
virtual void timerEvent (QTimerEvent *event)
 
virtual void childEvent (QChildEvent *event)
 
virtual void customEvent (QEvent *event)
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 

Detailed Description

Non-visual entities in the QML item tree that define behavior for their parent Actor.

Logics are initialized in the first Engine::LOGICS_PHASE and are then evaluated through a call to update() on each subsequent Engine::LOGICS_PHASE.

Constructor & Destructor Documentation

Logic::Logic ( QObject parent = nullptr)
inlineexplicit

Constructs a Logic.

Parameters
parentParent object

Member Function Documentation

void Logic::activeChanged ( )
signal

Emitted when active changes.

Actor* Logic::getActor ( ) const
inline

Returns actor.

virtual void Logic::init ( )
virtual

Performs initialization of this Logic.

Note
This function can be called more than once if the Logic exists in the game outside of the Level and the Level is changed / re-loaded.

Reimplemented in EmitterLogic, InterpolationLogic, CameraMovementLogic, MagneticAttractorLogic, PickupLogic, ContactTrigger, WaterBodyLogic, AcceleratorLogic, JavaScriptLogic, and GameInputLogic.

bool Logic::isActive ( ) const
inline

Returns active.

void Logic::setActive ( bool  value)

Sets active.

Parameters
valueBoolean to set active to
virtual void Logic::update ( )
virtual

Property Documentation

bool Logic::active
readwrite

Whether or not Engine calls update() on this Logic during the Engine::LOGICS_PHASE.

Actor Logic::actor
read

Parent actor that is affected by this Logic's behavior.