Chat
client:say(msg)
| Field | Type |
|---|---|
| Signature | (self: Client, msg: string) → string? |
| Returns | string? — nil on success |
| Common errors | Errors.NOT_IN_WORLD, Errors.DISCONNECTED |
| Async | yes |
client:setStatus(icon)
| Field | Type |
|---|---|
| Signature | (self: Client, icon: number) → string? |
| Returns | string? — nil on success |
| Async | yes |
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)
| Field | Type |
|---|---|
| Signature | (self: Client, show: boolean) → string? |
| Returns | string? — nil on success |
| Async | yes |
Toggles location visibility.
client:setIsOnline(show)
| Field | Type |
|---|---|
| Signature | (self: Client, show: boolean) → string? |
| Returns | string? — nil on success |
| Async | yes |
Toggles account online status.
client:setFaceAnimation(animId)
| Field | Type |
|---|---|
| Signature | (self: Client, animId: number) → string? |
| Returns | string? — nil on success |
| Async | yes |
client:respawn()
| Field | Type |
|---|---|
| Signature | (self: Client) → string? |
| Returns | string? — nil on success |
| Async | yes |
client:enter()
| Field | Type |
|---|---|
| Signature | (self: Client) → string? |
| Returns | string? — nil on success |
| Async | yes |
Steps through whatever portal you're standing on.
client:setIsVisible(true)
client:setIsOnline(true)
client:setFaceAnimation(animId)
client:respawn()
client:enter()