Methods_T_WolfCurses_Form_Input_InputForm_1 - Maxwolf/WolfCurses GitHub Wiki

InputForm(T) Methods

The InputForm(T) generic type exposes the following members.

Methods

 

Name Description
Protected method ClearForm Removes the current state from the active game Windows. (Inherited from Form(TData).)
Public method Compare(Form(TData), Form(TData)) When overridden in a derived class, performs a comparison of two objects of the same type and returns a value indicating whether one object is less than, equal to, or greater than the other. (Inherited from Form(TData).)
Public method Compare(IForm, IForm) Compares two objects and returns a value indicating whether one is less than, equal to, or greater than the other. (Inherited from Form(TData).)
Public method CompareTo(Form(TData)) Compares the current object with another object of the same type. (Inherited from Form(TData).)
Public method CompareTo(IForm) Compares the current object with another object of the same type. (Inherited from Form(TData).)
Public method Equals(Object) Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public method Equals(Form(TData)) Indicates whether the current object is equal to another object of the same type. (Inherited from Form(TData).)
Public method Equals(Form(TData), Form(TData)) Determines whether the specified objects are equal. (Inherited from Form(TData).)
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 Form(TData).)
Public method GetHashCode(Form(TData)) Returns a hash code for the specified object. (Inherited from Form(TData).)
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 OnDialogPrompt Fired when dialog prompt is attached to active game Windows and would like to have a string returned.
Protected method OnDialogResponse Fired when the dialog receives favorable input and determines a response based on this. From this method it is common to attach another state, or remove the current state based on the response.
Public method OnFormActivate Fired when the window is activated and or refocused after another window was removed from being on-top of it. Useful for re-initializing form data after something like a random event runs which might kill people or alter the vehicle inventory. (Inherited from Form(TData).)
Public method OnFormPostCreate Fired after the state has been completely attached to the simulation letting the state know it can browse the user data and other properties below it. (Overrides Form(TData).OnFormPostCreate().)
Public method OnInputBufferReturned Fired when the game Windows current state is not null and input buffer does not match any known command. (Overrides Form(TData).OnInputBufferReturned(String).)
Public method OnRenderForm Returns a text only representation of the current game Windows state. Could be a statement, information, question waiting input, etc. (Overrides Form(TData).OnRenderForm().)
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 Form(TData).)
Public method SetForm Creates and adds the specified type of state to currently active game Windows. (Inherited from Form(TData).)
Public method ToString Returns a string that represents the current object. (Inherited from Form(TData).)
  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

See Also

Reference

InputForm(T) Class
WolfCurses.Form.Input Namespace

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