Function __global->_deal_with_chatcode_invite
Definitions
sources/chat.php
- Parse invitation chat code tag.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Returns: array
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $pm_user | string | No | No | required parameter | N/A | N/A | Comma-separated list of members to invite |
| $pm_message | string | No | No | required parameter | N/A | N/A | The room name |
| $username | SHORT_TEXT | No | No | required parameter | N/A | N/A | The username of who made this chatcode |
| $text | string | No | No | required parameter | N/A | N/A | The text we are using |
| $zone | ID_TEXT | No | No | required parameter | N/A | N/A | The zone the chat module is in |
Returns
- A pair: whether the message was deleted, and the new text of the message
- Type: array
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* Parse invitation chat code tag.
*
* @param string $pm_user Comma-separated list of members to invite
* @param string $pm_message The room name
* @param SHORT_TEXT $username The username of who made this chatcode
* @param string $text The text we are using
* @param ID_TEXT $zone The zone the chat module is in
* @return array A pair: whether the message was deleted, and the new text of the message
*/
function _deal_with_chatcode_invite(string $pm_user, string $pm_message, string $username, string $text, string $zone) : array
* Parse invitation chat code tag.
*
* @param string $pm_user Comma-separated list of members to invite
* @param string $pm_message The room name
* @param SHORT_TEXT $username The username of who made this chatcode
* @param string $text The text we are using
* @param ID_TEXT $zone The zone the chat module is in
* @return array A pair: whether the message was deleted, and the new text of the message
*/
function _deal_with_chatcode_invite(string $pm_user, string $pm_message, string $username, string $text, string $zone) : array
