Mutator Class Reference

#include <Mutator.h>

Inheritance diagram for Mutator:
Component

# Public Types

typedef const MutatorSpec MutatorROMSpec

# Public Member Functions

void constructor (Entity owner, const MutatorSpec *mutatorSpec)
void enable ()
 Enable the mutator's operations.
void disable ()
 Disable the mutator's operations.
bool isEnabled ()

# Protected Attributes

bool enabled
 Flag to allow or prohibit the mutator to perform its operations.

# Additional Inherited Members

- Private Types inherited from Component
enum  ComponentCommands
enum  ComponentTypes
- Private Member Functions inherited from Component
void constructor (Entity owner, const ComponentSpec *componentSpec)
void destructor ()
 Class' destructor.
ComponentSpecgetSpec ()
Entity getOwner ()
 Retrieve the collider's owner.
uint32 getType ()
virtual void releaseResources ()
 Called to release the component.
virtual void handleCommand (int32 command, va_list args)
virtual RightBox getRightBox ()
- Private Attributes inherited from Component
Entity owner
 Object to which this component attaches to.
const ComponentSpeccomponentSpec
 Pointer to the spec that defines how to initialize the component.
const Transformationtransformation
bool deleteMe
 Flag to mark the component as pending deletion.

# Detailed Description

Class Mutator

Inherits from Component

Right now, this is only used by the Vehicle class in the plugins. Eventually, this will serve to avoid the need to inherit from Actor.

Definition at line 52 of file Mutator.h.

# Member Typedef Documentation

# MutatorROMSpec

typedef const MutatorSpec MutatorROMSpec

A Mutator spec that is stored in ROM

Definition at line 40 of file Mutator.h.

# Member Function Documentation

# constructor()

void Mutator::constructor ( Entity owner,
const MutatorSpec * mutatorSpec )

Class' constructor

Parameters
ownerEntity to which the mutator attaches to
mutatorSpecSpecification that determines how to configure the mutator

Definition at line 22 of file Mutator.c.

# disable()

void Mutator::disable ( )

Disable the mutator's operations.

Definition at line 52 of file Mutator.c.

# enable()

void Mutator::enable ( )

Enable the mutator's operations.

Definition at line 45 of file Mutator.c.

# isEnabled()

bool Mutator::isEnabled ( )

Check if the mutator's operations are enabled.

Returns
True if the mutator's operations are enabled; false otherwise

Definition at line 59 of file Mutator.c.

# Member Data Documentation

# enabled

bool Mutator::enabled
protected

Flag to allow or prohibit the mutator to perform its operations.

Definition at line 57 of file Mutator.h.


The documentation for this class was generated from the following files:
  • VUEngine-Core/source/Component/Mutator/Mutator.h
  • VUEngine-Core/source/Component/Mutator/Mutator.c