NoveltyML reference > Objects > Set

<Set>
Inherits from <Object>.

A Set works just like a Canvas, but a number of renderable slots, or "states".
Only one state can be rendered at any point in time.

Attribute Description Type
canvas-size [Required] Texture size ("width, height") Vector2
state Default state ("State name") String
transition Transition effect Integer
mirror Flip image horizontally Boolean
flip Flip image vertically Boolean

Remarks: canvas-size will determine the size of the generated texture. If not set, the value size will be used instead. 2048x2048 is the max size.
Note: Generating textures larger than the game's current canvas size may result in minor graphical glitches.

If state is omitted, the first state is considered the default.

Any children to Set will be rendered for all states.

Transition effect Description
0 None
1 Fast
2 Slow
3 Slower
4 Slowest

Child tags Description Count
<State> State container 1 or more
<Mask> Mask texture
1


<State>
State container.

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

Child tags Description Count
<Object> 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


Inherited from <Object>

Attribute Description Type
name [Required] Unique name for this object String
position Position ("x,y") Vector2
pivot Pivot point ("x,y") Vector2
rotation Rotation in radians Float
scale Scale multiplier Float
size Size ("width, height") Vector2
visible Visibility Boolean
rgb Color ("red, green, blue") Vector3
opacity Opacity Float
blending Blending mode Integer
auto-size Automatic sizing based on parent's size ("width%, height%") Vector2
auto-position Automatic position based on parent's size ("x%, y%") Vector2
pixelated Disable linear interpolation of texture Boolean

Remarks: auto-position and auto-size overrides position and size respectively.

Child tags Description Count
<Behaviour> Object behaviours 0 or more
<Meta> Meta information
1
<Object> Other objects 0 or more


NoveltyML sample
<Set name="My set" size="640,480" >
	<State name="Happy">
		<Image name="Happy image" texture="Happy face" />
	</State>
	<State name="Sad">
		<Image name="Sad image" texture="Sad face" />
	</State>
</Set>
		


Back to top