Show / Hide Table of Contents

Class ObjectComponentMove

Moves a IScreenObject with the arrow keys.

Inheritance
object
KeyboardConsoleComponent
ObjectComponentMove
Implements
IComponent
Inherited Members
KeyboardConsoleComponent.OnAdded(IScreenObject)
KeyboardConsoleComponent.OnRemoved(IScreenObject)
KeyboardConsoleComponent.SortOrder
object.GetType()
object.MemberwiseClone()
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
Namespace: SadConsole.Components
Assembly: SadConsole.dll
Syntax
public class ObjectComponentMove : KeyboardConsoleComponent, IComponent

Constructors

ObjectComponentMove()

Creates a new instance of the object with an Amount of 1.

Declaration
public ObjectComponentMove()

Properties

Amount

The amount to move the object by.

Declaration
public int Amount { get; set; }
Property Value
Type Description
int

DownKey

The key to move the object Down by Amount.

Declaration
public Keys DownKey { get; set; }
Property Value
Type Description
Keys

LeftKey

The key to move the object Left by Amount.

Declaration
public Keys LeftKey { get; set; }
Property Value
Type Description
Keys

RightKey

The key to move the object SadRogue.Primitives.Direction.Right by Amount.

Declaration
public Keys RightKey { get; set; }
Property Value
Type Description
Keys

UpKey

The key to move the object SadRogue.Primitives.Direction.Up by Amount.

Declaration
public Keys UpKey { get; set; }
Property Value
Type Description
Keys

Methods

ProcessKeyboard(IScreenObject, Keyboard, out bool)

Moves the host by Amount when the appropriate key is pressed.

Declaration
public override void ProcessKeyboard(IScreenObject host, Keyboard keyboard, out bool handled)
Parameters
Type Name Description
IScreenObject host
Keyboard keyboard
bool handled
Overrides
KeyboardConsoleComponent.ProcessKeyboard(IScreenObject, Keyboard, out bool)

Implements

IComponent

Extension Methods

ExtensionsSystem.GetDebuggerDisplayValue(object)
In this article

Back to top

Back to top Generated by DocFX