Class teleportSystems

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
Default
```
true
```
- Defined in init/classes/config.ts:1123
set allowCrossDimensionalTeleport(enabled: undefined | boolean): void
Parameters
- enabled: undefined | boolean
Returns void
- Defined in init/classes/config.ts:1126

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
Default
```
15
```
- Defined in init/classes/config.ts:1168
set pvpCooldownToTeleport(invalidChatCommandAction: undefined | number): void
Parameters
- invalidChatCommandAction: undefined | number
Returns void
- Defined in init/classes/config.ts:1173

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
Default
```
5
```
- Defined in init/classes/config.ts:1153
set standStillTimeToTeleport(maxHomes: undefined | number): void
Parameters
- maxHomes: undefined | number
Returns void
- Defined in init/classes/config.ts:1156

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
Default
```
30
```
- Defined in init/classes/config.ts:1138
set teleportCooldown(maxHomes: undefined | number): void
Parameters
- maxHomes: undefined | number
Returns void
- Defined in init/classes/config.ts:1141