Z.Symbol

Inherits from Z.Group

Description

The Z.Symbol object represents a symbol as created in ZapWorks Studio. Note that every project has a root symbol even if it has no subsymbols.

The current symbol can be accessed using symbol from scripts within ZapWorks Studio.

Constructs a new Z.Symbol instantiated from the definition specified.

close	Emitted when the symbol is to be closed.
closed	Emitted once the symbol has been completely removed from display.
hidden	Emitted when any hide animations/state changes have completed.

attach( )	Adds the symbol to Z.scene.
close( )	Calls hide() on this symbol and then detach() once hidden has been emitted.
controller(...)	Gets the Z.Controller in this symbol with the specified name.
detach( )	Removes the symbol from Z.scene.
display( )	Adds the symbol to Z.scene and calls show().
hide( )	Emits hide on this symbol then on all hierarchy-instantiated subsymbols of this symbol.
node(...)	Gets the node in this symbol with the specified name.
show( )	Emits show on all hierarchy-instantiated subsymbols of this symbol, and then on this symbol itself.

Constructs a new Z.Group object.

child(...)	Gets the child node at the specified index.
children( )	Gets the children of the group.
clear( )	Removes all children from the group.
insert(...)	Inserts a node into the group at the specified index.
push(...)	Inserts a node as the last child of the group.
remove(...)	Removes a node from the group.

blend( )	Gets the type of blending used to render this object.
blend(...)	Sets the type of blending used to render this object
color( )	Gets the color of the node.
color(...)	Sets the color of the node.
cullFaces( )	Gets the type of culling to performed on this object.
cullFaces(...)	Sets the type of culling to performed on this object.
enabled( )	Gets the value of enabled for the node.
enabled(...)	Sets the value of enabled for the node.
position( )	Gets the position of the node.
position(...)	Sets the position of the node
relativeTo( )	Gets an array of nodes that this node's location is relative to.
relativeTo(...)	Sets the node(s) that this node's location is relative to.
relativeToProp( )	Gets the ratio of contributions that the nodes specified by relativeTo have on this node's location.
relativeToProp(...)	Sets the ratio of contributions that the nodes specified by relativeTo have on this node's location.
rotation( )	Gets the rotation of the node.
rotation(...)	Sets the rotation of the node.
scale( )	Gets the scale of the node.
scale(...)	Sets the scale of the node.
visible( )	Gets the visibility of the node.
visible(...)	Sets the visibility of this node.

emit(...)	Calls the handler functions attached to an event.
hasTag(...)	Returns true if this object has the specified tag.
off(...)	Removes a handler function from an event.
on(...)	Attaches a handler function to an event.
one(...)	Attaches a single-use handler function to an event.
pushTag(...)	Adds a tag to this object.
removeTag(...)	Removes a tag from this object.
tags( )	Gets an array of the tags that this object belongs to.
tags(...)	Sets the array of the tags that this object belongs to.