Field

Implementation of discords Field object as a Luau builder.

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

Summary

Properties

Field.name :: string?Field.value :: string?Field.inline :: boolean?

Methods

Field:setName(name: string) → FieldField:setValue(value: string) → FieldField:setIsInline(isInline: boolean) → FieldField:build() → JSON

Functions

Field.new(resource: { name: string?, value: string?, inline: boolean?, }?) → Field

Properties

name

Field.name  :: string?

---

The name of the field that is displayed.

value

Field.value  :: string?

---

The value of the field that is displayed.

inline

Field.inline  :: boolean?

---

Whether or not this field should display inline.

Methods

setName

Field : setName ( name )  -> Field

Set the name of the field

Parameters

name: string

Returns

Field

setValue

Field : setValue ( value )  -> Field

Set the value of the field

Parameters

value: string

Returns

Field

setIsInline

Field : setIsInline ( isInline )  -> Field

Set if the field is inline.

Parameters

isInline: boolean

Returns

Field

build

Field : build ( )  -> JSON

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

Returns

JSON

Functions

new

Field . new ( resource )  -> Field

Responsible for creating a new Field.

Parameters

resource: { name: string?, value: string?, inline: boolean?, }

Returns

Field