@minecraft
    正在准备搜索索引...

    类 EntityFogComponent实验性

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

    层级 (查看层级一览)

    索引

    属性

    entity isValid typeId componentId

    方法

    applyStack getStack getTags pop push remove

    属性

    entity: Entity

    The entity that owns this component. The entity will be undefined if it has been removed.

    This property can throw when used.

    InvalidEntityError

    isValid: boolean

    Returns whether the component is valid. A component is considered valid if its owner is valid, in addition to any addition to any additional validation required by the component.

    typeId: string

    Identifier of the component.

    componentId: "minecraft:player.fog" = 'minecraft:player.fog'

    方法

    • 世界修改

      参数

      • 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.

      EntityFogComponentError

      InvalidEntityError

    • 世界修改

      返回 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

    • 世界修改

      返回 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

    • 世界修改

      参数

      • 可选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

    • 世界修改

      参数

      • 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.

      EntityFogComponentError

      InvalidEntityError

    • 世界修改

      参数

      • 可选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

    显示设置

    成员可见性

    目录

    属性
    方法