Class Positionable<TCoordinates>

Namespace

AlphaFramework.World.Positionables

Assembly

AlphaFramework.World.dll

An object that can be positioned in the game world.

public abstract class Positionable<TCoordinates> : ICloneable, IChangeNotify<Positionable<TCoordinates>> where TCoordinates : struct

Type Parameters

TCoordinates

Data type for storing position coordinates of objects in the game world.

Inheritance

object

Positionable<TCoordinates>

Implements

ICloneable

IChangeNotify<Positionable<TCoordinates>>

Derived

CameraState<TCoordinates>

EntityBase<TCoordinates, TTemplate>

Water

Trigger

Waypoint

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Extension Methods

XmlStorage.SaveXmlZip<T>(T, Stream, string?, params EmbeddedFile[])

XmlStorage.SaveXmlZip<T>(T, string, string?, params EmbeddedFile[])

XmlStorage.SaveXml<T>(T, Stream, string?)

XmlStorage.SaveXml<T>(T, string, string?)

XmlStorage.ToXmlString<T>(T, string?)

Properties

Name

Used for identification in scripts, debugging, etc.

public string? Name { get; set; }

Property Value

string

Position

The Positionable<TCoordinates>'s position.

public TCoordinates Position { get; set; }

Property Value

TCoordinates

Methods

Clone()

Creates a deep copy of this Positionable<TCoordinates>.

public virtual Positionable<TCoordinates> Clone()

Returns

Positionable<TCoordinates>

The cloned Positionable<TCoordinates>.

OnChanged()

To be called when a property relevant for rendering has changed.

protected virtual void OnChanged()

OnChangedRebuild()

To be called when a property has changed, that requires visual representations to be rebuilt from scratch (usually a template).

protected void OnChangedRebuild()

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.

Events

Changed

Occurs when a property relevant for rendering has changed.

public event Action<Positionable<TCoordinates>>? Changed

Event Type

Action<Positionable<TCoordinates>>

ChangedRebuild

Occurs when a property has changed that requires visual representations to rebuilt from scratch (usually a template).

public event Action<Positionable<TCoordinates>>? ChangedRebuild

Event Type

Action<Positionable<TCoordinates>>