Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Checking the stable version of the documentation...

ClippedCamera

Inherits: Camera < Spatial < Node < Object

A Camera that includes collision.

Descripción

This node extends Camera to add collisions with Area and/or PhysicsBody nodes. The camera cannot move through colliding objects.

Propiedades

bool

clip_to_areas

false

bool

clip_to_bodies

true

int

collision_mask

1

float

margin

0.0

ProcessMode

process_mode

0

Métodos

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 )

Enumeraciones

enum ProcessMode:

  • CLIP_PROCESS_PHYSICS = 0 --- La cámara se actualiza con la llamada _physics_process.

  • CLIP_PROCESS_IDLE = 1 --- La cámara se actualiza con la llamada de _process.

Descripciones de Propiedades

  • bool clip_to_areas

Default

false

Setter

set_clip_to_areas(value)

Getter

is_clip_to_areas_enabled()

If true, the camera stops on contact with Areas.

  • bool clip_to_bodies

Default

true

Setter

set_clip_to_bodies(value)

Getter

is_clip_to_bodies_enabled()

If true, the camera stops on contact with PhysicsBodys.

  • int collision_mask

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()

El margen de colisión de la cámara. La cámara no puede acercarse más que esta distancia a un objeto en colisión.

Default

0

Setter

set_process_mode(value)

Getter

get_process_mode()

El proceso de llamada de la cámara. Ver ProcessMode.

Descripciones de Métodos

  • void add_exception ( Object node )

Añade una excepción de colisión para que la cámara no colisione con el nodo especificado.

  • void add_exception_rid ( RID rid )

Añade una excepción de colisión para que la cámara no colisione con el RID especificado.

  • void clear_exceptions ( )

Elimina todas las excepciones de colisión.

  • float get_clip_offset ( ) const

Devuelve la distancia a la que la cámara ha sido desplazada debido a una colisión.

  • bool get_collision_mask_bit ( int bit ) const

Devuelve true si el índice de bits especificado está activado.

Nota: Los índices de bits van de 0 a 19.

  • void remove_exception ( Object node )

Elimina una excepción de colisión con el nodo especificado.

  • void remove_exception_rid ( RID rid )

Elimina una excepción de colisión con el RID especificado.

  • void set_collision_mask_bit ( int bit, bool value )

Establece el índice de bits especificado en el value.

Nota: Los índices de bits van de 0 a 19.