我的书签
添加书签
移除书签Camera2D
Camera node for 2D scenes.
Camera node for 2D scenes. It forces the screen (current layer) to scroll following this node. This makes it easier (and faster) to program scrollable scenes than manually changing the position of -based nodes.
This node is intended to be a simple helper to get things going quickly, but more functionality may be desired to change how the camera works. To make your own custom camera node, inherit it from Node2D and change the transform of the canvas by setting in Viewport (you can obtain the current by using Node.get_viewport).
Note that the node’s position doesn’t represent the actual position of the screen, which may differ due to applied smoothing or limits. You can use to get the real position.
Tutorials
Methods
void | align ( ) |
void | ( ) |
void | |
get_camera_position ( ) const | |
get_camera_screen_center ( ) const | |
get_drag_margin ( margin ) const | |
( Margin margin ) const | |
void | ( ) |
void | |
void | set_drag_margin ( margin, float drag_margin ) |
void | ( Margin margin, limit ) |
enum AnchorMode:
ANCHOR_MODE_FIXED_TOP_LEFT = 0 —- The camera’s position is fixed so that the top-left corner is always at the origin.
ANCHOR_MODE_DRAG_CENTER = 1 —- The camera’s position takes into account vertical/horizontal offsets and the screen size.
enum Camera2DProcessMode:
CAMERA2D_PROCESS_PHYSICS = 0 —- The camera updates with the
_physics_processcallback.CAMERA2D_PROCESS_IDLE = 1 —- The camera updates with the callback.
Property Descriptions
- AnchorMode anchor_mode
Default |
|
Setter | set_anchor_mode(value) |
Getter | get_anchor_mode() |
The Camera2D’s anchor point. See constants.
- bool current
Default |
|
Getter | is_current() |
If true, the camera is the active camera for the current scene. Only one camera can be current, so setting a different camera current will disable this one.
Setter | set_custom_viewport(value) |
Getter | get_custom_viewport() |
The custom node attached to the Camera2D. If null or not a Viewport, uses the default viewport instead.
- drag_margin_bottom
Default |
|
Setter | set_drag_margin(value) |
Getter | get_drag_margin() |
Bottom margin needed to drag the camera. A value of 1 makes the camera move only when reaching the edge of the screen.
- bool drag_margin_h_enabled
Default |
|
Setter | set_h_drag_enabled(value) |
Getter | is_h_drag_enabled() |
If true, the camera only moves when reaching the horizontal drag margins. If false, the camera moves horizontally regardless of margins.
- drag_margin_left
Default |
|
Setter | set_drag_margin(value) |
Getter | get_drag_margin() |
Left margin needed to drag the camera. A value of 1 makes the camera move only when reaching the edge of the screen.
- float drag_margin_right
Default |
|
Setter | set_drag_margin(value) |
Getter | get_drag_margin() |
Right margin needed to drag the camera. A value of 1 makes the camera move only when reaching the edge of the screen.
- drag_margin_top
Top margin needed to drag the camera. A value of 1 makes the camera move only when reaching the edge of the screen.
- bool drag_margin_v_enabled
Default |
|
Setter | set_v_drag_enabled(value) |
Getter | is_v_drag_enabled() |
If true, the camera only moves when reaching the vertical drag margins. If false, the camera moves vertically regardless of margins.
- editor_draw_drag_margin
Default |
|
Setter | set_margin_drawing_enabled(value) |
Getter | is_margin_drawing_enabled() |
If true, draws the camera’s drag margin rectangle in the editor.
- bool editor_draw_limits
Default |
|
Setter | set_limit_drawing_enabled(value) |
Getter | is_limit_drawing_enabled() |
If true, draws the camera’s limits rectangle in the editor.
- editor_draw_screen
Default |
|
Setter | set_screen_drawing_enabled(value) |
Getter | is_screen_drawing_enabled() |
If true, draws the camera’s screen rectangle in the editor.
- int limit_bottom
Default | |
Setter | set_limit(value) |
Getter | get_limit() |
Bottom scroll limit in pixels. The camera stops moving when reaching this value.
- limit_left
Default | |
Setter | set_limit(value) |
Getter | get_limit() |
Left scroll limit in pixels. The camera stops moving when reaching this value.
- int limit_right
Default |
|
Setter | set_limit(value) |
Getter | get_limit() |
Right scroll limit in pixels. The camera stops moving when reaching this value.
- limit_smoothed
Default |
|
Setter | set_limit_smoothing_enabled(value) |
Getter | is_limit_smoothing_enabled() |
If true, the camera smoothly stops when reaches its limits.
This property has no effect if smoothing_enabled is false.
Note: To immediately update the camera’s position to be within limits without smoothing, even with this setting enabled, invoke .
- int limit_top
Top scroll limit in pixels. The camera stops moving when reaching this value.
- offset
Default |
|
Setter | set_offset(value) |
Getter | get_offset() |
The camera’s offset, useful for looking around or camera shake animations.
- float offset_h
Default |
|
Setter | set_h_offset(value) |
Getter | get_h_offset() |
The horizontal offset of the camera, relative to the drag margins.
Note: Offset H is used only to force offset relative to margins. It’s not updated in any way if drag margins are enabled and can be used to set initial offset.
Default |
|
Setter | set_v_offset(value) |
Getter | get_v_offset() |
The vertical offset of the camera, relative to the drag margins.
Note: Used the same as .
- Camera2DProcessMode process_mode
Default |
|
Setter | set_process_mode(value) |
Getter | get_process_mode() |
The camera’s process callback. See .
- bool rotating
Default |
|
Setter | set_rotating(value) |
Getter | is_rotating() |
If true, the camera view rotates with the target.
- smoothing_enabled
Default |
|
Setter | set_enable_follow_smoothing(value) |
Getter | is_follow_smoothing_enabled() |
If true, the camera smoothly moves towards the target at smoothing_speed.
- smoothing_speed
Default |
|
Setter | set_follow_smoothing(value) |
Getter | get_follow_smoothing() |
Speed in pixels per second of the camera’s smoothing effect when smoothing_enabled is true.
- zoom
Default |
|
Setter | set_zoom(value) |
Getter | get_zoom() |
The camera’s zoom relative to the viewport. Values larger than Vector2(1, 1) zoom out and smaller values zoom in. For an example, use Vector2(0.5, 0.5) for a 2× zoom-in, and Vector2(4, 4) for a 4× zoom-out.
- void align ( )
Aligns the camera to the tracked node.
- void clear_current ( )
Removes any Camera2D from the ancestor ‘s internal currently-assigned camera.
- void force_update_scroll ( )
Forces the camera to update scroll immediately.
- Vector2 get_camera_position ( ) const
Returns the camera’s position (the tracked point the camera attempts to follow), relative to the origin.
Note: The returned value is not the same as or Node2D.global_position, as it is affected by the drag properties.
- get_camera_screen_center ( ) const
Returns the location of the Camera2D‘s screen-center, relative to the origin.
Note: The real position of the camera may be different, see get_camera_position.
- get_drag_margin ( Margin margin ) const
Returns the specified margin. See also , drag_margin_top, , and drag_margin_right.
- get_limit ( Margin margin ) const
Returns the specified camera limit. See also , limit_top, , and limit_right.
- void make_current ( )
Make this the current 2D camera for the scene (viewport and layer), in case there are many cameras in the scene.
- void reset_smoothing ( )
Sets the camera’s position immediately to its current smoothing destination.
This method has no effect if is false.
- void set_drag_margin ( Margin margin, drag_margin )
- void set_limit ( Margin margin, limit )
Sets the specified camera limit. See also limit_bottom, , limit_left, and .
