Function __global->chatter_active
Definitions
sources/chat.php
- Find whether a member is active in chat (i.e. not away).
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Returns: bool
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $member_id | MEMBER | No | No | required parameter | N/A | N/A | Member ID |
| $room_id | ?AUTO_LINK | No | No | Null | N/A | N/A | Room ID (null: lobby) |
Returns
- Whether the member is active
- Type: boolean
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* Find whether a member is active in chat (i.e. not away).
*
* @param MEMBER $member_id Member ID
* @param ?AUTO_LINK $room_id Room ID (null: lobby)
* @return boolean Whether the member is active
*/
function chatter_active(int $member_id, ?int $room_id = null) : bool
* Find whether a member is active in chat (i.e. not away).
*
* @param MEMBER $member_id Member ID
* @param ?AUTO_LINK $room_id Room ID (null: lobby)
* @return boolean Whether the member is active
*/
function chatter_active(int $member_id, ?int $room_id = null) : bool
