Skip to content

T_WolfCurses_SimulationApp

Maxwolf edited this page Jan 2, 2016 · 2 revisions

SimulationApp Class

Base simulation application class object. This class should not be declared directly but inherited by actual instance of game controller.

Inheritance Hierarchy

System.Object
  WolfCurses.SimulationApp
Namespace: WolfCurses
Assembly: WolfCurses (in WolfCurses.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax

C#

public abstract class SimulationApp : ITick

The SimulationApp type exposes the following members.

Constructors

 

Name Description
Protected method SimulationApp Initializes a new instance of the SimulationApp class.
  Back to Top

Properties

 

Name Description
Public property AllowedWindows Determines what windows the simulation will be capable of using and creating using the window managers factory.
Public property InputManager Handles input from the users keyboard, holds an input buffer and will push it to the simulation when return key is pressed.
Public property IsClosing Determines if the simulation is currently closing down.
Public property Random Used for rolling the virtual dice in the simulation to determine the outcome of various events.
Public property SceneGraph Shows the current state of the simulation as text only interface (TUI). Uses default constants if the attached Windows or state does not override this functionality and it is ticked.
Public property WindowManager Keeps track of the currently attached game Windows, which one is active, and getting text user interface data.
  Back to Top

Methods

 

Name Description
Public method Destroy Fired when the simulation is closing and needs to clear out any data structures that it created so the program can exit cleanly.
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method OnFirstTick Fired when the ticker receives the first system tick event.
Protected method OnPreDestroy Called when simulation is about to destroy itself, but right before it actually does it.
Public method OnPreRender Called by the text user interface scene graph renderer before it asks the active window to render itself out for display.
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.
Public method Restart Creates and or clears data sets required for game simulation and attaches the travel menu and the main menu to make the program completely restarted as if fresh.
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
  Back to Top

Fields

 

Name Description
Public fieldStatic member SHOW_COMMANDS Determines if the dynamic menu system should show the command names or only numbers. If false then only numbers will be shown.
  Back to Top

Extension Methods

 

Name Description
Public Extension Method ToDescriptionAttribute Attempts to grab description attribute from any object. (Defined by AttributeExtensions.)
  Back to Top

Version Information

Wolf Curses

Supported in: 0.1

See Also

Reference

WolfCurses Namespace

Clone this wiki locally