Interface IRoomFactory

Factory for creating rooms and room specifics.

Namespace: AGS.API

Assembly: AGS.API.dll

Syntax

public interface IRoomFactory

Methods

CreateScaleArea(IArea, Single, Single, Boolean, Boolean, Boolean)

Creates a scaling area(IScalingArea).

Declaration

void CreateScaleArea(IArea area, float minScaling, float maxScaling, bool scaleObjectsX = true, bool scaleObjectsY = true, bool scaleVolume = true)

Parameters

Type	Name	Description
IArea	area	The area that will be "transormed" into a scaling area.
System.Single	minScaling	Minimum scaling (will be applied at the top of the area).
System.Single	maxScaling	Maximum scaling (will be applied at the bottom of the area).
System.Boolean	scaleObjectsX	If set to true scale objects on the horizontal axis while in this area.
System.Boolean	scaleObjectsY	If set to true scale objects on the vertical axis while in this area.
System.Boolean	scaleVolume	If set to true scale volume emitted from objects when in this area.

CreateZoomArea(IArea, Single, Single)

Creates a camera zoom area(IZoomArea).

Declaration

void CreateZoomArea(IArea area, float minZoom, float maxZoom)

Parameters

Type	Name	Description
IArea	area	The area that will be "transformed" into a zoom area.
System.Single	minZoom	Minimum zoom factor (will be applied at the bottom of the area).
System.Single	maxZoom	Maximum zoom factor (will be applied at the top of the area).

GetArea(String, IMask, IRoom, Boolean, Boolean)

Creates an area from a mask, which can be made walkable and/or walk-behind (or none of the above). A walkable area is an area in which characters can walk. A walk-behind area is an area which puts the characters behind the room's background, if their Y property is under the walk-behind area's baseline (usually the bottom of the mask). This is useful if part of your background image contains spots which should actually be in the front.

Declaration

IArea GetArea(string id, IMask mask, IRoom room = null, bool isWalkable = false, bool isWalkBehind = false)

Parameters

Type	Name	Description
System.String	id	Unique identifier for the area.
IMask	mask	Mask.
IRoom	room	The room to place the area in.
System.Boolean	isWalkable	If set to true is walkable.
System.Boolean	isWalkBehind	If set to true is walk behind.

Returns

Type	Description
IArea	The area.

GetArea(String, IMask, Boolean, Boolean, Boolean, Single, Single, Boolean, Single, Single, IRoom)

Creates an area from a mask, which can be made walkable, walk-behind, scaling or zoom area (and any combination of the above). A walkable area is an area in which characters can walk. A walk-behind area is an area which puts the characters behind the room's background, if their Y property is under the walk-behind area's baseline (usually the bottom of the mask). This is useful if part of your background image contains spots which should actually be in the front. A scaling area is an area which scales the entities that are in it based on where they are in that area. A zoom area is an area that zooms the camera if the camera's target is in that area, based on where the target is exactly inside the area.

Declaration

IArea GetArea(string id, IMask mask, bool isWalkable, bool isWalkbehind, bool isScaling, float minScaling, float maxScaling, bool isZoom, float minZoom, float maxZoom, IRoom room = null)

Parameters

Type	Name	Description
System.String	id	Identifier.
IMask	mask	Mask.
System.Boolean	isWalkable	If set to true is walkable.
System.Boolean	isWalkbehind	If set to true is walkbehind.
System.Boolean	isScaling	If set to true is scaling.
System.Single	minScaling	Minimum scaling.
System.Single	maxScaling	Max scaling.
System.Boolean	isZoom	If set to true is zoom.
System.Single	minZoom	Minimum zoom.
System.Single	maxZoom	Max zoom.
IRoom	room	Room.

Returns

Type	Description
IArea	The area.

GetArea(String, IRoom, Boolean, Boolean)

Creates an area, which can be made walkable and/or walk-behind (or none of the above). A walkable area is an area in which characters can walk. A walk-behind area is an area which puts the characters behind the room's background, if their Y property is under the walk-behind area's baseline (usually the bottom of the mask). This is useful if part of your background image contains spots which should actually be in the front.

Declaration

IArea GetArea(string maskPath, IRoom room = null, bool isWalkable = false, bool isWalkBehind = false)

Parameters

Type	Name	Description
System.String	maskPath	The resource path which contains the bitmap mask for the area.
IRoom	room	The room to place the area in.
System.Boolean	isWalkable	If set to true the area should be made walkable.
System.Boolean	isWalkBehind	If set to true the should be made a walk-behind area.

Returns

Type	Description
IArea	The area.

GetAreaAsync(String, IRoom, Boolean, Boolean)

Creates an area asynchronously, which can be made walkable and/or walk-behind (or none of the above). A walkable area is an area in which characters can walk. A walk-behind area is an area which puts the characters behind the room's background, if their Y property is under the walk-behind area's baseline (usually the bottom of the mask). This is useful if part of your background image contains spots which should actually be in the front.

Declaration

Task<IArea> GetAreaAsync(string maskPath, IRoom room = null, bool isWalkable = false, bool isWalkBehind = false)

Parameters

Type	Name	Description
System.String	maskPath	The resource path which contains the bitmap mask for the area.
IRoom	room	The room to place the area in.
System.Boolean	isWalkable	If set to true the area should be made walkable.
System.Boolean	isWalkBehind	If set to true the should be made a walk-behind area.

Returns

Type	Description
System.Threading.Tasks.Task<IArea>	The area.

GetEdge(Single)

Creates a new room edge.

Declaration

IEdge GetEdge(float value = 0F)

Parameters

Type	Name	Description
System.Single	value	The value for the edge (if this is a left edge, the the left value, for a top edge, the top value, etc).

Returns

Type	Description
IEdge	The edge.

GetRoom(String, Single, Single, Single, Single)

Creates a new room.

Declaration

IRoom GetRoom(string id, float leftEdge = 0F, float rightEdge = 0F, float bottomEdge = 0F, float topEdge = 0F)

Parameters

Type	Name	Description
System.String	id	A unique identifier for the room.
System.Single	leftEdge	Left edge.
System.Single	rightEdge	Right edge.
System.Single	bottomEdge	Bottom edge.
System.Single	topEdge	Top edge.

Returns

Type	Description
IRoom	The room.