Class antiSpamSystem

The anti-spam system settings.

Accessors

antispamEnabled antispamTriggerMessageCount maxTimeBewteenMessagesToTriggerAntiSpam restartAntiSpamMuteTimerUponAttemptedMessageSendDuringMute waitTimeAfterAntispamActivation

Accessors

StaticantispamEnabled

  • get antispamEnabled(): boolean

    Whether or not the anti-spam system is enabled.

    Dynamic Property ID: antispamSettings:antispamEnabled

    Returns boolean

    Default

    false
  • set antispamEnabled(enabled: undefined | boolean): void

    Parameters

    • enabled: undefined | boolean

    Returns void

StaticantispamTriggerMessageCount

  • get antispamTriggerMessageCount(): number

    The message count to trigger anti-spam.

    Dynamic Property ID: antispamSettings:antispamTriggerMessageCount

    Returns number

    Default

    4
  • set antispamTriggerMessageCount(messageCount: undefined | number): void

    Parameters

    • messageCount: undefined | number

    Returns void

StaticmaxTimeBewteenMessagesToTriggerAntiSpam

  • get maxTimeBewteenMessagesToTriggerAntiSpam(): number

    The maximum time in seconds between individual messages to trigger anti-spam.

    Dynamic Property ID: antispamSettings:maxTimeBewteenMessagesToTriggerAntiSpam

    Returns number

    Default

    5
  • set maxTimeBewteenMessagesToTriggerAntiSpam(
        maxTimeInSeconds: undefined | number,
    ): void

    Parameters

    • maxTimeInSeconds: undefined | number

    Returns void

StaticrestartAntiSpamMuteTimerUponAttemptedMessageSendDuringMute

  • get restartAntiSpamMuteTimerUponAttemptedMessageSendDuringMute(): boolean

    Whether or not to restart the anti-spam mute timer when a message is sent during a mute.

    Dynamic Property ID: antispamSettings:restartAntiSpamMuteTimerUponAttemptedMessageSendDuringMute

    Returns boolean

    Default

    false
  • set restartAntiSpamMuteTimerUponAttemptedMessageSendDuringMute(
        restartAntiSpamMuteTimerUponAttemptedMessageSendDuringMute:
            | undefined
            | boolean,
    ): void

    Parameters

    • restartAntiSpamMuteTimerUponAttemptedMessageSendDuringMute: undefined | boolean

    Returns void

StaticwaitTimeAfterAntispamActivation

  • get waitTimeAfterAntispamActivation(): number

    The wait time in seconds before a player can send another chat message.

    Dynamic Property ID: antispamSettings:waitTimeAfterAntispamActivation

    Returns number

    Default

    60
  • set waitTimeAfterAntispamActivation(waitTimeInSeconds: undefined | number): void

    Parameters

    • waitTimeInSeconds: undefined | number

    Returns void

Settings

Member Visibility

On This Page

Accessors