类 FogSettings

Provides access to the fog definitions stack of a player entity, allowing scripts to push, pop, remove, and query active fog definitions.

索引

方法

getStack getTags pop push remove setStack

方法

getStack

getStack(): string[]
世界修改
返回 string[]
An array of fog definition identifiers currently on the stack.

备注
Returns the list of fog identifiers currently on the player's fog stack, ordered from bottom to top.

抛出
Throws if the entity is invalid.

InvalidEntityError
- 定义于 @minecraft/server.d.ts:13615

getTags

getTags(): string[]
世界修改
返回 string[]
An array of tag strings associated with fog settings on the stack.

备注
Returns the list of tags currently present on the player's fog stack.

抛出
Throws if the entity is invalid.

InvalidEntityError
- 定义于 @minecraft/server.d.ts:13631

pop

pop(tag?: string): string
世界修改
参数
- 可选tag: string
  An optional tag identifying which entry to pop. If provided, searches the stack from top to bottom and removes the most recently pushed entry with this tag. If omitted, removes the most recently pushed entry regardless of tag.
返回 string
Returns the identifier of the popped fog definition, or undefined if the stack was unchanged.

备注
Removes the most recently pushed fog definition from the player's fog stack.

抛出
Throws if the entity is invalid.

InvalidEntityError
- 定义于 @minecraft/server.d.ts:13652

push

push(fogId: string, tag?: string): number
世界修改
参数
- fogId: string
  The identifier of the fog definition to push onto the stack (e.g. 'minecraft:fog_bamboo_jungle').
- 可选tag: string
  An optional tag used to label this fog definition on the stack, allowing it to be targeted by pop or remove. If omitted, the entry is stored with the tag 'untagged'.
返回 number
Returns the zero-based index at which the fog definition was inserted into the stack.

备注
Pushes a new fog definition onto the player's fog stack.

抛出
Throws if the entity is invalid, the fog identifier is invalid, or if the stack limit of 16 has been exceeded.

FogSettingsError

InvalidEntityError
- 定义于 @minecraft/server.d.ts:13677

remove

remove(tag?: string): boolean
世界修改
参数
- 可选tag: string
  An optional tag identifying which the entries to remove. If omitted, clears all fog definitions regardless of tag.
返回 boolean
Returns true if at least one entry was removed, or false if the stack was unchanged.

备注
Removes all fog definitions with the given tag from the player's fog stack. If no tag is provided, clears all fog definitions.

抛出
Throws if the entity is invalid.

InvalidEntityError
- 定义于 @minecraft/server.d.ts:13697

setStack

setStack(fogIds: string[], tag?: string): void
世界修改
参数
- fogIds: string[]
  A stack of fog definition identifiers to set on the player's fog stack (e.g. ['minecraft:fog_bamboo_jungle']). Maximum of 16 entries.
- 可选tag: string
  An optional tag to associate with the new entries, used to target them with pop or remove.
返回 void

备注
Sets the player's fog stack to the given list of fog identifiers, replacing any existing entries.

抛出
Throws if the entity is invalid, if more than 16 fog identifiers are provided, or if any fog identifier is invalid.

FogSettingsError

InvalidEntityError
- 定义于 @minecraft/server.d.ts:13721