Interface IZoomArea

These are areas that indicate the camera should automatically zoom when the player (or whatever other target was chosen for the camera) is in that area. This works along nicely with a vertical scaling area, to zoom the camera as the player moves farther away from the camera.

Inherited Members

IComponent.Name

IComponent.Entity

IComponent.RegistrationType

IComponent.Init(IEntity, Type)

IComponent.AfterInit()

System.IDisposable.Dispose()

System.ComponentModel.INotifyPropertyChanged.PropertyChanged

Namespace: AGS.API

Assembly: AGS.API.dll

Syntax

[RequiredComponent(typeof(IArea), true)]
public interface IZoomArea : IComponent, IDisposable, INotifyPropertyChanged

Properties

MaxZoom

The highest point in the area, which usually corresponds to the farthest distance to the camera (if your background has perspective) will have the camera at its "maximal zoom" which is what configured here. This will be interpolated as the character moves down the area until it reaches the most bottom area (the "minimal zoom").

Declaration

float MaxZoom { get; set; }

Property Value

Type	Description
System.Single	The minimum zoom.

MinZoom

The lowest point in the area, which usually corresponds to the closest distance to the camera (if your background has perspective) will have the camera at its "minimal zoom" which is what configured here. This will be interpolated as the character moves up the area until it reaches the top-most area (the "maximal zoom").

Declaration

float MinZoom { get; set; }

Property Value

Type	Description
System.Single	The minimum zoom.

ZoomCamera

Gets or sets a value indicating whether to zoom the camera on this area or not.

Declaration

bool ZoomCamera { get; set; }

Property Value

Type	Description
System.Boolean	true if zoom camera; otherwise, false.

Methods

GetZoom(Single)

Gets the zoom factor for the given Y value (in room coordinates).

Declaration

float GetZoom(float value)

Parameters

Type	Name	Description
System.Single	value	Value.

Returns

Type	Description
System.Single	The zoom.