Interface EntityRaycastOptions

Contains additional options for an entity raycast operation.

interface EntityRaycastOptions {
    excludeFamilies?: string[];
    excludeGameModes?: GameMode[];
    excludeNames?: string[];
    excludeTags?: string[];
    excludeTypes?: string[];
    families?: string[];
    gameMode?: GameMode;
    ignoreBlockCollision?: boolean;
    includeLiquidBlocks?: boolean;
    includePassableBlocks?: boolean;
    maxDistance?: number;
    maxHorizontalRotation?: number;
    maxLevel?: number;
    maxVerticalRotation?: number;
    minHorizontalRotation?: number;
    minLevel?: number;
    minVerticalRotation?: number;
    name?: string;
    propertyOptions?: EntityQueryPropertyOptions[];
    scoreOptions?: EntityQueryScoreOptions[];
    tags?: string[];
    type?: string;
}

Hierarchy (View Summary)

Properties

excludeFamilies? excludeGameModes? excludeNames? excludeTags? excludeTypes? families? gameMode? ignoreBlockCollision? includeLiquidBlocks? includePassableBlocks? maxDistance? maxHorizontalRotation? maxLevel? maxVerticalRotation? minHorizontalRotation? minLevel? minVerticalRotation? name? propertyOptions? scoreOptions? tags? type?

Properties

OptionalexcludeFamilies

excludeFamilies?: string[]

Remarks

Excludes entities that match one or more of the specified families.

OptionalexcludeGameModes

excludeGameModes?: GameMode[]

Remarks

Excludes entities if have a specific gamemode that matches the specified gamemode.

OptionalexcludeNames

excludeNames?: string[]

Remarks

Excludes entities that have a name that match one of the specified values.

OptionalexcludeTags

excludeTags?: string[]

Remarks

Excludes entities with a tag that matches one of the specified values.

OptionalexcludeTypes

excludeTypes?: string[]

Remarks

Excludes entities if they are one of the specified types.

Optionalfamilies

families?: string[]

Remarks

If specified, includes entities that match all of the specified families.

OptionalgameMode

gameMode?: GameMode

Remarks

If specified, includes entities with a gamemode that matches the specified gamemode.

OptionalignoreBlockCollision

ignoreBlockCollision?: boolean

Remarks

If true, blocks will not be considered as blocks that 'stop' the raycast.

OptionalincludeLiquidBlocks

includeLiquidBlocks?: boolean

Remarks

If true, liquid blocks will be considered as blocks that 'stop' the raycast.

OptionalincludePassableBlocks

includePassableBlocks?: boolean

Remarks

If true, passable blocks like vines and flowers will be considered as blocks that 'stop' the raycast.

OptionalmaxDistance

maxDistance?: number

Remarks

Maximum distance, in blocks, to process the raycast.

OptionalmaxHorizontalRotation

maxHorizontalRotation?: number

Remarks

If specified, will only include entities that have at most this horizontal rotation.

OptionalmaxLevel

maxLevel?: number

Remarks

If defined, only players that have at most this level are returned.

OptionalmaxVerticalRotation

maxVerticalRotation?: number

Remarks

If specified, only entities that have at most this vertical rotation are returned.

OptionalminHorizontalRotation

minHorizontalRotation?: number

Remarks

If specified, will only include entities that have at a minimum this horizontal rotation.

OptionalminLevel

minLevel?: number

Remarks

If defined, only players that have at least this level are returned.

OptionalminVerticalRotation

minVerticalRotation?: number

Remarks

If specified, will only include entities that have at least this vertical rotation.

Optionalname

name?: string

Remarks

Includes entities with the specified name.

OptionalpropertyOptions

propertyOptions?: EntityQueryPropertyOptions[]

OptionalscoreOptions

scoreOptions?: EntityQueryScoreOptions[]

Remarks

Gets/sets a collection of EntityQueryScoreOptions objects with filters for specific scoreboard objectives.

Optionaltags

tags?: string[]

Remarks

Includes entities that match all of the specified tags.

Optionaltype

type?: string

Remarks

If defined, entities that match this type are included.

Settings

Member Visibility

On This Page

Properties