Skip to content

class Texture (client-side)

Available since version: 0.1.0

This class represents texture visible on the screen.

Constructor

int x, int y, int width, int height, string txt

Parameters:

  • int x: the x position in virtuals.
  • int y: the y position in virtuals.
  • int width: the width size in virtuals.
  • int height: the height size in virtuals.
  • string txt: the texture file to display.

Properties

bool visible

Available since version: 0.1.0

Represents the visibility state of the texture.

string file

Available since version: 0.1.0

Represents the file name of displayed image on texture.

int alpha

Available since version: 0.1.10

Represents the text alpha color component in RGBA model.

float rotation

Available since version: 0.1.10

Represents the rotation of the texture in degrees.
The rotation is performed clockwise around the texture pivot point.

Methods

top

Available since version: 0.1.0

This method will move the texture at the end of the render queue.
It will be visible at the top of the screen (other elements will be covered by it).

void top()

setColor

Available since version: 0.1.0

This method will set the texture color.

void setColor(int r, int g, int b)

Parameters:

  • int r: the red color component in RGB model.
  • int g: the green color component in RGB model.
  • int b: the blue color component in RGB model.

getColor

Available since version: 0.1.0

This method will get the texture color.

{r, g, b} getColor()

Returns {r, g, b}:

the texture color.

setAlpha

Deprecated since version: 0.1.10

This method will set the texture alpha channel.

void setAlpha(int alpha)

Parameters:

  • int alpha: the alpha color component in RGBA model.

getAlpha

Deprecated since version: 0.1.10

This method will get the texture alpha channel.

int getAlpha()

Returns int:

the alpha color component in RGBA model.

setPosition

Available since version: 0.1.0

This method will set the texture position on screen in virtuals.

void setPosition(int x, int y)

Parameters:

  • int x: the x position in virtuals.
  • int y: the y position in virtuals.

setPositionPx

Available since version: 0.1.0

This method will set the texture position on screen in pixels.

void setPositionPx(int x, int y)

Parameters:

  • int x: the x position in pixels.
  • int y: the y position in pixels.

getPosition

Available since version: 0.1.0

This method will get the texture position on screen in virtuals.

{x, y} getPosition()

Returns {x, y}:

the texture position on screen.

getPositionPx

Available since version: 0.1.0

This method will get the texture position on screen in pixels.

{x, y} getPositionPx()

Returns {x, y}:

the texture position on screen.

setPivotPoint

Available since version: 0.1.10

This method will set the pivot point of the texture in virtuals (Offset from the center of it).
All rotations will be done relative to this point.

void setPivotPoint(int x, int y)

Parameters:

  • int x: the x offset in virtuals.
  • int y: the y offset in virtuals.

setPivotPointPx

Available since version: 0.1.10

This method will set the pivot point of the texture in pixels (Offset from the center of it).
All rotations will be done relative to this point.

void setPivotPointPx(int x, int y)

Parameters:

  • int x: the x offset in pixels.
  • int y: the y offset in pixels.

getPivotPoint

Available since version: 0.1.10

This method will get the pivot point of the texture in virtuals (Offset from the center of it).

{x, y} getPivotPoint()

Returns {x, y}:

the offset in virtuals. The default pivot point value is {x=0,y=0}

getPivotPointPx

Available since version: 0.1.10

This method will get the pivot point of the texture in pixels (Offset from the center of it).

{x, y} getPivotPointPx()

Returns {x, y}:

the offset in pixels. The default pivot point value is {x=0,y=0}

setSize

Available since version: 0.1.0

This method will set the texture size on screen in virtuals.

void setSize(int width, int height)

Parameters:

  • int width: the width size in virtuals.
  • int height: the height size in virtuals.

setSizePx

Available since version: 0.1.0

This method will set the texture size on screen in pixels.

void setSizePx(int width, int height)

Parameters:

  • int width: the width size in pixels.
  • int height: the height size in pixels.

getSize

Available since version: 0.1.0

This method will get the texture size on screen in virtuals.

{width, height} getSize()

Returns {width, height}:

the texture size on screen.

getSizePx

Available since version: 0.1.0

This method will get the texture size on screen in pixels.

{width, height} getSizePx()

Returns {width, height}:

the texture size on screen.

setRect

Available since version: 0.1.0

This method will set the mapping coordinates (UV) of the texture based on the supplied position & size in virtuals.

void setRect(int x, int y, int width, int height)

Parameters:

  • int x: the x position of image on texture.
  • int y: the y position of image on texture.
  • int width: the width size of image on texture.
  • int height: the height size of image on texture.

setRectPx

Available since version: 0.1.0

This method will set the mapping coordinates (UV) of the texture based on the supplied position & size in pixels.

void setRectPx(int x, int y, int width, int height)

Parameters:

  • int x: the x position of image on texture.
  • int y: the y position of image on texture.
  • int width: the width size of image on texture.
  • int height: the height size of image on texture.

getRect

Available since version: 0.1.0

This method will get the mapping coordinates (UV) of the texture based on the supplied position & size in virtuals.

{x, y, width, height} getRect()

Returns {x, y, width, height}:

the position and size of image on texture.

getRectPx

Available since version: 0.1.0

This method will get the mapping coordinates (UV) of the texture based on the supplied position & size in pixels.

{x, y, width, height} getRectPx()

Returns {x, y, width, height}:

the position and size of image on texture.

setUV

Available since version: 0.1.10

This method will set the mapping coordinates (UV) of the texture.

void setUV(float x, float y, float width, float height)

Parameters:

  • float x: the u position of image on texture (Default 0.0).
  • float y: the v position of image on texture (Default 0.0).
  • float width: the u size of image on texture (Default 1.0).
  • float height: the v size of image on texture (Default 1.0).

getUV

Available since version: 0.1.10

This method will get the mapping coordinates (UV) of the texture.

{x, y, width, height} getUV()

Returns {x, y, width, height}:

the position and size of image on texture.