GeneratorCircleShape3D

Inherits: QueryGenerator3D < Node3D

A query generator that generates a horizontal circle around each QueryContext3D.

Description

A query generator that generates a horizontal circle around each QueryContext3D.

Properties

float

arc_angle

360.0

int

cast_collision_mask

1

Shape3D

cast_shape

QueryContext3D

circle_center

float

circle_radius

10.0

float

post_projection_vertical_offset

0.5

float

project_down

100.0

float

project_up

100.0

int

projection_collision_mask

1

Shape3D

shape

float

space_between

1.0

bool

use_arc_direction

false

bool

use_cast_shape

false

bool

use_casting

true

bool

use_shape

false

bool

use_vertical_projection

false


Property Descriptions

float arc_angle = 360.0 🔗

  • void set_arc_angle(value: float)

  • float get_arc_angle()

Sets the angle of the arc in degrees.


int cast_collision_mask = 1 🔗

  • void set_cast_collision_mask(value: int)

  • int get_cast_collision_mask()

The physics layers the hotizontal casting scans


Shape3D cast_shape 🔗

  • void set_cast_shape(value: Shape3D)

  • Shape3D get_cast_shape()

Shape of the casting.


QueryContext3D circle_center 🔗

Reference QueryContext3D, where a circle will generate on each of these positions.


float circle_radius = 10.0 🔗

  • void set_circle_radius(value: float)

  • float get_circle_radius()

Radius of the circle that expands from circle_center.


float post_projection_vertical_offset = 0.5 🔗

  • void set_post_projection_vertical_offset(value: float)

  • float get_post_projection_vertical_offset()

Offset the position of the QueryItem3D vertically by this amount after projecting it. Useful to avoid accidental collisions when doing visibility tests.


float project_down = 100.0 🔗

  • void set_project_down(value: float)

  • float get_project_down()

Height where the raycast search will end.


float project_up = 100.0 🔗

  • void set_project_up(value: float)

  • float get_project_up()

Height where the raycast search will start.


int projection_collision_mask = 1 🔗

  • void set_projection_collision_mask(value: int)

  • int get_projection_collision_mask()

The physics layers this projection scans.


Shape3D shape 🔗

  • void set_shape(value: Shape3D)

  • Shape3D get_shape()

Shape of the projection.


float space_between = 1.0 🔗

  • void set_space_between(value: float)

  • float get_space_between()

The space between each point around the circle.


bool use_arc_direction = false 🔗

  • void set_use_arc_direction(value: bool)

  • bool get_use_arc_direction()

There is currently no description for this property. Please help us by contributing one!


bool use_cast_shape = false 🔗

  • void set_use_cast_shape(value: bool)

  • bool get_use_cast_shape()

Use a Shape3D instead of a raycast.


bool use_casting = true 🔗

  • void set_use_casting(value: bool)

  • bool get_use_casting()

Cast rays or shapes outwards from each context and align the QueryItem3D on it. Useful for detecting walls.


bool use_shape = false 🔗

  • void set_use_shape(value: bool)

  • bool get_use_shape()

Use a Shape3D instead of a raycast.


bool use_vertical_projection = false 🔗

  • void set_use_vertical_projection(value: bool)

  • bool get_use_vertical_projection()

If true, casts ray onto the ground to position the QueryItem3Ds.