Interface HostOnlyRoomConfigCallbacks

interface HostOnlyRoomConfigCallbacks {
    onAfterBanClear?(id: number, customData?: any): void;
    onAfterBansClear?(customData?: any): void;
    onAfterRoomLink?(link: string, customData?: any): void;
    onAfterRoomRecaptchaModeChange?(on: boolean, customData?: any): void;
    onAfterRoomTokenChange?(token: string, customData?: any): void;
    onBeforeBanClear?(id: number): any;
    onBeforeBansClear?(): any;
    onBeforeRoomLink?(link: string): any;
    onBeforeRoomRecaptchaModeChange?(on: boolean): any;
    onBeforeRoomTokenChange?(token: string): any;
}

Hierarchy (View Summary)

HostOnlyRoomConfigCallbacks
- AllRoomConfigCallbacks

Index

Methods

onAfterBanClear? onAfterBansClear? onAfterRoomLink? onAfterRoomRecaptchaModeChange? onAfterRoomTokenChange? onBeforeBanClear? onBeforeBansClear? onBeforeRoomLink? onBeforeRoomRecaptchaModeChange? onBeforeRoomTokenChange?

Methods

`Optional`onAfterBanClear

onAfterBanClear?(id: number, customData?: any): void
Called just after the ban of a player has been cleared using room.clearBan(id).
Parameters
- id: number
  Id of the player whose ban has just been cleared.
- OptionalcustomData: any
  the custom data that was returned from the previous callback.
Returns void
void.

`Optional`onAfterBansClear

onAfterBansClear?(customData?: any): void
Called just after all bans have been cleared using room.clearBans().
Parameters
- OptionalcustomData: any
Returns void
void.

`Optional`onAfterRoomLink

onAfterRoomLink?(link: string, customData?: any): void
The room link was received from moo-hoo.com. Called some time after a room is created successfully. Also called when your room stops sending signal to moo-hoo.com, and starts it again after some time. This can happen if your connection gets interrupted or the room somehow becomes unstable due to bugs.
Parameters
- link: string
  The room link that was just received.
- OptionalcustomData: any
  the custom data that was returned from the previous callback.
Returns void
void.

`Optional`onAfterRoomRecaptchaModeChange

onAfterRoomRecaptchaModeChange?(on: boolean, customData?: any): void
Called just after the room's recaptcha mode was changed using room.requireRecaptcha = value.
Parameters
- on: boolean
  The new value; whether to request recaptcha or not while joining the room.
- OptionalcustomData: any
  the custom data that was returned from the previous callback.
Returns void
void.

`Optional`onAfterRoomTokenChange

onAfterRoomTokenChange?(token: string, customData?: any): void
Called just a little after the room's token was changed using room.token = value.
Parameters
- token: string
  The new token of the room.
- OptionalcustomData: any
  the custom data that was returned from the previous callback.
Returns void
void.

`Optional`onBeforeBanClear

onBeforeBanClear?(id: number): any
Called just after the ban of a player has been cleared using room.clearBan(id).
Parameters
- id: number
  Id of the player whose ban has just been cleared.
Returns any
void or a custom data to pass to the next callback.

`Optional`onBeforeBansClear

onBeforeBansClear?(): any
Called just after all bans have been cleared using room.clearBans().

Returns any
void or a custom data to pass to the next callback.

`Optional`onBeforeRoomLink

onBeforeRoomLink?(link: string): any
The room link was received from moo-hoo.com. Called some time after a room is created successfully. Also called when your room stops sending signal to moo-hoo.com, and starts it again after some time. This can happen if your connection gets interrupted or the room somehow becomes unstable due to bugs.
Parameters
- link: string
  The room link that was just received.
Returns any
void or a custom data to pass to the next callback.

`Optional`onBeforeRoomRecaptchaModeChange

onBeforeRoomRecaptchaModeChange?(on: boolean): any
Called just after the room's recaptcha mode was changed using room.requireRecaptcha = value.
Parameters
- on: boolean
  The new value; whether to request recaptcha or not while joining the room.
Returns any
void or a custom data to pass to the next callback.

`Optional`onBeforeRoomTokenChange

onBeforeRoomTokenChange?(token: string): any
Called just a little after the room's token was changed using room.token = value.
Parameters
- token: string
  The new token of the room.
Returns any
void or a custom data to pass to the next callback.