Class overworld

The world border settings for the overworld.

Index

Accessors

buffer damage enabled from knockbackH knockbackV mode preventWorldInteractionOutsideBorder showActionbarWarningWhenOutsideBorder showBorderParticles showRedScreenOutlineWhenOutsideBorder tintIntensity to useShadersCompatibleBorderParticles warnPlayersInChat

Accessors

`Static`buffer

get buffer(): number
The minimum distance outside of the overworld world border that the player has to be before they start taking damage when the mode is set to 2 (Damage Players).

Dynamic Property ID: andexdbWorldBorderSettings:overworld.buffer

Returns number
Default
```
5
```
- Defined in init/classes/config.ts:428
set buffer(buffer: undefined | number): void
Parameters
- buffer: undefined | number
Returns void
- Defined in init/classes/config.ts:431

`Static`damage

get damage(): number
The amount of damage the overworld world border does to players when the mode is set to 2 (Damage Players).

Dynamic Property ID: andexdbWorldBorderSettings:overworld.damageMode.damage

Returns number
Default
```
1
```
- Defined in init/classes/config.ts:284
set damage(damage: undefined | number): void
Parameters
- damage: undefined | number
Returns void
- Defined in init/classes/config.ts:287

`Static`enabled

get enabled(): boolean
Whether or not the world border is enabled for the overworld.

Dynamic Property ID: andexdbWorldBorderSettings:overworld.enabled

Returns boolean
Default
```
false
```
- Defined in init/classes/config.ts:210
set enabled(enabled: undefined | boolean): void
Parameters
- enabled: undefined | boolean
Returns void
- Defined in init/classes/config.ts:213

`Static`from

get from(): { x: number; z: number }
The minimum x and z coordinates of the world border for the overworld.

Dynamic Property ID: andexdbWorldBorderSettings:overworld.from

Returns { x: number; z: number }
Default
```
{ x: -29999984, z: -29999984 }
```
- Defined in init/classes/config.ts:226
set from(
from: undefined | { x: number; z: number } | { x: null; z: null },
): void
Parameters
- from: undefined | { x: number; z: number } | { x: null; z: null }
Returns void
- Defined in init/classes/config.ts:235

`Static`knockbackH

get knockbackH(): number
The amount of horizontal knockback the overworld world border does to players when the mode is set to 1 (Yeet Players).

Dynamic Property ID: andexdbWorldBorderSettings:overworld.knockbackMode.knockbackH

Returns number
Default
```
2.5
```
- Defined in init/classes/config.ts:297
set knockbackH(horizontalKnockback: undefined | number): void
Parameters
- horizontalKnockback: undefined | number
Returns void
- Defined in init/classes/config.ts:300

`Static`knockbackV

get knockbackV(): number
The amount of vertical knockback the overworld world border does to players when the mode is set to 1 (Yeet Players).

Dynamic Property ID: andexdbWorldBorderSettings:overworld.knockbackMode.knockbackV

Returns number
Default
```
1.25
```
- Defined in init/classes/config.ts:310
set knockbackV(verticalKnockback: undefined | number): void
Parameters
- verticalKnockback: undefined | number
Returns void
- Defined in init/classes/config.ts:313

`Static`mode

get mode(): number
The mode of the world border for the overworld.

0 - Teleport Players
1 - Yeet Players
2 - Damage Players

Dynamic Property ID: andexdbWorldBorderSettings:overworld.mode

Returns number
Default
```
1
```
- Defined in init/classes/config.ts:271
set mode(mode: undefined | number): void
Parameters
- mode: undefined | number
Returns void
- Defined in init/classes/config.ts:274

`Static`preventWorldInteractionOutsideBorder

get preventWorldInteractionOutsideBorder(): boolean
Whether or not to prevent players from interacting with the world outside of the world border for the overworld.

Dynamic Property ID: andexdbWorldBorderSettings:overworld.preventWorldInteractionOutsideBorder

Returns boolean
Default
```
false
```
- Defined in init/classes/config.ts:323
set preventWorldInteractionOutsideBorder(
preventWorldInteractionOutsideBorder: undefined | boolean,
): void
Parameters
- preventWorldInteractionOutsideBorder: undefined | boolean
Returns void
- Defined in init/classes/config.ts:326

`Static`showActionbarWarningWhenOutsideBorder

get showActionbarWarningWhenOutsideBorder(): boolean
b

Returns boolean
Todo
- Defined in init/classes/config.ts:367
set showActionbarWarningWhenOutsideBorder(
showActionbarWarningWhenOutsideBorder: undefined | boolean,
): void
a
Parameters
- showActionbarWarningWhenOutsideBorder: undefined | boolean
Returns void
Todo
- Defined in init/classes/config.ts:374

`Static`showBorderParticles

get showBorderParticles(): boolean
Whether or not to show border particles at the edges of the world border for the overworld.

Dynamic Property ID: andexdbWorldBorderSettings:overworld.showBorderParticles

Returns boolean
Default
```
true
```
- Defined in init/classes/config.ts:403
set showBorderParticles(showBorderParticles: undefined | boolean): void
Parameters
- showBorderParticles: undefined | boolean
Returns void
- Defined in init/classes/config.ts:406

`Static`showRedScreenOutlineWhenOutsideBorder

get showRedScreenOutlineWhenOutsideBorder(): boolean
Whether or not to show tint particles when the player is outside of the world border for the overworld.

Dynamic Property ID: andexdbWorldBorderSettings:overworld.showRedScreenOutlineWhenOutsideBorder

Returns boolean
Default
```
true
```
- Defined in init/classes/config.ts:387
set showRedScreenOutlineWhenOutsideBorder(
showRedScreenOutlineWhenOutsideBorder: undefined | boolean,
): void
Parameters
- showRedScreenOutlineWhenOutsideBorder: undefined | boolean
Returns void
- Defined in init/classes/config.ts:390

`Static`tintIntensity

get tintIntensity(): number
The tint intensity of the world border for the overworld.

This is how many tint particles will be spawned in front of the player when they are outside of the world border.

Should be an integer of at least 0.

Dynamic Property ID: andexdbWorldBorderSettings:overworld.tintIntensity

Returns number
Default
```
1
```
- Defined in init/classes/config.ts:343
set tintIntensity(tintIntensity: undefined | number): void
Parameters
- tintIntensity: undefined | number
Returns void
- Defined in init/classes/config.ts:346

`Static`to

get to(): { x: number; z: number }
The maximum x and z coordinates of the world border for the overworld.

Dynamic Property ID: andexdbWorldBorderSettings:overworld.to

Returns { x: number; z: number }
Default
```
{ x: 29999984, z: 29999984 }
```
- Defined in init/classes/config.ts:248
set to(to: undefined | { x: number; z: number } | { x: null; z: null }): void
Parameters
- to: undefined | { x: number; z: number } | { x: null; z: null }
Returns void
- Defined in init/classes/config.ts:257

`Static`useShadersCompatibleBorderParticles

get useShadersCompatibleBorderParticles(): boolean
Returns boolean
Deprecated
- Defined in init/classes/config.ts:412
set useShadersCompatibleBorderParticles(
useShadersCompatibleBorderParticles: undefined | boolean,
): void
Parameters
- useShadersCompatibleBorderParticles: undefined | boolean
Returns void
- Defined in init/classes/config.ts:415

`Static`warnPlayersInChat

get warnPlayersInChat(): boolean
d

Returns boolean
Todo
- Defined in init/classes/config.ts:353
set warnPlayersInChat(warnPlayersInChat: undefined | boolean): void
c
Parameters
- warnPlayersInChat: undefined | boolean
Returns void
Todo
- Defined in init/classes/config.ts:360

Class overworld

Index

Accessors

Accessors

Staticbuffer

Returns number

Default

Parameters

Returns void

Staticdamage

Returns number

Default

Parameters

Returns void

Staticenabled

Returns boolean

Default

Parameters

Returns void

Staticfrom

Returns { x: number; z: number }

Default

Parameters

Returns void

StaticknockbackH

Returns number

Default

Parameters

Returns void

StaticknockbackV

Returns number

Default

Parameters

Returns void

Staticmode

Returns number

Default

Parameters

Returns void

StaticpreventWorldInteractionOutsideBorder

Returns boolean

Default

Parameters

Returns void

StaticshowActionbarWarningWhenOutsideBorder

Returns boolean

Todo

Parameters

Returns void

Todo

StaticshowBorderParticles

Returns boolean

Default

Parameters

Returns void

StaticshowRedScreenOutlineWhenOutsideBorder

Returns boolean

Default

Parameters

Returns void

StatictintIntensity

Returns number

Default

Parameters

Returns void

Staticto

Returns { x: number; z: number }

Default

Parameters

Returns void

StaticuseShadersCompatibleBorderParticles

Returns boolean

Deprecated

Parameters

Returns void

StaticwarnPlayersInChat

Returns boolean

Todo

Parameters

Returns void

`Static`buffer

`Static`damage

`Static`enabled

`Static`from

`Static`knockbackH

`Static`knockbackV

`Static`mode

`Static`preventWorldInteractionOutsideBorder

`Static`showActionbarWarningWhenOutsideBorder

`Static`showBorderParticles

`Static`showRedScreenOutlineWhenOutsideBorder

`Static`tintIntensity

`Static`to

`Static`useShadersCompatibleBorderParticles

`Static`warnPlayersInChat