Novelty scripting reference > Types > Mask


Representation of an Image mask.
Mask is a reference type. This means it has no constructor and can only be passed around by handle (Mask@).


bool flip (Property)
Flip mask texture.

bool mirror (Property)
Mirror mask texture.


string GetTexture() const
Returns the name of the image's texture asset.

bool SetTexture(const string &in assetName)
Change the texture asset. Returns true if successful.
This method won't work for image types with internal textures: Canvas, CanvasSet, Video.

Vector4 GetRect() const
Returns the mask's rectangle (x, y, width, height).

void SetRect(int x, int y, int, width, int height)
void SetRect(const Vector4 &in clippingRect)
Set the mask's rectangle (x, y, width, height).

Vector2 GetTiling() const
Returns the mask tiling (x, y).

void SetTiling(float x, float y)
void SetTiling(const Vector2 &in tiling)
Change the mask tiling (x, y).

Back to top