mooball
    Preparing search index...

    Class SendAnnouncementEvent

    The event message structure that is created when an announcement is sent/received.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    byId color eventType msg sound style targetId

    Methods

    copy

    Constructors

    Properties

    byId: number

    Id of the player who triggered this event.

    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.
    eventType: OperationType

    Type of the event. Should not be modified.

    msg: string

    The announcement message. ( max length = 1000 )

    sound: number

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

    • 0: no sound.
    • 1: chat sound.
    • 2: highlight sound.
    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".
    targetId: number | null

    Id of the player who will receive the announcement. If null, everyone receives it. Can not be modified.

    Methods

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods