• Studio

  • Studio API

  • Bots

  • Web API

  • Designer Resources

  • Host Resources

  • Globals

    Moderation

    Properties

    OnBan

    ServerOnly
    ReadOnly

    OnKick

    ServerOnly
    ReadOnly

    OnMute

    ServerOnly
    ReadOnly

    OnUnban

    ServerOnly
    ReadOnly

    OnUnmute

    ServerOnly
    ReadOnly

    infiniteDuration

    number
    ServerOnly
    ReadOnly

    Methods

    Ban

    ServerOnly

    Parameters

    userId
    string
    durationSeconds
    number

    Returns

    void

    Ban

    ServerOnly

    Parameters

    userId
    string
    durationSeconds
    number
    message
    string

    Returns

    void

    Ban

    ServerOnly

    Parameters

    userId
    string
    durationSeconds
    number
    message
    string
    callback
    (error: ModerationError) -> ()

    Returns

    void

    BanPlayer

    ServerOnly

    Parameters

    player
    durationSeconds
    number

    Returns

    void

    BanPlayer

    ServerOnly

    Parameters

    player
    durationSeconds
    number
    message
    string

    Returns

    void

    BanPlayer

    ServerOnly

    Parameters

    player
    durationSeconds
    number
    message
    string
    callback
    (error: ModerationError) -> ()

    Returns

    void

    GetBannedUsers

    ServerOnly

    Parameters

    limit
    number
    cursorId
    string
    callback
    (userBans: {UserBan}, cursorId: string, error: ModerationError) -> ()

    Returns

    void

    Kick

    ServerOnly

    Parameters

    userId
    string

    Returns

    void

    Kick

    ServerOnly

    Parameters

    userId
    string
    callback
    (error: ModerationError) -> ()

    Returns

    void

    KickPlayer

    ServerOnly

    Parameters

    player

    Returns

    void

    KickPlayer

    ServerOnly

    Parameters

    player
    callback
    (error: ModerationError) -> ()

    Returns

    void

    Mute

    ServerOnly

    Parameters

    userId
    string
    durationSeconds
    number

    Returns

    void

    Mute

    ServerOnly

    Parameters

    userId
    string
    durationSeconds
    number
    callback
    (error: ModerationError) -> ()

    Returns

    void

    MutePlayer

    ServerOnly

    Parameters

    player
    durationSeconds
    number

    Returns

    void

    MutePlayer

    ServerOnly

    Parameters

    player
    durationSeconds
    number
    callback
    (error: ModerationError) -> ()

    Returns

    void

    Unban

    ServerOnly

    Parameters

    userId
    string

    Returns

    void

    Unban

    ServerOnly

    Parameters

    userId
    string
    callback
    (error: ModerationError) -> ()

    Returns

    void

    Unmute

    ServerOnly

    Parameters

    userId
    string

    Returns

    void

    Unmute

    ServerOnly

    Parameters

    userId
    string
    callback
    (error: ModerationError) -> ()

    Returns

    void

    UnmutePlayer

    ServerOnly

    Parameters

    player

    Returns

    void

    UnmutePlayer

    ServerOnly

    Parameters

    player
    callback
    (error: ModerationError) -> ()

    Returns

    void

    Updated 3 days ago

    PocketWorlds Icon

    © 2025 Pocket Worlds. All rights reserved.