VirtualAxis Class

[This is preliminary documentation and is subject to change.]

Concrete class for custom virtual axes.

Inheritance Hierarchy

SystemObject
RavingBots.MultiInputVirtualAxis

Namespace: RavingBots.MultiInput
Assembly: RavingBots.MultiInput (in RavingBots.MultiInput.dll) Version: 0.12

Syntax

public sealed class VirtualAxis : IVirtualAxis

The VirtualAxis type exposes the following members.

Constructors

	Name	Description
	VirtualAxis	Constructs a new virtual axis, optionally setting Code property.

Properties

	Name	Description
	Code	InputCode associated with this axis, if any. Informative only.
	HasChanged	true if value on this axis has changed from the previous frame.
	IsDown	true if IsHeld was false in the previous frame but isn't in this one.
	IsHeld	true if this axis is not in the rest state in the current frame (i.e. Value is not zero).
	IsUp	true if IsHeld was true in the previous frame and isn't in this one.
	NextValue	Uncommitted value on this axis for the next frame. May change multiple times during a single frame until committed.
	PreviousValue	Value on this axis in the previous frame.
	Value	Value on this axis in the current frame.

Methods

	Name	Description
	Add	Adds a value to the uncommitted next frame. Convenience method for axes that accumulate input in-between frames.
	Commit	Commits changes to the next frame.
	Set(Boolean)	Sets the next frame value. Convenience method for axes representing digital buttons.
	Set(Single)	Sets the next frame value.