Interface IEdge

Room edges are a convenient way for scripting a room change once a player walks beyond an edge. Each room has 4 edges, and this interface represents any of those edges.

Inherited Members

System.ComponentModel.INotifyPropertyChanged.PropertyChanged

Namespace: AGS.API

Assembly: AGS.API.dll

Syntax

public interface IEdge : INotifyPropertyChanged

Properties

Enabled

Gets or sets a value indicating whether this IEdge is enabled. If disabled, the OnEdgeCrossed event will not be fired on edge crossing.

Declaration

bool Enabled { get; set; }

Property Value

Type	Description
System.Boolean	true if enabled; otherwise, false.

OnEdgeCrossed

An event which is fired when the player character crosses the edge from inside to outside.

Declaration

IBlockingEvent OnEdgeCrossed { get; }

Property Value

Type	Description
IBlockingEvent	The on edge crossed.

Value

Gets or sets the edge's value (if it's left/right edge then it's an X value, if it's top/bottom edge then it's a Y value). Whether X or Y, the value is used in room coordinates.

Declaration

float Value { get; set; }

Property Value

Type	Description
System.Single	The value.