Inherits: Camera < Spatial < Node < Object
A Camera that includes collision.
This node extends Camera to add collisions with Area and/or PhysicsBody nodes. The camera cannot move through colliding objects.
bool | clip_to_areas | false |
bool | clip_to_bodies | true |
int | collision_mask | 1 |
float | margin | 0.0 |
ProcessMode | process_mode | 0 |
void | add_exception ( Object node ) |
void | add_exception_rid ( RID rid ) |
void | clear_exceptions ( ) |
float | get_clip_offset ( ) const |
bool | get_collision_mask_bit ( int bit ) const |
void | remove_exception ( Object node ) |
void | remove_exception_rid ( RID rid ) |
void | set_collision_mask_bit ( int bit, bool value ) |
enum ProcessMode:
_physics_process
callback._process
callback.Default | false |
Setter | set_clip_to_areas(value) |
Getter | is_clip_to_areas_enabled() |
If true
, the camera stops on contact with Areas.
Default | true |
Setter | set_clip_to_bodies(value) |
Getter | is_clip_to_bodies_enabled() |
If true
, the camera stops on contact with PhysicsBodys.
Default | 1 |
Setter | set_collision_mask(value) |
Getter | get_collision_mask() |
The camera's collision mask. Only objects in at least one collision layer matching the mask will be detected. See Collision layers and masks in the documentation for more information.
Default | 0.0 |
Setter | set_margin(value) |
Getter | get_margin() |
The camera's collision margin. The camera can't get closer than this distance to a colliding object.
Default | 0 |
Setter | set_process_mode(value) |
Getter | get_process_mode() |
The camera's process callback. See ProcessMode.
Adds a collision exception so the camera does not collide with the specified node.
Adds a collision exception so the camera does not collide with the specified RID.
Removes all collision exceptions.
Returns the distance the camera has been offset due to a collision.
Returns true
if the specified bit index is on.
Note: Bit indices range from 0-19.
Removes a collision exception with the specified node.
Removes a collision exception with the specified RID.
Sets the specified bit index to the value
.
Note: Bit indices range from 0-19.
© 2014–2020 Juan Linietsky, Ariel Manzur, Godot Engine contributors
Licensed under the MIT License.
https://docs.godotengine.org/en/3.2/classes/class_clippedcamera.html