Skip to content

Process ​

Properties ​

ignoreFormat ​

luau
Process.ignoreFormat: string

Functions ​

addCommandFilter ​

luau
Process.addCommandFilter(filter: (command: any) -> (boolean, string?)): () -> ()

Adds a filter that every command passes before it runs on this side, synchronously in Command:run before command requests are split off. filter(command) returns true to let it run, or false and a reason to cancel it, and may drop targets with command:dropTarget(argIndex, player). It must not yield. A filter that errors cancels the command. Returns a function that removes the filter.

Unlike the preCommand hook, which only observes, a filter can stop a command.

rawParse ​

luau
Process.rawParse(message: string, prefixes: { string }, delimiter: string): { any }?

Parses a string into a raw command format.

prepareCommands Client ​

luau
Process.prepareCommands(_K: any, from: number, rawText: string, global: boolean?)

runCommands Client ​

luau
Process.runCommands(_K: any, from: number, rawText: string, noLog: boolean?, global: boolean?, clientOnly: boolean?): boolean

Parses and runs a command string from a user. On the client, commands run their client part and the ones with a server part are sent to the server, unless clientOnly: the server already runs them (chat commands) and reports their prepare/server errors.