Skip to main content

Chat

client:say(msg)

FieldType
Signature(self: Client, msg: string) → string?
Returnsstring?nil on success
Common errorsErrors.NOT_IN_WORLD, Errors.DISCONNECTED
Asyncyes

client:setStatus(icon)

FieldType
Signature(self: Client, icon: number) → string?
Returnsstring?nil on success
Asyncyes

Pass a StatusIconType.* constant.

client:setStatus(StatusIconType.typing)
client:say("hello!")
client:setStatus(StatusIconType.none)

StatusIconType values:

StatusIconType.none
StatusIconType.menu
StatusIconType.typing
StatusIconType.trading
StatusIconType.card

Misc presence / animation

client:setIsVisible(show)

FieldType
Signature(self: Client, show: boolean) → string?
Returnsstring?nil on success
Asyncyes

Toggles location visibility.

client:setIsOnline(show)

FieldType
Signature(self: Client, show: boolean) → string?
Returnsstring?nil on success
Asyncyes

Toggles account online status.

client:setFaceAnimation(animId)

FieldType
Signature(self: Client, animId: number) → string?
Returnsstring?nil on success
Asyncyes

client:respawn()

FieldType
Signature(self: Client) → string?
Returnsstring?nil on success
Asyncyes

client:enter()

FieldType
Signature(self: Client) → string?
Returnsstring?nil on success
Asyncyes

Steps through whatever portal you're standing on.

client:setIsVisible(true)
client:setIsOnline(true)
client:setFaceAnimation(animId)
client:respawn()
client:enter()