@discord-types/builders/embed/field
API reference for @discord-types/builders/embed/field
@discord-types/builders/embed/field
Types
Field
Raw Type
type Field = Field.Prototype, & {
name: string?,
value: string?,
inline: boolean?
}
Intersection with variants:
JSON
Raw Type
type JSON = Field.Prototype.build({} :: any),
Functions
Field.Prototype.setName
[[ Set the name of the field ]]
Function Signature
--[[
Set the name of the field
]]
function Field.Prototype.setName(self: Field, name: string) -> Field end
Arguments
name
Returns
ret1
Field.Prototype.setValue
[[ Set the value of the field ]]
Function Signature
--[[
Set the value of the field
]]
function Field.Prototype.setValue(self: Field, value: string) -> Field end
Arguments
value
Returns
ret1
Field.Prototype.setIsInline
[[ Set if the field is inline. ]]
Function Signature
--[[
Set if the field is inline.
]]
function Field.Prototype.setIsInline(self: Field, isInline: boolean) -> Field end
Arguments
isInline
Returns
ret1
Field.Prototype.build
[[ Responsible for building the Field JSON that can be parsed by the Discord API. ]]
Function Signature
--[[
Responsible for building the Field JSON that can be parsed by the Discord API.
]]
function Field.Prototype.build(self: Field) -> JSON end
Returns
ret1
Field.Interface.new
[[ Responsible for creating a new Field.
```lua
``` ]]
Function Signature
--[[
Responsible for creating a new Field.
\`\`\`lua
\`\`\`
]]
function Field.Interface.new(resource: {
name: string?,
value: string?,
inline: boolean?
}?) -> Field end
Arguments
resource
This field is optional and may not be specified
{name: string?, value: string?, inline: boolean?}?
Returns
ret1
Last updated on