NoveltyML reference > Objects > Set

<Set>

A set object.
A set is an object that can contain multiple states. Only one state is drawn at any one time. The content of the selected state is rendered as a SmartCanvas.

Remarks: If a size isn't specifically specified then one will be calculated based on the content of the first state.

See also: <CanvasSet>

Set attributes

Attribute Description
dynamic Enable/disable dynamic (smart) rendering
flip Flip contents vertically
mirror Flip contents horizontally
state Default state ("State name")
transition Transition effect

Additionally, this asset type inherits all object attributes.

dynamic [bool]

Set this to false to disable smart rendering.
Default value: true

Example:
dynamic = "false"

flip [bool]

Set to true to vertically reverse texture.

Example:
flip = "true"

mirror [bool]

Set to true to horizontally reverse texture.

Example:
mirror = "true"

shape [string]

Name of a valid shape resource.

Example:
shape = "My shape"

state [string]

Default state name (must be valid).

Example:
state = "Default"

transition [integer]

Integer value corresponding to the transition mode.
Value Transition
0 None
1 Fast
2 Slow
3 Slower
4 Slowest

Example:
transition = "1"

Valid child tags

Child tags Description
<State> State container
<Mask> Mask texture
<Traits> Object traits list
<Meta> Meta information
Objects... Other objects

<State>

State container.

Attribute Description Type
name [Required] Unique name for this state String

Child tags Description Count
Objects... Other objects 0 or more

<Mask>

Applies a mask to the Set

Attribute Description Type
texture [Required] Name of a texture resource String
rect Masked region ("x, y, width, height") Vector4

Valid meta class values

Class Description
"actor" Hint to editor that this object is a character/actor.

Example

<Set name="My set" size="640,480" >
	<State name="Happy">
		<Image texture="Happy face" />
	</State>
	<State name="Sad">
		<Image texture="Sad face" />
	</State>
</Set>
Back to top