EasyTalk.Character.AnimatableDisplayImage Class Reference

Defines attributes of an image, which can also be animated if it includes more than one sprite. More...

Properties
string	ID [get, set]
	Gets or sets the ID of the image.
string	TargetID [get, set]
	Gets or sets the default target display ID for the image.
List< Sprite >	Sprites [get, set]
	Gets or sets the List of sprites for the image's sprite sequence.
bool	RandomizeImageWhenShown [get, set]
	Gets or sets whether the starting image will be selected randomly from the sprite list when shown.
AnimationMode	AnimationMode [get, set]
	Gets or sets the sprite sequence animation mode to use.
float	FrameRate [get, set]
	Gets or sets the frame rate (in frames per second) for the animation.

Private Attributes
string	id = ""
	The ID used to reference the image.
string	targetId = ""
	The default target display ID on which the image should be displayed.
List< Sprite >	sprites = new List<Sprite>()
	The sprite sequence used for the image's animation, or a single image in the case of non-animated images.
bool	randomizeImageWhenShown = false
	When set to true, the initial image will be chosen from the sprite list randomly when shown.
AnimationMode	animationMode = AnimationMode.NONE
	The animation mode used for the animation sequence when multiple sprites are defined.
float	frameRate = 16
	The number of times per second that the image index will be updated.

Detailed Description

Defines attributes of an image, which can also be animated if it includes more than one sprite.

Member Data Documentation

animationMode

AnimationMode EasyTalk.Character.AnimatableDisplayImage.animationMode = AnimationMode.NONE

private

The animation mode used for the animation sequence when multiple sprites are defined.

frameRate

float EasyTalk.Character.AnimatableDisplayImage.frameRate = 16

private

The number of times per second that the image index will be updated.

id

string EasyTalk.Character.AnimatableDisplayImage.id = ""

private

The ID used to reference the image.

randomizeImageWhenShown

bool EasyTalk.Character.AnimatableDisplayImage.randomizeImageWhenShown = false

private

When set to true, the initial image will be chosen from the sprite list randomly when shown.

sprites

List<Sprite> EasyTalk.Character.AnimatableDisplayImage.sprites = new List<Sprite>()

private

The sprite sequence used for the image's animation, or a single image in the case of non-animated images.

targetId

string EasyTalk.Character.AnimatableDisplayImage.targetId = ""

private

The default target display ID on which the image should be displayed.

Property Documentation

AnimationMode

AnimationMode EasyTalk.Character.AnimatableDisplayImage.AnimationMode

getset

Gets or sets the sprite sequence animation mode to use.

FrameRate

float EasyTalk.Character.AnimatableDisplayImage.FrameRate

getset

Gets or sets the frame rate (in frames per second) for the animation.

ID

string EasyTalk.Character.AnimatableDisplayImage.ID

getset

Gets or sets the ID of the image.

RandomizeImageWhenShown

bool EasyTalk.Character.AnimatableDisplayImage.RandomizeImageWhenShown

getset

Gets or sets whether the starting image will be selected randomly from the sprite list when shown.

Sprites

List<Sprite> EasyTalk.Character.AnimatableDisplayImage.Sprites

getset

Gets or sets the List of sprites for the image's sprite sequence.

TargetID

string EasyTalk.Character.AnimatableDisplayImage.TargetID

getset

Gets or sets the default target display ID for the image.