Interface ITranslate

Allows changing the position of entities/sprites.

Inherited Members

System.ComponentModel.INotifyPropertyChanged.PropertyChanged

System.IDisposable.Dispose()

Namespace: AGS.API

Assembly: AGS.API.dll

Syntax

public interface ITranslate : INotifyPropertyChanged, IDisposable

Properties

Position

Gets or sets the location. (X,Y) are used to place the entity/sprite in 2D space (in local coordinates). The local coordinates are the world coordinates if the entity has no parent, otherwise its the coordinates relative to the parent.

Z is used for deciding how the entities/sprites are ordered in 2D space (higher Z in front). If Z and Y are the same when setting the location, then Z will be bound to Y: whenever Y moves, Z moves, which will make entities closer to the bottom appear in front, which is the desired behavior in most scenarios. You can change this behavior by explicitly setting Z to a different value.

Declaration

Position Position { get; set; }

Property Value

Type	Description
Position	The location.

See Also

IWorldPositionComponent

X

Gets or sets the x coordinate (in local coordinates). The local coordinates are the world coordinates if the entity has no parent, otherwise its the coordinates relative to the parent.

Declaration

float X { get; set; }

Property Value

Type	Description
System.Single	The x.

See Also

WorldX

Y

Gets or sets the y coordinate (in local coordinates). The local coordinates are the world coordinates if the entity has no parent, otherwise its the coordinates relative to the parent.

Declaration

float Y { get; set; }

Property Value

Type	Description
System.Single	The y.

See Also

WorldY

Z

Gets or sets the z property. Z is used for deciding how the entities/sprites are ordered in 2D space (higher Z in front). If Z and Y are the same when setting the location, then Z will be bound to Y: whenever Y moves, Z moves, which will make entities closer to the bottom appear in front, which is the desired behavior in most scenarios. You can change this behavior by explicitly setting Z to a different value.

Declaration

float Z { get; set; }

Property Value

Type	Description
System.Single	The z.