mooball
    Preparing search index...

    Interface HostTriggeredCallbacks

    These events can only be triggered by the room's host.

    interface HostTriggeredCallbacks {
        onAnnouncement?(
            msg: string,
            color: number,
            style: number,
            sound: number,
            customData?: any,
        ): any;
        onAnnouncement2?(
            msg: string,
            cssVar?: string,
            sound?: string,
            targetId?: number,
            customData?: any,
        ): any;
        onClockPausedChange?(value: number, customData?: any): any;
        onControls?(type: number, params: any[], customData?: any): any;
        onDirectionActiveChange?(value: number, customData?: any): any;
        onElapsedTimeChange?(value: number, customData?: any): any;
        onMaxEndTicksChange?(value: number, customData?: any): any;
        onMaxGoalTicksChange?(value: number, customData?: any): any;
        onMaxPauseTicksChange?(value: number, customData?: any): any;
        onPingData?(array: number[], customData?: any): any;
        onPlayCustomSound?(soundName: string, customData?: any): any;
        onPlayerCssVarChange?(
            id: number,
            cssVar: string | null,
            customData?: any,
        ): any;
        onPlayerEnergyChange?(id: number, data: number[], customData?: any): any;
        onPlayerHeadlessAvatarChange?(
            id: number,
            value: string,
            customData?: any,
        ): any;
        onPlayerSkinChange?(
            id: number,
            skin: Texture | null,
            customData?: any,
        ): any;
        onPlayersOrderChange?(
            idList: number[],
            moveToTop: boolean,
            customData?: any,
        ): any;
        onRoomNameChange?(name: string, customData?: any): any;
        onRoomPropertiesChange?(props: UpdatedRoomProps, customData?: any): any;
        onRunDefaultGameLogicChange?(value: boolean, customData?: any): any;
        onSetDiscProperties?(
            id: number,
            type: number,
            data1: number[],
            data2: number[],
            customData?: any,
        ): any;
        onStadiumAddObject?(type: number, value: object, customData?: any): any;
        onStadiumRemoveObject?(type: number, id: number, customData?: any): any;
        onStadiumUpdateObject?(
            type: number,
            id: number,
            value: object,
            customData?: any,
        ): any;
        onTeamScoreChange?(teamId: number, value: number, customData?: any): any;
        onUpdateCssVar?(name: string, value: string, customData?: any): any;
    }

    Hierarchy (View Summary)

    Index

    Methods

    onAnnouncement? onAnnouncement2? onClockPausedChange? onControls? onDirectionActiveChange? onElapsedTimeChange? onMaxEndTicksChange? onMaxGoalTicksChange? onMaxPauseTicksChange? onPingData? onPlayCustomSound? onPlayerCssVarChange? onPlayerEnergyChange? onPlayerHeadlessAvatarChange? onPlayerSkinChange? onPlayersOrderChange? onRoomNameChange? onRoomPropertiesChange? onRunDefaultGameLogicChange? onSetDiscProperties? onStadiumAddObject? onStadiumRemoveObject? onStadiumUpdateObject? onTeamScoreChange? onUpdateCssVar?

    Methods

    • Called just after an announcement was made by the room host.

      Parameters

      • msg: string

        The announcement message.

      • color: number

        The color of the announcement message. Range: -1 <= color < 16777216.

        • The color value can be converted into a rgba string via API's Utils.numberToColor function.
        • The special value -1 means transparent color.
      • style: number

        The style of the announcement message. Must be one of the following:

        • 0: use document's default font style.
        • 1: fontWeight = "bold".
        • 2: fontStyle = "italic".
        • 3: fontSize = "12px".
        • 4: fontWeight = "bold", fontSize = "12px".
        • 5: fontWeight = "italic", fontSize = "12px".
      • sound: number

        The sound of the announcement message. Must be one of the following:

        • 0: no sound.
        • 1: chat sound.
        • 2: highlight sound.
      • OptionalcustomData: any

        the custom data that was returned from the previous callback.

      Returns any

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

    • Called just after an announcement has been sent using the improved announcement api.

      Parameters

      • msg: string

        The announcement message. ( max length = 1000 )

      • OptionalcssVar: string

        The cssVar of the announcement message.

      • Optionalsound: string

        The sound of the announcement message.

      • OptionaltargetId: number

        Id of the player who will receive this announcement. If this value is null, the announcement is sent to everyone.

      • OptionalcustomData: any

        the custom data that was returned from the previous callback.

      Returns any

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

    • Called just after the game clock has been paused/resumed.

      Parameters

      • value: number

        Whether the game will be paused(1) or resumed(0).

      • OptionalcustomData: any

        the custom data that was returned from the previous callback.

      Returns any

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

    • Called just after game input controls have been modified.

      Parameters

      • type: number

        Type of the operation. (0: add, 1: remove)

      • params: any[]

        Parameters for the specific operation.

      • OptionalcustomData: any

        the custom data that was returned from the previous callback.

      Returns any

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

    • Called just after room.directionActive has been changed.

      Parameters

      • value: number

        New directionActive value.

      • OptionalcustomData: any

        the custom data that was returned from the previous callback.

      Returns any

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

    • Called just after the current elapsed time has been changed.

      Parameters

      • value: number

        New elapsed time value.

      • OptionalcustomData: any

        the custom data that was returned from the previous callback.

      Returns any

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

    • Called just after the current max end ticks has been changed.

      Parameters

      • value: number

        New max end ticks value.

      • OptionalcustomData: any

        the custom data that was returned from the previous callback.

      Returns any

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

    • Called just after the current max goal ticks has been changed.

      Parameters

      • value: number

        New max goal ticks value.

      • OptionalcustomData: any

        the custom data that was returned from the previous callback.

      Returns any

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

    • Called just after the current max pause ticks has been changed.

      Parameters

      • value: number

        New max pause ticks value.

      • OptionalcustomData: any

        the custom data that was returned from the previous callback.

      Returns any

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

    • Called just after the ping values for all players have been updated.

      Parameters

      • array: number[]

        The updated list of ping values for each player in the same order as the player list in the current room's RoomState object.

      • OptionalcustomData: any

        the custom data that was returned from the previous callback.

      Returns any

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

    • Called just after a custom sound has been played.

      Parameters

      • soundName: string

        Name of the sound to be played.

      • OptionalcustomData: any

        the custom data that was returned from the previous callback.

      Returns any

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

    • Called just after the cssVar attribute of a player has been changed.

      Parameters

      • id: number

        Id of the player whose cssVar will be modified.

      • cssVar: string | null

        New cssVar value of the player.

      • OptionalcustomData: any

        the custom data that was returned from the previous callback.

      Returns any

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

    • Called just after the energy of an individual player has been altered manually.

      Parameters

      • id: number

        Id of the player whose energy values will be modified.

      • data: number[]

        New values. Order of values is supposed to be: [energy, kEnergyGain, kEnergyDrain]. null means no change for each value.

      • OptionalcustomData: any

        the custom data that was returned from the previous callback.

      Returns any

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

    • Called just after a player has changed his/her headless avatar.

      Parameters

      • id: number

        Id of the player who triggered this event.

      • value: string

        The new headless avatar value.

      • OptionalcustomData: any

        the custom data that was returned from the previous callback.

      Returns any

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

    • Called just after the current skin(textureId) of a player has been updated.

      Parameters

      • id: number

        Id of the player whose skin will be modified.

      • skin: Texture | null

        New skin value of the player.

      • OptionalcustomData: any

        the custom data that was returned from the previous callback.

      Returns any

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

    • Called just after the order of players have been changed.

      The ids of players that were removed from the room's players list, reordered to match the order in idList and added back to the room's players list.

      Parameters

      • idList: number[]

        The ids of players that were removed from the room's players list, reordered to match the order in idList and added back to the room's players list.

      • moveToTop: boolean

        Whether to add the players to the top or bottom of the room's players list.

      • OptionalcustomData: any

        the custom data that was returned from the previous callback.

      Returns any

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

    • Called just after the name of the room has been changed.

      Parameters

      • name: string

        The new room name.

      • OptionalcustomData: any

        the custom data that was returned from the previous callback.

      Returns any

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

    • Called just after the room's properties have been changed.

      Parameters

      • props: UpdatedRoomProps

        The properties that were changed. The current structure of this object is as follows:

        props = {
          name: string | null,
          password: string | null,
          fakePassword: boolean | null,
          geo: GeoLocation | null,
          playerCount: int | null,
          maxPlayerCount: int | null
        }

        Note that only the changed keys will show up in props.

      • OptionalcustomData: any

        the custom data that was returned from the previous callback.

      Returns any

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

    • Called just after room.runDefaultGameLogic has changed.

      Parameters

      • value: boolean

        Whether the default game logic is active(1) or passive(0).

      • OptionalcustomData: any

        the custom data that was returned from the previous callback.

      Returns any

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

    • Called just after a disc's properties have been modified.

      Parameters

      • id: number

        The id of player or disc whose disc properties have changed.

      • type: number

        The type of object. Must be one of the following:

        • 0: disc.
        • 1: player.
      • data1: number[]

        Must consist of the following properties of the disc in the same order: [x, y, xspeed, yspeed, xgravity, ygravity, radius, bCoeff, invMass, damping].

      • data2: number[]

        Must consist of the following properties of the disc in the same order: [color, cMask, cGroup].

      • OptionalcustomData: any

        the custom data that was returned from the previous callback.

      Returns any

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

    • Called just after a new stadium object has been added.

      Parameters

      • type: number

        Type of the object to be added.

      • value: object

        An object that is supposed to contain all parameters required to add that type of object.

      • OptionalcustomData: any

        the custom data that was returned from the previous callback.

      Returns any

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

    • Called just after an existing stadium object has been removed.

      Parameters

      • type: number

        Type of the object to be removed.

      • id: number

        Id of the object to be removed.

      • OptionalcustomData: any

        the custom data that was returned from the previous callback.

      Returns any

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

    • Called just after an existing stadium object has been updated.

      Parameters

      • type: number

        Type of the object to be updated.

      • id: number

        Id of the object to be updated.

      • value: object

        An object that is supposed to contain all parameters required to update that type of object.

      • OptionalcustomData: any

        the custom data that was returned from the previous callback.

      Returns any

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

    • Called just after the current team scores has been changed.

      Parameters

      • teamId: number

        Id of the team whose score is desired to be changed.

      • value: number

        New score for the team.

      • OptionalcustomData: any

        the custom data that was returned from the previous callback.

      Returns any

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

    • Called just after the current contents of a css variable has been altered.

      Parameters

      • name: string

        Name of the css variable..

      • value: string

        New value of the css variable.

      • OptionalcustomData: any

        the custom data that was returned from the previous callback.

      Returns any

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

    Settings

    Member Visibility

    On This Page

    Methods