The settings for all teleportation related systems, features, and commands of that add-on that are available to regular players.

Accessors

  • get allowCrossDimensionalTeleport(): boolean

    Whether or not cross-dimensional teleports are allowed.

    Affects all types of teleports that regular players can use, including but not limited to the home system, TPA system, and the \spawn command.

    Overrides the allowCrossDimensionalTeleport options for the home system, TPA system, and \spawn command.

    Dynamic Property ID: teleportSystemsSettings:allowCrossDimensionalTeleport

    Returns boolean

    true
    
  • set allowCrossDimensionalTeleport(enabled: boolean): void

    Parameters

    • enabled: boolean

    Returns void

  • get pvpCooldownToTeleport(): number

    How long in seconds after getting damaged by another player that the player has to wait before they can teleport with the player menu or commands such as \spawn, \home, \gohome, \tpa, and \rtp.

    Set it to 0 to have no PVP cooldown.

    Dynamic Property ID: andexdbSettings:pvpCooldownToTeleport

    Returns number

    15
    
  • set pvpCooldownToTeleport(invalidChatCommandAction: number): void

    Parameters

    • invalidChatCommandAction: number

    Returns void

  • get standStillTimeToTeleport(): number

    How long in seconds that the player has to stand still before they can teleport, if they move during this time period, the teleportation is canceled.

    Set it to 0 to have players teleport instantly.

    Dynamic Property ID: homeSystemSettings:standStillTimeToTeleport

    Returns number

    5
    
  • set standStillTimeToTeleport(maxHomes: number): void

    Parameters

    • maxHomes: number

    Returns void

  • get teleportCooldown(): number

    How long in seconds after teleporting that the player has to wait before they can teleport again.

    Set it to 0 to have no teleport cooldown.

    Dynamic Property ID: homeSystemSettings:teleportCooldown

    Returns number

    30
    
  • set teleportCooldown(maxHomes: number): void

    Parameters

    • maxHomes: number

    Returns void