Changes between Version 12 and Version 13 of ProtocolOne


Ignore:
Timestamp:
Jun 10, 2011 10:20:04 AM (13 years ago)
Author:
jherwitz
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • ProtocolOne

    v12 v13  
    1 wiki:ProtocolOne is the Java API which abstracts the Quagents game engine to a simple Java interface. The underlying clientside structure maintains data transmission, reception, and storage, while providing an API of all possible Quagent actions. Currently implemented functions are described below. It is important to note that these functions mirror those defined in wiki:ProtocolZero, with slight syntactic differences. For all functions, a priority '1' indicates a "now" command and a priority "0" indicates a "then" command (this will change to a more intuitive format soon). All commands return the "commandid", which references the wiki:Command structure.
     1wiki:ProtocolOne is the Java API which abstracts the Quagents game engine to a simple Java interface. The underlying clientside structure maintains data transmission, reception, and storage, while providing an API of all possible Quagent actions. Currently implemented functions are described below. It is important to note that these functions mirror those defined in wiki:ProtocolZero, with slight syntactic differences. For all functions, a priority '1' indicates a "now" command and a priority "0" indicates a "then" command (this will change to a more intuitive format soon). All server commands and queries return the "commandid", which references the wiki:Command structure. Compound functions return values as specified.
    22
    33= Live Functions =
     
    3737  {{{canSee(int entityid, int priority)}}}
    3838   Returns true if entity can see specified ''wiki:entityid''. Also returns distance, yaw, and pitch to target.
     39  {{{facing(int priority)}}}
     40   Returns the Quagent's current direction vector.
    3941 '''wiki:ProtocolOne Actions (compound functions)'''
    40   {{{
     42  {{{rotateMove(double rot, double azi, double dist, double speed, int obstacles, int priority)}}}
     43   Rotates by ''rot''ational and ''azi''muthal angles to face a new direction, then moves in that direction for ''dist''.
     44  {{{rotateMove(double rot, double azi, double speed, int obstacles, int priority)}}}
     45   Rotates by 'rot' and 'azi' to face a new direction, then moves in that direction indefinitely.
     46  {{{rotateFireWeapon(double rot, double azi, int priority)}}}
     47   Rotates by 'rot' and 'azi' to face a new direction, then fires weapon.
     48  {{{moveFireWeapon(double dir, double dist, double speed, int obstacles, int priority)}}}
     49   Moves ''dist'' distance in the specified ''dir'' direction, then fires weapon.
     50  {{{findMaxiumumDirection(int priority)}}}
     51   Returns the deepest direction as detected by the type 1 wiki:rangefinder. This values is directly returned by the function.
     52  {{{faceMaximumDirection(int priority)}}}
     53   Finds the maximum direction, and then rotates to face it. Returns nothing
     54  {{{findEntityDirection(int entityid, int priority)}}}
     55   Directly returns the direction of the specified entityid. Returns -1 if nothing found.
     56  {{{faceEntityDirection(int entityid, int priority)}}}
     57   Finds the direction of specified entity, then rotates to face this direction.
     58  {{{showImage(int priority)}}}
     59   Displays a depth mapping representing the bot's current "sight".
     60 
    4161 
    4262= Example behaviors =