C# Class Eryan.Script.Scriptable

Scriptable interface must be implemented by all Eryan scripts
Show file Open project: emist/Eryan Class Usage Examples

Public Properties

Property Type Description
EAgentHandler Eryan.InputHandler.AgentHandler
ECamera Eryan.InputHandler.Camera
ECommunicator Eryan.IPC.Communicator
EDrawingArea Eryan.Util.DrawableScreen
EKeyboard Eryan.Input.KeyBoard
ELocalHandler Eryan.InputHandler.LocalHandler
ELogger Util.Logger
EMenuHandler Eryan.InputHandler.MenuHandler
EMouse Eryan.Input.Mouse
EOverViewHandler OverviewHandler
EPreciseMouse Eryan.Input.PreciseMouse
ERandom System.Random
ESession Eryan.Wrappers.Session
EStationHandler Eryan.Wrappers.Station
MyShip Eryan.Wrappers.Ship
enabled bool

Protected Properties

Property Type Description
name string

Public Methods

Method Description
initializeInputs ( WindowHandler bot ) : void

Internal use, the Bot will initialize the script with its input handlers once its loaded into memory
onFinish ( ) : System.Boolean

Script's cleanup code
onStart ( ) : System.Boolean

To be used by the script to initialize its state variables
run ( ) : int

The main loop for scripts

Method Details

initializeInputs() public method

Internal use, the Bot will initialize the script with its input handlers once its loaded into memory
public initializeInputs ( WindowHandler bot ) : void
bot Eryan.UI.WindowHandler The reference to the bot's windowhandler
return void

onFinish() public abstract method

Script's cleanup code
public abstract onFinish ( ) : System.Boolean
return System.Boolean

onStart() public abstract method

To be used by the script to initialize its state variables
public abstract onStart ( ) : System.Boolean
return System.Boolean

run() public abstract method

The main loop for scripts
public abstract run ( ) : int
return int

Property Details

EAgentHandler public property

The script's agent handler
public AgentHandler,Eryan.InputHandler EAgentHandler
return Eryan.InputHandler.AgentHandler

ECamera public property

Reference to this bot's camera handler
public Camera,Eryan.InputHandler ECamera
return Eryan.InputHandler.Camera

ECommunicator public property

Bot's communicator reference
public Communicator,Eryan.IPC ECommunicator
return Eryan.IPC.Communicator

EDrawingArea public property

The bot's drawing area
public DrawableScreen,Eryan.Util EDrawingArea
return Eryan.Util.DrawableScreen

EKeyboard public property

Reference to this bot's keyboard
public KeyBoard,Eryan.Input EKeyboard
return Eryan.Input.KeyBoard

ELocalHandler public property

This bot's local chat handler
public LocalHandler,Eryan.InputHandler ELocalHandler
return Eryan.InputHandler.LocalHandler

ELogger public property

The scripts Logging engine
public Util.Logger ELogger
return Util.Logger

EMenuHandler public property

Bot's MenuHandler reference
public MenuHandler,Eryan.InputHandler EMenuHandler
return Eryan.InputHandler.MenuHandler

EMouse public property

Bot's Mouse handler
public Mouse,Eryan.Input EMouse
return Eryan.Input.Mouse

EOverViewHandler public property

Bot's OverViewHandler reference
public OverviewHandler EOverViewHandler
return OverviewHandler

EPreciseMouse public property

Bot's PreciseMouse reference
public PreciseMouse,Eryan.Input EPreciseMouse
return Eryan.Input.PreciseMouse

ERandom public property

Random generator for script use
public Random,System ERandom
return System.Random

ESession public property

Reference to our current eve session
public Session,Eryan.Wrappers ESession
return Eryan.Wrappers.Session

EStationHandler public property

Reference to the bot's station handler
public Station,Eryan.Wrappers EStationHandler
return Eryan.Wrappers.Station

MyShip public property

Reference to our player's ship
public Ship,Eryan.Wrappers MyShip
return Eryan.Wrappers.Ship

enabled public property

Is the script enabled
public bool enabled
return bool

name protected property

The script name
protected string name
return string