menu::MActor Class Reference

Represents an actor. More...

Inheritance diagram for menu::MActor:

Public Member Functions
	MActor ()
	constructor taking no param More...
void	initialize ()
void	start ()
void	stop ()
void	rewind ()
void	warp ()
void	forward ()
void	backward ()
void	flip ()
void	restart ()
void	reset ()
Public Member Functions inherited from menu::MNode
MNode	doCopy ()
	Makes a copy of this node. More...
String	getNodePath (MNode relative_to=nil, String module_separator=nil)
	Gets this node's path. More...
void	doInitialize (MRenderContext context)
	Initializes this node. More...
void	doFinalize (MRenderContext context)
	Finalizes (destroys) this node. More...
Public Member Functions inherited from System::Module
	Module ()
	constructor taking no param More...
	Module (String name)
	Constructs. More...
Bool	load (String scriptName)
	Loads all modules from the specified script. More...
void	defineModule (Module module)
	Defines a new module within this module. More...
void	defineModule (Object symbol, Module module)
	Defines a new module within this module. More...
void	defineClass (Class class)
	Defines a new class within this module. More...
void	defineClass (Object symbol, Class class)
	Defines a new class within this module. More...
void	defineStatic (String staticName, Object staticValue)
	Defines a new static within this module. More...
void	defineAttribute (String attributeName, Object attributeValue)
	Defines a new attribute within this module. More...
void	import (Module module, Object symbol)
	Imports a module onto this one. More...
void	import (Module module, Object symbol, Object alias)
	Imports a module onto this one with the specified alias. More...
void	removeStatic (String staticName)
	Removes a specific static member from the module by name. More...
void	clearStatic ()
	Clears all static members from the module. More...
void	each_attribute (FunctionObject< Array > func)
	Performs a callback on each attribute in the module. More...
void	map_attribute (FunctionObject< Array > func)
	Creates a new array populated with the results of calling a provided function on every element in the calling array. More...
Array	find_all (FunctionObject func)
	Finds all static members that matches the precondition. More...
Object	find_static (FunctionObject precondition)
	Finds a static member that matches the precondition. More...
String	getModulePath ()
	Gets the module's path name. More...
Object	getModuleAttribute (String path)
void	setModuleAttribute (String path, Object value)
Object	getScopeAttribute (String path)
void	setScopeAttribute (String path, Object value)
Public Member Functions inherited from System::Object
	Object ()
	constructor taking no param More...
Bool	isInstanceOf (Class classType)
	Returns whether an object is of a specific class/type. More...
Object	getDeepCopy ()
	Gets a deep copy of this object. More...
void	setDeepCopy (Object obj)
	Unk. More...
String	dump ()
	Dumps all info about an object. More...
Object	getObjectAttribute (string path)
void	setObjectAttribute (string path, Object value)
Bool	hasPrimitiveInterface ()
	Returns whether this object has a primitive interface. More...
Bool	toBool ()
	Casts this object to Bool. More...
Byte	toByte ()
	Casts this object to Byte. More...
Short	toShort ()
	Casts this object to Short. More...
Int	toInt ()
	Casts this object to Int. More...
Long	toLong ()
	Casts this object to Long. More...
UByte	toUByte ()
	Casts this object to UByte. More...
UShort	toUShort ()
	Casts this object to UShort. More...
UInt	toUInt ()
	Casts this object to UInt. More...
ULong	toULong ()
	Casts this object to ULong. More...
Float	toFloat ()
	Casts this object to Float. More...
Double	toDouble ()
	Casts this object to Double. More...
String	toString ()
	Casts this object to String. More...
Symbol	toSymbol ()
	Casts this object to Symbol. More...
Bool	hasArrayInterface ()
	Returns whether this object has an Array interface. More...
Int	getArrayCount ()
	Gets the Array item count for this object. More...
void	setArrayCount ()
	Sets the Array item count for this object. More...
Object	getArrayElement (Object arg0)
	Gets an Array item for this object. More...
void	setArrayElement (Object arg0, Object arg1)
	Sets the Array item for this object. More...
Bool	hasMapInterface ()
	Returns whether this object has a Map interface. More...
int	getMapCount ()
	Returns the count of items in the map. More...
void	setMapElement (Object arg0, Object arg1)
	Returns whether the Map has a specific object key. Bool hasMapElement(Object arg0);. More...
Object	getMapElement (Object arg0)
	Gets a Map element by key. More...
void	hasGeneratorInterface ()
	Returns whether this object has a generator interface. More...
Iterator	generator ()
	Returns generator (?) More...
void	hasIteratorInterface ()
	Returns whether this object has an iterator. More...
Iterator	iterator ()
	Gets the iterator for this object. More...
void	hasVariableInterface ()
	Returns whether this object is a variable. More...
void	hasFunctionInterface ()
	Returns whether this object has a function interface. More...
Object	call ()
	Calls this object as a function. More...
Bool	hasByteDataInterface ()
	Returns whether this object has a byte data interface. More...
Int	getByteDataCount ()
	Returns the ByteData size for this object. More...
void	setByteDataCount (Int count)
	Sets the ByteData size for this object. More...
Int	getByteDataCapacity ()
	Returns the ByteData capacity for this object. More...
void	setByteDataCapacity (Int capacity)
	Sets the ByteData capacity for this object. More...
ByteData	getByteData ()
	Gets the underlaying ByteData. More...
void	setByteData (ByteData bytedata)
	Sets the underlaying ByteData. More...
void	hasObjectSelectorInterface ()
	Returns whether this object has an object selector interface. More...
void	self ()
	Gets the get for this object if it has a get interface. More...
void	getArchiveTree ()
void	setArchiveTree ()
ByteData	serialize ()
	Serializes this object. More...
void	deserialize (ByteData serializedData)
	Deserializes this object. More...
void	defined (Object obj)
	Returns whether a certain object is defined within this object. More...
Array	find_all (FunctionObject func)
	Finds all the elements in this object that matches the predicates. More...
void	each_all (FunctionObject func)
	Applies callback to all elements in this object. More...
Array	map_all (FunctionObject< Object > func)
	Maps all the elements in this object. More...
Bool	operator!= ()
	Returns whether this object is not equal to another. More...
Bool	operator== ()
	Returns whether this object is equal to another. More...

Public Attributes
MNode	target_node
Bool	initial_playing
	Defaults true. More...
Bool	initial_pause
	Defaults false. More...
Bool	initial_reverse
	Defaults false. More...
String	focus_enter_action_name
	Focus enter action name. Defaults to "keep". More...
String	focus_leave_action_name
	Focus leave action name. Defaults to "keep". More...
MActor	next_actor
	Getter-only. More...
MActor	prev_actor
	Getter-only. More...
Object	on_effect_start
Object	on_effect_end
Object	rt_effect_start
Object	rt_effect_end
Bool	pause
	Whether the actor is paused. More...
Bool	reverse
Bool	out
	Setter-only. More...
Public Attributes inherited from menu::MNode
MNode	parent
	Gets or sets the parent node for this node. More...
MNode	next
	Getter-only. Gets the next node for this node. More...
MNode	prev
	Getter-only. Gets the previous node for this node. More...
MNode	next_node
	Getter-only. Gets the next node for this node. Same as next. More...
MNode	prev_node
	Getter-only. Gets the previous node for this node. Same as prev. More...
String	class_name
	Getter-only. Gets the class name of this node. i.e "MRootWindow". More...
String	prototype_name
	Getter-only. Gets the prototype name of this node. i.e "RootWindow". More...
String	node_name
	Getter-only. Gets the name of this node. i.e "TopRoot". More...
String	node_path
	Getter-only. Gets the path of this node. i.e "RunViewerProject::TopRoot". More...
Bool	has_alias_name
	Getter-only. More...
String	alias_name
	Alias name. Returns "nil" if not set (use has_alias_name) More...
Bool	has_script
	Whether this node is linked to a script. More...
Bool	is_enable
	Whether this node is enabled. More...
Bool	package_ref
MRootWindow	root_window
	Getter-only. Returns the root window linked to this node. More...
MProject	project
	Getter-only. Returns the project linked to this node. More...
Object	reset_script_check
Bool	has_alias
	Getter-only. More...
Bool	is_component
Public Attributes inherited from System::Module
String	name
	Returns the module name. More...
Public Attributes inherited from System::Object
Int	rc_size
	Getter-only. Reference counter size of this object. More...
Object	rc_class
	Getter-only. Type name of the object. More...
Int	rc_count
	Getter-only. Reference count of this object. More...
Int	weak_count
	Getter-only. Weak reference count of this object. More...
Class	class_id
	Class (type) object for this object. More...

Additional Inherited Members
Static Public Attributes inherited from menu::MNode
static String	GT4_compatible_name
	Setter-only. Unknown, sets an engine singleton. May not be used. More...

Detailed Description

Represents an actor.

Definition at line 8 of file MActor.cpp.

Constructor & Destructor Documentation

MActor()

menu::MActor::MActor ( )

inline

constructor taking no param

Definition at line 13 of file MActor.cpp.

Member Function Documentation

backward()

void menu::MActor::backward

(

)

flip()

void menu::MActor::flip

(

)

forward()

void menu::MActor::forward

(

)

initialize()

void menu::MActor::initialize

(

)

reset()

void menu::MActor::reset

(

)

restart()

void menu::MActor::restart

(

)

rewind()

void menu::MActor::rewind

(

)

start()

void menu::MActor::start

(

)

stop()

void menu::MActor::stop

(

)

warp()

void menu::MActor::warp

(

)

Member Data Documentation

focus_enter_action_name

String menu::MActor::focus_enter_action_name

Focus enter action name. Defaults to "keep".

Valid actions:

• "keep"
• "start"
• "pause"
• "stop"
• "restart"
• "reset"
• "reverse_start"
• "reverse_pause"
• "reverse_stop"
• "reverse_restart"
• "reverse_reset"
• "flip_start"
• "flip_pause"
• "flip_stop"
• "flip_restart"

Definition at line 55 of file MActor.cpp.

focus_leave_action_name

String menu::MActor::focus_leave_action_name

Focus leave action name. Defaults to "keep".

Valid actions:

• "keep"
• "start"
• "pause"
• "stop"
• "restart"
• "reset"
• "reverse_start"
• "reverse_pause"
• "reverse_stop"
• "reverse_restart"
• "reverse_reset"
• "flip_start"
• "flip_pause"
• "flip_stop"
• "flip_restart"

Definition at line 75 of file MActor.cpp.

initial_pause

Bool menu::MActor::initial_pause

Defaults false.

Definition at line 32 of file MActor.cpp.

initial_playing

Bool menu::MActor::initial_playing

Defaults true.

Definition at line 29 of file MActor.cpp.

initial_reverse

Bool menu::MActor::initial_reverse

Defaults false.

Definition at line 35 of file MActor.cpp.

next_actor

MActor menu::MActor::next_actor

Getter-only.

Definition at line 78 of file MActor.cpp.

on_effect_end

Object menu::MActor::on_effect_end

Definition at line 84 of file MActor.cpp.

on_effect_start

Object menu::MActor::on_effect_start

Definition at line 83 of file MActor.cpp.

out

Bool menu::MActor::out

Setter-only.

Definition at line 94 of file MActor.cpp.

pause

Bool menu::MActor::pause

Whether the actor is paused.

Definition at line 89 of file MActor.cpp.

prev_actor

MActor menu::MActor::prev_actor

Getter-only.

Definition at line 81 of file MActor.cpp.

reverse

Bool menu::MActor::reverse

Definition at line 91 of file MActor.cpp.

rt_effect_end

Object menu::MActor::rt_effect_end

Definition at line 86 of file MActor.cpp.

rt_effect_start

Object menu::MActor::rt_effect_start

Definition at line 85 of file MActor.cpp.

target_node

MNode menu::MActor::target_node

Definition at line 26 of file MActor.cpp.

---

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

• headers/menu/Actors/MActor.cpp