Module rih

Function Index

destroy/1
init/2Initiates a robot by its player index number.
init/4Initiates a robot by its hostname, port number and index number.
init/5Initiates a robot by its hostname, port number and index number.
linit/2Initalise a list of robots.
linit/3Initiates a list of robots using a common configuration.
plinit/3initiates a list of robots in parallel.
plinit/4initiates a list of robots in parallel.

Function Details

destroy/1

destroy(Robotid) -> any()

init/2

init(DriverID::pid(), Index::integer()) -> RobotID::pid()

Initiates a robot by its player index number. The Robot ID is returned on successful initialisation.

init/4

init(DriverID::pid(), Hostname::string(), Port::integer(), Index::integer()) -> RobotID::pid()

Initiates a robot by its hostname, port number and index number. The Robot ID is returned on successful initialisation.

init/5

init(DriverID::pid(), Hostname::string(), Port::integer(), Index::integer(), Nickname::string()) -> RobotID::pid()

Initiates a robot by its hostname, port number and index number. The Robot ID is returned on successful initialisation. This function allows by passing the auto generation of the nickname used to identify the robot inside the driver. This name must be unique otherwise an error will be returned.

linit/2

linit(DriverID::pid(), Configs::list()) -> RobotID::list()

Initalise a list of robots. Due to function being synchronous it will take longer to initialise multiple robots. Each item can consist of either an index number of a tuples of any of the following: {Index} {Hostname, Port, Index} {Hostname, Port, Index, Nickname} A list of RobotIDs are returned.

linit/3

linit(Pid, Robots, AutoConf) -> any()

Initiates a list of robots using a common configuration. A list of RobotIDs are returned.

plinit/3

plinit(DriverID::pid(), Robots::list(), Config::list()) -> RobotID::pid()

initiates a list of robots in parallel. Returns a list of robots.

plinit/4

plinit(Caller::pid(), DriverID::pid(), Robots::list(), Config::list()) -> RobotID::pid()

initiates a list of robots in parallel. Passes the list of messages to the caller process.


Generated by EDoc, Aug 13 2009, 23:20:23.