T_WolfCurses_IWindow - Maxwolf/WolfCurses GitHub Wiki

IWindow Interface

Underlying game Windows interface, used by base simulation to keep track of what data should currently have control over the simulation details. Only top most game Windows will ever be ticked.

Namespace: WolfCurses
Assembly: WolfCurses (in WolfCurses.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax

C#

public interface IWindow : IComparer<IWindow>, 
	IComparable<IWindow>, ITick

The IWindow type exposes the following members.

Properties

 

Name Description
Public property AcceptsInput Determines if user input is currently allowed to be typed and filled into the input buffer.
Public property CurrentForm Holds the current state which this Windows is in, a Windows will cycle through available states until it is finished and then detach.
Public property ShouldRemoveMode Determines if the game Windows should not be ticked if it is active but instead removed. The Windows when set to being removed will not actually be removed until the simulation attempts to tick it and realizes that this is set to true and then it will be removed.
Public property UserData Intended to be overridden in abstract class by generics to provide method to return object that contains all the data for parent game Windows.
  Back to Top

Methods

 

Name Description
Public method ClearForm Removes the current state from the active game Windows.
Public method Compare Compares two objects and returns a value indicating whether one is less than, equal to, or greater than the other. (Inherited from IComparer(IWindow).)
Public method CompareTo Compares the current object with another object of the same type. (Inherited from IComparable(IWindow).)
Public method OnRenderWindow Grabs the text user interface string that will be used for debugging on console application.
Public method OnTick Called when the simulation is ticked by underlying operating system, game engine, or potato. Each of these system ticks is called at unpredictable rates, however if not a system tick that means the simulation has processed enough of them to fire off event for fixed interval that is set in the core simulation by constant in milliseconds. (Inherited from ITick.)
Public method OnWindowActivate Called when the Windows manager in simulation makes this Windows the currently active game Windows. Depending on order of modes this might not get called until the Windows is actually ticked by the simulation.
Public method OnWindowAdded Fired when the simulation adds a game Windows that is not this Windows. Used to execute code in other modes that are not the active Windows anymore one last time.
Public method OnWindowPostCreate Called after the Windows has been added to list of modes and made active.
Public method RemoveWindowNextTick Sets the flag for this game Windows to be removed the next time it is ticked by the simulation.
Public method SendCommand Intended to be used by base simulation to pass along the input buffer after the user has typed several characters into the input buffer. This is used when allowing the user to input custom strings like names for their party members.
Public method SetForm Creates and adds the specified type of state to currently active game Windows.
  Back to Top

Version Information

Wolf Curses

Supported in: 0.1

See Also

Reference

WolfCurses Namespace

⚠️ **GitHub.com Fallback** ⚠️