Image

Implementation of discords Image object as a Luau builder.

https://discord.com/developers/docs/resources/message#embed-object-embed-image-structure

Summary

Properties

Image.url :: stringImage.proxyUrl :: string?Image.height :: number?Image.width :: number?

Methods

Image:setUrl(url: string, proxyUrl: string?) → ImageImage:setHeight(height: number) → ImageImage:setWidth(width: number) → ImageImage:build() → JSON

Functions

Image.new(resource: { url: string, proxyUrl: string?, height: number?, width: number?, }?) → Image

Properties

url

Image.url  :: string

---

Source url of image (only supports http(s) and attachments)

proxyUrl

Image.proxyUrl  :: string?

---

A proxied url of the image

height

Image.height  :: number?

---

Height of image

width

Image.width  :: number?

---

Width of image

Methods

setUrl

Image : setUrl ( url ,  proxyUrl )  -> Image

Set the image url for this embed.

Parameters

url: string
proxyUrl: string?

Returns

Image

setHeight

Image : setHeight ( height )  -> Image

Set the image height for this embed.

Parameters

height: number

Returns

Image

setWidth

Image : setWidth ( width )  -> Image

Set the image width for this embed.

Parameters

width: number

Returns

Image

build

Image : build ( )  -> JSON

Responsible for building the JSON that can be parsed by the Discord API.

Returns

JSON

Functions

new

Image . new ( resource )  -> Image

Responsible for creating a new Image.

local image = Image.new({
  url = "https://example.com/image.png",
  height = 100,
  width = 100
})

Parameters

resource: { url: string, proxyUrl: string?, height: number?, width: number?, }

Returns

Image