Class homeSystem

The home system settings.

Index

Accessors

allowCrossDimensionalTeleport allowHomesInOtherDimensions homeSystemEnabled maxHomesPerPlayer

Accessors

`Static`allowCrossDimensionalTeleport

get allowCrossDimensionalTeleport(): boolean
Whether or not you can teleport to a home that is in a different dimension than you.

Dynamic Property ID: homeSystemSettings:allowCrossDimensionalTeleport

Returns boolean
Default
```
true
```
- Defined in init/classes/config.ts:916
set allowCrossDimensionalTeleport(enabled: boolean): void
Parameters
- enabled: boolean
Returns void
- Defined in init/classes/config.ts:919

`Static`allowHomesInOtherDimensions

get allowHomesInOtherDimensions(): boolean
Whether or not homes are allowed in dimensions other than the overworld.

Dynamic Property ID: homeSystemSettings:allowHomesInOtherDimensions

Returns boolean
Default
```
true
```
- Defined in init/classes/config.ts:929
set allowHomesInOtherDimensions(enabled: boolean): void
Parameters
- enabled: boolean
Returns void
- Defined in init/classes/config.ts:932

`Static`homeSystemEnabled

get homeSystemEnabled(): boolean
Whether or not the home system is enabled.

Dynamic Property ID: homeSystemSettings:homeSystemEnabled

Returns boolean
Default
```
true
```
- Defined in init/classes/config.ts:888
set homeSystemEnabled(enabled: boolean): void
Parameters
- enabled: boolean
Returns void
- Defined in init/classes/config.ts:891

`Static`maxHomesPerPlayer

get maxHomesPerPlayer(): number
The maximum number of homes a player can have.

Dynamic Property ID: homeSystemSettings:maxHomesPerPlayer

Returns number
Default
```
Infinity
```
- Defined in init/classes/config.ts:901
set maxHomesPerPlayer(maxHomes: number): void
Parameters
- maxHomes: number
Returns void
- Defined in init/classes/config.ts:906