XanderFramework - Revision history

Skotty: /* Events */ updated notes for framework v3.0

2017-04-16T17:01:44Z

Events: updated notes for framework v3.0

Skotty: /* Events */

2017-04-16T16:58:50Z

Events

Skotty: /* Version 3.0 */ added some info on how robot focus works for events

2017-04-16T16:55:22Z

Version 3.0: added some info on how robot focus works for events

Skotty: Add some notes about different versions of the framework

2017-04-13T21:38:14Z

Add some notes about different versions of the framework

Skotty: /* Events */ Some v3.0 updates

2017-04-08T23:44:36Z

Events: Some v3.0 updates

Skotty: Updated with some framework v3.0 notes

2017-04-08T23:40:30Z

Updated with some framework v3.0 notes

Skotty: Various updates, add some code examples

2011-11-15T20:10:18Z

Various updates, add some code examples

Show changes

Skotty: /* Factor Array Processors */ minor update to reflect latest changes

2011-11-05T01:46:09Z

Factor Array Processors: minor update to reflect latest changes

Skotty: update some minor changes here and there

2011-10-01T19:23:58Z

update some minor changes here and there

Skotty: /* Drives */ a little more detail on the DirectWaveSurfingDrive

2011-09-16T19:15:32Z

Drives: a little more detail on the DirectWaveSurfingDrive

@@ Line 216: / Line 216: @@
 == Events ==
-Robocode issues a number of different events to the robot.  A Xander framework robot repackages these events and also provides other custom events, and makes those available to other components.  Xander robots can make use of the following events (v3.0):
+Robocode issues a number of different events to the robot.  A Xander framework robot repackages these events and also provides other custom events, and makes those available to other components.  Xander robots can make use of the following events accessed through the RobotEvents class (v3.0):
 {| border="1" cellpadding="4"
 ! Listener Class
-! Events Issued By (Register With)
+! Opponent Focusable?
 ! Purpose
 |-
 | BulletHitListener
-| RobotEvents
+| Yes
 | Repackages Robocode events onHitByBullet, onBulletHit, onBulletMissed, and onBulletHitBullet
 |-
 | CollisionListener
-| RobotEvents
+| No
 | Repackages Robocode events onHitRobot and onHitWall
 |-
 | WaveListener
-| RobotEvents
+| Yes
 | Handles events related to a robot's bullet waves.  The WaveHistory stores two sets of WaveListeners, one for actual bullet waves, and one for virtual bullet waves.  If listening for both, you can tell the difference between the two by the Wave method isVirtual().
 |-
 | Painter
-| RobotEvents
+| No
 | Repackages Robocode event onPaint, allowing other components to paint on the battlefield
 |-
 | RoundBeginListener
-| RobotEvents
+| No
 | Handler for a single event that fires at the beginning of every round.  Can be used to initialize variables when a round begins.
 |-
 | RoundListener
-| RobotEvents
+| No
 | Repackages Robocode events onRoundEnd and onBattleEnd
 |-
 | ScannedRobotListener
-| RobotEvents
+| Yes
 | Repackages Robocode event onScannedRobot
 |-
 | SurvivalListener
-| RobotEvents
+| Yes
 | Repackages Robocode events onWin, onDeath, and onRobotDeath
 |-
 | TurnListener
-| RobotEvents
+| No
 | Handler for events that fire on every iteration of the AbstractXanderRobot main processing loop.  One event that fires at the beginning of a turn, and one event that fires at the end of a turn immediately before execute() is called.
 |}

@@ Line 216: / Line 216: @@
 == Events ==
-Robocode issues a number of different events to the robot.  A Xander framework robot repackages these events and also provides other custom events, and makes those available to other components.  Xander robots can make use of the following events:
+Robocode issues a number of different events to the robot.  A Xander framework robot repackages these events and also provides other custom events, and makes those available to other components.  Xander robots can make use of the following events (v3.0):
 {| border="1" cellpadding="4"
 ! Listener Class
@@ Line 231: / Line 231: @@
 |-
 | WaveListener
-| WaveHistory
+| RobotEvents
 | Handles events related to a robot's bullet waves.  The WaveHistory stores two sets of WaveListeners, one for actual bullet waves, and one for virtual bullet waves.  If listening for both, you can tell the difference between the two by the Wave method isVirtual().
 |-

← Older revision		Revision as of 16:55, 16 April 2017
Line 30:		Line 30:

	The main framework components that will now have 1 for every robot (including self) include the SnapshotHistory, WaveHistory, and GunStats components.		The main framework components that will now have 1 for every robot (including self) include the SnapshotHistory, WaveHistory, and GunStats components.
		+
		+	Any listeners for robot specific components (anything that implements WaveListener, ScannedRobotListener, etc) must now implement an additional method getOpponentFocus() that tells the framework what robots to associate the component with. Focus options include:
		+	* ALL_ROBOTS: Component will receive events for all robots.
		+	* TARGETED_ROBOT: Component will only receive events from the currently targeted robot (the targeted robot determined by what your radar is returning).
		+	* SPECIFIC_ROBOT_SCANNED: Component will only receive events for one specific robot. That robot will be the last scanned robot at time listener is added, or the next scanned robot if there is no last scanned robot.
		+	* SPECIFIC_ROBOT_TARGETED: Component will only receive events for one specific robot. That robot will be the last targeted robot at time listener is added, or the next targeted robot if there is no current target.

	== Base Robot Class ==		== Base Robot Class ==

@@ Line 12: / Line 12: @@
 *  Reduced code size.
 *  Improved performance.
 == Base Robot Class ==

@@ Line 206: / Line 206: @@
 | Repackages Robocode events onHitRobot and onHitWall
 |-
-| MyWaveListener
+| WaveListener
 | WaveHistory
-| Handles events related to the robot's own bullet waves.  Actual bullets only.
+| Handles events related to a robot's bullet waves.  The WaveHistory stores two sets of WaveListeners, one for actual bullet waves, and one for virtual bullet waves.  If listening for both, you can tell the difference between the two by the Wave method isVirtual().
 |-
 | Painter

@@ Line 6: / Line 6: @@
 Guns, radars, and drives must use the corresponding framework interfaces and can make use of a variety of framework resources and events.
 == Base Robot Class ==
@@ Line 63: / Line 69: @@
 === DriveStats ===
-Statistics related to the drives, such as drive time usage.
+Statistics related to the drives of your robot, such as drive time usage.
 === GunStats ===
-Statistics related to the guns, including hit ratios and virtual gun hit ratios.
+Statistics related to the guns, including hit ratios and virtual gun hit ratios.  As of v3.0, one GunStats will be created for each robot in the battle.
 === RobotEvents ===
@@ Line 75: / Line 81: @@
 === SnapshotHistory ===
-Robot history is available through the '''SnapshotHistory'''.  Robot history for a particular point in time is stored in a ''snapshot'' via the '''Snapshot''' class, an immutable snapshot of a robot at a particular point in time.
+Robot history is available through the '''SnapshotHistory'''.  Robot history for a particular point in time is stored in a ''snapshot'' via the '''Snapshot''' class, an immutable snapshot of a robot at a particular point in time.  As of v3.0, One SnapshotHistory will be created for each robot in the battle.
 Each turn, a Xander robot takes a new snapshot for itself and stores it in the history.  Each scan, a new snapshot for the scanned robot is generated and stored in the history.  Robot history allows the robot to look back at snapshots of itself and it's opponents back a set number of turns and scans.
 === WaveHistory ===
-History of all bullet waves (for both self and opponent).
+History of all bullet waves.  As of v3.0, one WaveHistory is created for each robot.
 == Controllers ==
@@ Line 314: / Line 320: @@
 *  '''WallSmoothingSegmenter''' - segments on whether it appears defender will have to wall smooth clockwise, counter-clockwise, both directions (in corner), or not at all.
 *  '''WallStickSegmenter''' - segments on opponent distance to wall in the forward or reverse direction of the defenders current direction.
 == Utilities ==

@@ Line 214: / Line 214: @@
 == Factor Array Processors ==
-A ''factor array processor'', defined by the '''FactorArrayProcessor''' interface, is responsible for logging data and providing factor arrays for waves based on that data.
+A ''factor array processor'', defined by the '''FactorArrayProcessor''' interface, is responsible providing factor arrays for waves.  Originally, they were also meant to handle logging wave data, but some of the latest implementations let other classes handle logging data.
-The '''AbstractFactorArrayProcessor''' provides a basic implementation of this interface designed to work in both guess factor guns and and wave surfing drives.
+The '''AbstractFactorArrayProcessor''' provides a basic implementation of this interface designed to work in both guess factor guns and and wave surfing drives.  This is an older implementation that is intended to handle logging data in addition to building factor arrays.
 == Distributers ==

@@ Line 42: / Line 42: @@
 *  void configure(Configuration) - allows basic configuration of the robot to be changed
 *  void style(RobotStyle) - allows setting styling options like robot colors
 == Components / Component Chain ==
@@ Line 90: / Line 91: @@
 == Drive ==
 Drives must implement the '''Drive''' interface.
 == Gun ==
@@ Line 246: / Line 251: @@
 == Drives ==
-The '''DirectWaveSurfingDrive''' (named '''DWaveSurfingDrive''' in v9.3 of XanderCat) class provides the basic implementation for a ''direct'' wave surfing drive, relying on a ''direcct surf selector'' to choose the factor angle and direct heading to use for each wave.  Surf selectors are defined by the '''DirectSurfSelector''' interface.
+The '''DirectWaveSurfingDrive''' (named '''DWaveSurfingDrive''' in v9.3 of XanderCat) class provides the basic implementation for a ''direct'' wave surfing drive, relying on a ''direct surf selector'' to choose the factor angle and direct heading to use for each wave.  Surf selectors are defined by the '''DirectSurfSelector''' interface.
-As of this writing, this drive only surfs the next wave to hit.  It is a Go-To style wave surfing drive, but will reprocess where to go on the same wave under the following situations:
+This drive is capable of surfing 2 waves at once, though only surfs a single wave by default.  It is a Go-To style wave surfing drive, but will reprocess where to go on the same wave under the following situations:
-*  when surf waveis  updated (such as when a newly fired bullet creates new bullet shadows)
+*  when surf wave is updated (such as when a newly fired bullet creates new bullet shadows)
 *  when opponent position deviates significantly from prediction.  This is done primarily for the sake of distancing.

← Older revision		Revision as of 19:15, 16 September 2011
Line 247:		Line 247:

	The '''DirectWaveSurfingDrive''' (named '''DWaveSurfingDrive''' in v9.3 of XanderCat) class provides the basic implementation for a ''direct'' wave surfing drive, relying on a ''direcct surf selector'' to choose the factor angle and direct heading to use for each wave. Surf selectors are defined by the '''DirectSurfSelector''' interface.		The '''DirectWaveSurfingDrive''' (named '''DWaveSurfingDrive''' in v9.3 of XanderCat) class provides the basic implementation for a ''direct'' wave surfing drive, relying on a ''direcct surf selector'' to choose the factor angle and direct heading to use for each wave. Surf selectors are defined by the '''DirectSurfSelector''' interface.
		+
		+	As of this writing, this drive only surfs the next wave to hit. It is a Go-To style wave surfing drive, but will reprocess where to go on the same wave under the following situations:
		+	* when surf waveis updated (such as when a newly fired bullet creates new bullet shadows)
		+	* when opponent position deviates significantly from prediction. This is done primarily for the sake of distancing.

	The xander.gfws package does not provide any surf selector implementations. However, XanderCat 9.3+ uses a surf selector named '''GreenBeeSurfSelector''' which other surf selectors might be modeled from. It uses a ''factor array processor'' for managing the drive data, along with a '''DirectDrivePredictor''' and '''DistancingEquation''' from the Xander core classes to aid in choosing what direction to move in.		The xander.gfws package does not provide any surf selector implementations. However, XanderCat 9.3+ uses a surf selector named '''GreenBeeSurfSelector''' which other surf selectors might be modeled from. It uses a ''factor array processor'' for managing the drive data, along with a '''DirectDrivePredictor''' and '''DistancingEquation''' from the Xander core classes to aid in choosing what direction to move in.