Interface IOutfitFactory

A factory for creating animation outfits for characters. The factory conveniently allows for idle, walk and speak animations, where other animations can be added to the outfit manually.

Namespace: AGS.API

Assembly: AGS.API.dll

Syntax

public interface IOutfitFactory

Methods

LoadOutfitFromFolders(String, String, String, String, String, String, String, String, String, String, String, String, String, IAnimationConfiguration, ILoadImageConfig)

Loads the outfit animation from several folders (each folder contains one animation). The folders can be resource folders, or actual folders on the file system (see cref="IRsourceLoader"/>.

Declaration

IOutfit LoadOutfitFromFolders(string baseFolder, string walkLeftFolder = null, string walkRightFolder = null, string walkDownFolder = null, string walkUpFolder = null, string idleLeftFolder = null, string idleRightFolder = null, string idleDownFolder = null, string idleUpFolder = null, string speakLeftFolder = null, string speakRightFolder = null, string speakDownFolder = null, string speakUpFolder = null, IAnimationConfiguration animationConfig = null, ILoadImageConfig loadConfig = null)

Parameters

Type	Name	Description
System.String	baseFolder	Base folder, all other folders will be on a relative path from this folder.
System.String	walkLeftFolder	Walk left folder.
System.String	walkRightFolder	Walk right folder.
System.String	walkDownFolder	Walk down folder.
System.String	walkUpFolder	Walk up folder.
System.String	idleLeftFolder	Idle left folder.
System.String	idleRightFolder	Idle right folder.
System.String	idleDownFolder	Idle down folder.
System.String	idleUpFolder	Idle up folder.
System.String	speakLeftFolder	Speak left folder.
System.String	speakRightFolder	Speak right folder.
System.String	speakDownFolder	Speak down folder.
System.String	speakUpFolder	Speak up folder.
IAnimationConfiguration	animationConfig	Animation configuration to be applied for all animations.
ILoadImageConfig	loadConfig	Load image configuration to be applied for all images.

Returns

Type	Description
IOutfit	The outfit from folders.

LoadOutfitFromFoldersAsync(String, String, String, String, String, String, String, String, String, String, String, String, String, IAnimationConfiguration, ILoadImageConfig)

Loads the outfit animation from several folders asynchronously (each folder contains one animation). The folders can be resource folders, or actual folders on the file system (IResourceLoader).

Declaration

Task<IOutfit> LoadOutfitFromFoldersAsync(string baseFolder, string walkLeftFolder = null, string walkRightFolder = null, string walkDownFolder = null, string walkUpFolder = null, string idleLeftFolder = null, string idleRightFolder = null, string idleDownFolder = null, string idleUpFolder = null, string speakLeftFolder = null, string speakRightFolder = null, string speakDownFolder = null, string speakUpFolder = null, IAnimationConfiguration animationConfig = null, ILoadImageConfig loadConfig = null)

Parameters

Type	Name	Description
System.String	baseFolder	Base folder, all other folders will be on a relative path from this folder.
System.String	walkLeftFolder	Walk left folder.
System.String	walkRightFolder	Walk right folder.
System.String	walkDownFolder	Walk down folder.
System.String	walkUpFolder	Walk up folder.
System.String	idleLeftFolder	Idle left folder.
System.String	idleRightFolder	Idle right folder.
System.String	idleDownFolder	Idle down folder.
System.String	idleUpFolder	Idle up folder.
System.String	speakLeftFolder	Speak left folder.
System.String	speakRightFolder	Speak right folder.
System.String	speakDownFolder	Speak down folder.
System.String	speakUpFolder	Speak up folder.
IAnimationConfiguration	animationConfig	Animation configuration to be applied for all animations.
ILoadImageConfig	loadConfig	Load image configuration to be applied for all images.

Returns

Type	Description
System.Threading.Tasks.Task<IOutfit>	The outfit from folders.