Struct ClippedCamera

A Camera that includes collision.

struct ClippedCamera ;

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

Properties

NameTypeDescription
clipToAreas[get, set] boolIf true, the camera stops on contact with Areas.
clipToBodies[get, set] boolIf true, the camera stops on contact with PhysicsBodys.
collisionMask[get, set] longThe camera's collision mask. Only objects in at least one collision layer matching the mask will be detected.
margin[get, set] doubleThe camera's collision margin. The camera can't get closer than this distance to a colliding object.
processMode[get, set] ClippedCamera.ProcessModeThe camera's process callback. See processmode.

Methods

NameDescription
addException Adds a collision exception so the camera does not collide with the specified node.
addExceptionRid Adds a collision exception so the camera does not collide with the specified RID.
clearExceptions Removes all collision exceptions.
getClipOffset Returns the distance the camera has been offset due to a collision.
getCollisionMask
getCollisionMaskBit Returns true if the specified bit index is on. Note: Bit indices range from 0-19.
getMargin
getProcessMode
isClipToAreasEnabled
isClipToBodiesEnabled
removeException Removes a collision exception with the specified node.
removeExceptionRid Removes a collision exception with the specified RID.
setClipToAreas
setClipToBodies
setCollisionMask
setCollisionMaskBit Sets the specified bit index to the value. Note: Bit indices range from 0-19.
setMargin
setProcessMode

Enums

NameDescription
Constants
ProcessMode