C# Class FFACETools.FFACE.WindowerTools

Wrapper class for sending Windower commands through FFACE
Show file Open project: golfandsurf/Campah Class Usage Examples

Private Properties

Property Type Description

Public Methods

Method Description
ArgumentCount ( ) : short

Get the amount of arguments the windower console has

BlockInput ( bool block ) : void

Whether to block input to ffxi

CreateTextObject ( ) : TextObject

Will create a Windower text object

GetArgument ( short index ) : string

Gets a specific argument from the windower console

IsNewCommand ( ) : int

Time of the last command NOTE: This may still be bugged (always returns true) See Windower wiki/forums for details

SendKey ( KeyCode key, bool down ) : void

Sends a key stroke status to FFXi

SendKeyPress ( KeyCode key ) : void

Sends a key press to FFXi (up, then down)

SendString ( string stringToSend ) : void

Sends a string to FFXi

WindowerTools ( int instanceID ) : System

Constructor

Method Details

ArgumentCount() public method

Get the amount of arguments the windower console has
public ArgumentCount ( ) : short
return short

BlockInput() public method

Whether to block input to ffxi
public BlockInput ( bool block ) : void
block bool True if blocking
return void

CreateTextObject() public method

Will create a Windower text object
public CreateTextObject ( ) : TextObject
return TextObject

GetArgument() public method

Gets a specific argument from the windower console
public GetArgument ( short index ) : string
index short Index of the argument to get
return string

IsNewCommand() public method

Time of the last command NOTE: This may still be bugged (always returns true) See Windower wiki/forums for details
public IsNewCommand ( ) : int
return int

SendKey() public method

Sends a key stroke status to FFXi
public SendKey ( KeyCode key, bool down ) : void
key KeyCode Key to send
down bool True if keypress is down, false for up
return void

SendKeyPress() public method

Sends a key press to FFXi (up, then down)
public SendKeyPress ( KeyCode key ) : void
key KeyCode Key to send
return void

SendString() public method

Sends a string to FFXi
public SendString ( string stringToSend ) : void
stringToSend string string to send
return void

WindowerTools() public method

Constructor
public WindowerTools ( int instanceID ) : System
instanceID int Instance ID generated by FFACE
return System