xbot/mods/lua/README.md

# API

## Lua Commands

### `raw(message)`

Sends a raw message to the server.

### `privmsg(to, message)`

Sends a message to a channel or user.

### `notice(to, message)`

Sends a notice to a channel or user.

### `join(channel)`

Joins a channel.

### `part(channel, reason)`

Leaves a channel.

### `kick(channel, user, reason)`

Kicks a user from a channel. Reason is optional.

### `mode(channel, mode, target)`

Sets a mode on a channel.

### `ctcp(to, message)`

Sends a CTCP message to a channel or user.
more work on lua module 2024-03-02 08:11:50 +00:00			`# API`

			`## Lua Commands`

update lua mod readme 2024-03-02 08:16:58 +00:00			### `raw(message)`
more work on lua module 2024-03-02 08:11:50 +00:00
			`Sends a raw message to the server.`

update lua mod readme 2024-03-02 08:16:58 +00:00			### `privmsg(to, message)`
more work on lua module 2024-03-02 08:11:50 +00:00
			`Sends a message to a channel or user.`

update lua mod readme 2024-03-02 08:16:58 +00:00			### `notice(to, message)`
more work on lua module 2024-03-02 08:11:50 +00:00
			`Sends a notice to a channel or user.`

update lua mod readme 2024-03-02 08:16:58 +00:00			### `join(channel)`
more work on lua module 2024-03-02 08:11:50 +00:00
			`Joins a channel.`

update lua mod readme 2024-03-02 08:16:58 +00:00			### `part(channel, reason)`
more work on lua module 2024-03-02 08:11:50 +00:00
			`Leaves a channel.`

update lua mod readme 2024-03-02 08:16:58 +00:00			### `kick(channel, user, reason)`
more work on lua module 2024-03-02 08:11:50 +00:00
			`Kicks a user from a channel. Reason is optional.`

update lua mod readme 2024-03-02 08:16:58 +00:00			### `mode(channel, mode, target)`
more work on lua module 2024-03-02 08:11:50 +00:00
			`Sets a mode on a channel.`

update lua mod readme 2024-03-02 08:16:58 +00:00			### `ctcp(to, message)`
more work on lua module 2024-03-02 08:11:50 +00:00
			`Sends a CTCP message to a channel or user.`