ChatCommand

Description

Supported Script Types:

  • Interface Scripts
  • Client Entity Scripts
  • Avatar Scripts
A chat command.

Create a new command using Chat.addCommand.

Properties

Name Type Summary
command string

Read-only

description string

Methods

Name Return Value Summary
run None

Sends the given message to all other users in world.

Signals

Name Summary
running

Triggered when a keyboard key is pressed.

Method Details

(static) run( paramsopt )

Sends the given message to all other users in world.

Parameters

Name Type Attributes Default Value Description
params string <optional>
""

The parameters the user typed after the command.

Signal Details

running( params )
Returns: Signal

Triggered when a keyboard key is pressed.

Parameters

Name Type Description
params string

The parameters the user typed after the command.