Interface IImageComponent

A component which allows setting an image to the entity.

Inherited Members

IHasImage.Opacity

IHasImage.Tint

IHasImage.Brightness

IHasImage.Pivot

IHasImage.Image

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(IScaleComponent), true)]
[RequiredComponent(typeof(IBoundingBoxComponent), true)]
public interface IImageComponent : IHasImage, IComponent, IDisposable, INotifyPropertyChanged

Properties

CurrentSprite

Gets sprite to render.

Declaration

ISprite CurrentSprite { get; }

Property Value

Type	Description
ISprite	The sprite.

IsImageVisible

Gets or sets a value indicating whether this image is visible. Note that the difference between this and Visible is that this property controls the image renderer only, and the Visible property controls all renderers for the entity.

Declaration

bool IsImageVisible { get; set; }

Property Value

Type	Description
System.Boolean	true if is image visible; otherwise, false.

SpriteProvider

Gets or sets sprite provider.

Declaration

ISpriteProvider SpriteProvider { get; set; }

Property Value

Type	Description
ISpriteProvider	The sprite provider implementation.