Melonity Docs

Image ​

The Image class provides helpers for loading and drawing image resources.

Methods ​

constructor(name: string, options?: LoadImageOptions)Image ​

Creates a new Image instance.

Returned:

  • Image - The result of the call.

GetSize()[number, number] ​

Retrieves the size.

Returned:

  • [number, number] - The requested size.

GetPath()string ​

Retrieves the path.

Returned:

  • string - The requested path.

GetIndex()number ​

Retrieves the index.

Returned:

  • number - The requested index.

DrawImage(x: number, y: number, width: number, height: number, rounding?: number, corners?: Enum.RoundCorners, uv1?: [number, number], uv2?: [number, number])void ​

Draws the image.

  • xnumber - The x coordinate.
  • ynumber - The y coordinate.
  • widthnumber - The width value.
  • heightnumber - The height value.
  • roundingnumber (optional) - The rounding.
  • cornersEnum.RoundCorners (optional) - The corners.
  • uv1[number, number] (optional) - The uv1.
  • uv2[number, number] (optional) - The uv2.

DrawImageQuad(x1: number, y1: number, x2: number, y2: number, x3: number, y3: number, x4: number, y4: number, uv1?: [number, number], uv2?: [number, number], uv3?: [number, number], uv4?: [number, number])void ​

Draws the image quad.

  • x1number - The x1.
  • y1number - The y1.
  • x2number - The x2.
  • y2number - The y2.
  • x3number - The x3.
  • y3number - The y3.
  • x4number - The x4.
  • y4number - The y4.
  • uv1[number, number] (optional) - The uv1.
  • uv2[number, number] (optional) - The uv2.
  • uv3[number, number] (optional) - The uv3.
  • uv4[number, number] (optional) - The uv4.

DrawWorldImage(vec: Vector, width: number, height: number, xOffset?: number, yOffset?: number, rounding?: number, corners?: Enum.RoundCorners, uvMin?: [number, number], uvMax?: [number, number])void ​

Draws the world image.

  • vecVector - The world position vector.
  • widthnumber - The width value.
  • heightnumber - The height value.
  • xOffsetnumber (optional) - The x offset.
  • yOffsetnumber (optional) - The y offset.
  • roundingnumber (optional) - The rounding.
  • cornersEnum.RoundCorners (optional) - The corners.
  • uvMin[number, number] (optional) - The uv min.
  • uvMax[number, number] (optional) - The uv max.

IsLoaded()boolean ​

Checks whether it is loaded.

Returned:

  • boolean - True if the condition is met, false otherwise.

Load()void ​

Loads the load.

IsValid()boolean ​

Checks whether it is valid.

Returned:

  • boolean - True if the condition is met, false otherwise.