FFXIVLIB  0.4.1
FFXIVLIB is a library designed to help creating 3rd party tools for FFXIV
 All Classes Namespaces Functions Variables Enumerations Properties Pages
Classes | Public Member Functions | List of all members
ffxivlib.MovementHelper Class Reference

Credits to FFACETOOLS. More...

Classes

struct  Coords
 

Public Member Functions

void GoToPos (float x, float y, float z)
 Heads to a given coordinate More...
 
void StartRecordingCoordinates (string filename=null, int delay=400)
 Starts a thread recording waypoint. More...
 
List< CoordsStopRecordingWaypoint ()
 Stops the recording of Waypoint and return the list of coordinates if you wish to process them. The waypoint is saved to file regardless. More...
 
void PlayWaypoint (string filename=null, List< Coords > list=null)
 Plays a pre-recorded waypoint file (XML) or a list of coordinates. It cannot handles both. More...
 
bool PauseWaypoint ()
 This pauses the playWaypoint thread. Sets pause to true or false depending on current value. More...
 

Detailed Description

Credits to FFACETOOLS.

Member Function Documentation

void ffxivlib.MovementHelper.GoToPos ( float  x,
float  y,
float  z 
)

Heads to a given coordinate

Parameters
xX
yY
zZ
bool ffxivlib.MovementHelper.PauseWaypoint ( )

This pauses the playWaypoint thread. Sets pause to true or false depending on current value.

Returns
Value of pause after this call.
void ffxivlib.MovementHelper.PlayWaypoint ( string  filename = null,
List< Coords list = null 
)

Plays a pre-recorded waypoint file (XML) or a list of coordinates. It cannot handles both.

Parameters
filenameFile to read waypoint from
listList of coordinates
void ffxivlib.MovementHelper.StartRecordingCoordinates ( string  filename = null,
int  delay = 400 
)

Starts a thread recording waypoint.

Parameters
filenameFilename to save waypoint to.
delayDelay in ms between coordinates (default: 400)
List<Coords> ffxivlib.MovementHelper.StopRecordingWaypoint ( )

Stops the recording of Waypoint and return the list of coordinates if you wish to process them. The waypoint is saved to file regardless.

Returns
List of coordinates

The documentation for this class was generated from the following file: