class FlxZoomCamera

The alpha value of this camera display (a number between 0.0 and 1.0).

The angle of the camera display (in degrees).

Whether the camera display is smooth and filtered, or chunky and pixelated. Default behavior is chunky-style.

The natural background color of the camera, in AARRGGBB format. Defaults to FlxG.cameras.bgColor. On Flash, transparent backgrounds can be used in conjunction with useBgAlphaBlending.

The actual BitmapData of the camera display itself. Used in blit render mode, where you can manipulate its pixels for achieving some visual effects.

Sprite used for actual rendering in tile render mode (instead of _flashBitmap for blitting). Its graphics is used as a drawing surface for drawTriangles() and drawTiles() methods. It is a child of _scrollRect Sprite (which trims graphics that should be invisible). Its position is modified by updateInternalSpritePositions(), which is called on camera's resize and scale events.

The color tint of the camera display.

You can assign a "dead zone" to the camera in order to better control its movement. The camera will always keep the focus object inside the dead zone, unless it is bumping up against the camera bounds. The deadzone's coordinates are measured from the camera's upper left corner in game pixels. For rapid prototyping, you can use the preset deadzones (e.g. PLATFORMER) with follow().

Sprite for visual effects (flash and fade) and drawDebug information (bounding boxes are drawn on it) for tile render mode. It is a child of _scrollRect Sprite (which trims graphics that should be invisible). Its position is modified by updateInternalSpritePositions(), which is called on camera's resize and scale events.

The filters array to be applied to the camera.

Enables or disables the filters set via setFilters().

Used to render buffer to screen space. NOTE: We don't recommend modifying this directly unless you are fairly experienced. Uses include 3D projection, advanced display list modification, and more. This is container for everything else that is used by camera and rendered to the camera.

Its position is modified by updateFlashSpritePosition() which is called every frame.

Used to force the camera to look ahead of the target.

Used to smoothly track the camera as it follows: The percent of the distance to the follow target the camera moves per 1/60 sec. Values are bounded between 0.0 and 60 / FlxG.updateFramerate for consistency across framerates. The maximum value means no camera easing. A value of 0 means the camera does not move.

How tall the camera display is, in game pixels.

Camera's initial zoom value. Used for camera's scale handling.

Upper bound of the camera's scroll on the x axis.

Upper bound of the camera's scroll on the y axis.

Lower bound of the camera's scroll on the x axis.

Lower bound of the camera's scroll on the y axis.

Whether the positions of the objects rendered on this camera are rounded. If set on individual objects, they ignore the global camera setting. Defaults to false with FlxG.renderTile and to true with FlxG.renderBlit. WARNING: setting this to false on blitting targets is very expensive.

If true, screen shake will be rounded to game pixels. If null, pixelPerfectRender is used.

The scaling on horizontal axis for this camera. Setting scaleX changes scaleX and x coordinate of camera's internal display objects.

The scaling on vertical axis for this camera. Setting scaleY changes scaleY and y coordinate of camera's internal display objects.

Sometimes it's easier to just work with a FlxSprite than it is to work directly with the BitmapData buffer. This sprite reference will allow you to do exactly that. Basically this sprite's pixels property is camera's BitmapData buffer. NOTE: This variable is used only in blit render mode.

The FlxBloom demo shows how you can use this variable in blit render mode.

See also:

• http://haxeflixel.com/demos/FlxBloom/

Stores the basic parallax scrolling values. This is basically the camera's top-left corner position in world coordinates. There is also focusOn(point:FlxPoint) which you can use to make the camera look at specified point in world coordinates.

Tells the camera to use this following style.

Tells the camera to follow this FlxObject object around.

Offset the camera target.

Product of camera's scaleX and game's scale mode scale.x multiplication.

Product of camera's scaleY and game's scale mode scale.y multiplication.

Whether to use alpha blending for camera's background fill or not. If true then previously drawn graphics won't be erased, and if camera's bgColor is transparent/semitransparent then you will be able to see graphics of the previous frame. Useful for blit render mode (and works only in this mode). Default value is false.

Usage example can be seen in FlxBloom demo.

See also:

• http://haxeflixel.com/demos/FlxBloom/

The bottom side of the camera's view, in world space.

The size of the camera's view, in world space.

The left of the camera's view, in world space.

The margin cut off on the bottom by the camera zooming in (or out), in world space

The margin cut off on the left by the camera zooming in (or out), in world space.

The margin cut off on the right by the camera zooming in (or out), in world space

The margin cut off on the top by the camera zooming in (or out), in world space

The margin cut off on the left and right by the camera zooming in (or out), in world space.

The margin cut off on the top and bottom by the camera zooming in (or out), in world space.

The right side of the camera's view, in world space.

The top of the camera's view, in world space.

The size of the camera's view, in world space.

The left of the camera's view, in world space.

The top of the camera's view, in world space.

How wide the camera display is, in game pixels.

The X position of this camera's display. zoom does NOT affect this number. Measured in pixels from the left side of the window. You might be interested in using camera's scroll.x instead.

The Y position of this camera's display. zoom does NOT affect this number. Measured in pixels from the top of the window. You might be interested in using camera's scroll.y instead.

The zoom level of this camera. 1 = 1:1, 2 = 2x zoom, etc. Indicates how far the camera is zoomed in. Note: Changing this property from it's initial value will change properties like: viewX, viewY, viewWidth, viewHeight and many others. Cameras always zoom in to their center, meaning as you zoom in, the view is cut off on all sides.

A unique ID starting from 0 and increasing by 1 for each subsequent FlxBasic that is created.

Controls whether update() is automatically called by FlxState/FlxGroup.

Useful state for many game objects - "dead" (!alive) vs alive. kill() and revive() both flip this switch (along with exists, but you can override that).

Gets or sets the first camera of this object.

This determines on which FlxCameras this object will be drawn. If it is null / has not been set, it uses the list of default draw targets, which is controlled via FlxG.camera.setDefaultDrawTarget as well as the DefaultDrawTarget argument of FlxG.camera.add.

The parent containing this basic, typically if you check this recursively you should reach the state

Controls whether update() and draw() are automatically called by FlxState/FlxGroup.

Controls whether draw() is automatically called by FlxState/FlxGroup.

Takes the desired scroll position and restricts it to the camera's min/max scroll properties. This modifies the given point.

Parameters:

Returns:

Checks whether this camera contains a given point or rectangle, in screen coordinates.

Checks whether this camera contains a given rectangle, in screen coordinates.

Copy the bounds, focus object, and deadzone info from an existing camera.

Parameters:

Returns:

Clean up memory.

The screen is gradually filled with this color.

Parameters:

Fill the camera with the specified color.

Parameters:

The screen is filled with this color and gradually returns to normal.

Parameters:

Move the camera focus to this location instantly.

Parameters:

Tells this camera object what FlxObject to track.

Parameters:

The size and position of this camera's margins, via viewMarginLeft, viewMarginTop, viewWidth and viewHeight.

The size and position of this camera's margins, via viewMarginLeft, viewMarginTop, viewWidth and viewHeight.

Notes: Deprecated, in 4.11.0 this was made public, but the wording is confusing. In flixel 6.0.0 this will be changed to use viewX, viewY, viewWidth and viewHeight, meaning, this will return the world coordinates of the camera.

Called by camera front end every time you resize the game. It triggers reposition of camera's internal display objects.

Sets the filter array to be applied to the camera.

Helper function to set the coordinates of this camera. Handy since it only requires one line of code.

Parameters:

Helper function to set the scale of this camera. Handy since it only requires one line of code.

Parameters:

Specify the bounds of where the camera is allowed to move. Set the boundary of a side to null to leave that side unbounded.

Parameters:

Specify the bounding rectangle of where the camera is allowed to move.

Parameters:

Shortcut for setting both width and height.

Parameters:

A simple screen-shake effect.

Parameters:

Snaps the camera to the current target. Useful to move the camera without any easing when the target position changes and there is a followLerp.

Stops all effects on this camera.

Stops the fade effect on this camera.

Stops the flash effect on this camera.

Stops the shake effect on this camera.

Updates camera's scroll. Called every frame by camera's update() method (if camera's target isn't null).

Updates (bounds) the camera scroll. Called every frame by camera's update() method.

Override this function to control how the object is drawn. Doing so is rarely necessary, but can be very useful.

The cameras that will draw this. Use this.cameras to set specific cameras for this object, otherwise the container's cameras are used, or the container's container and so on. If there is no container, say, if this is inside FlxGroups rather than a FlxContainer then the default draw cameras are returned.

Handy function for "killing" game objects. Use reset() to revive them. Default behavior is to flag them as nonexistent AND dead. However, if you want the "corpse" to remain in the game, like to animate an effect or whatever, you should override this, setting only alive to false, and leaving exists true.

Handy function for bringing game objects "back to life". Just sets alive and exists back to true. In practice, this function is most often called by FlxObject#reset().