DebugInterface (com.github.ocraft:ocraft-s2client 0.2.6-SNAPSHOT API)

```
public interface DebugInterface
```
DebugInterface draws debug text, lines and shapes. Available at any time after the game starts. Guaranteed to be valid when the OnStep event is called. All debug actions are queued and dispatched when SendDebug is called. All drawn primitives continue to draw without resending until another SendDebug is called.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`DebugInterface`	`debugBoxOut(Point p0, Point p1, Color color)`	Outputs a box specified as two 3D points in the game world.
`DebugInterface`	`debugCreateUnit(UnitType unitType, Point2d p, int playerId, int count)`	Creates a unit at the given position.
`DebugInterface`	`debugCreateUnit(UnitType unitType, PointI p, int playerId, int count)`
`DebugInterface`	`debugEndGame(boolean victory)`	Ends a game.
`DebugInterface`	`debugEnemyControl()`	Enables commands to be issued to enemy units.
`DebugInterface`	`debugFastBuild()`	Structures and units are built much faster.
`DebugInterface`	`debugGiveAllResources()`	Gives a bunch of minerals and gas.
`DebugInterface`	`debugGiveAllTech()`	All tech becomes available.
`DebugInterface`	`debugGiveAllUpgrades()`	All upgrades are available.
`DebugInterface`	`debugGodMode()`	Makes the units of a player indestructible.
`DebugInterface`	`debugIgnoreFood()`	Disables the food check.
`DebugInterface`	`debugIgnoreMineral()`	Ignores mineral costs.
`DebugInterface`	`debugIgnoreResourceCost()`	Disables resource checks.
`DebugInterface`	`debugKillUnit(Unit unit)`	Destroy a unit.
`DebugInterface`	`debugLineOut(Point p0, Point p1, Color color)`	Outputs a line between two 3D points in the game world.
`DebugInterface`	`debugMoveCamera(Point pos)`	Sets the position of the camera.
`DebugInterface`	`debugMoveCamera(PointI pos)`
`DebugInterface`	`debugNoCooldowns()`	Cooldowns become instant.
`DebugInterface`	`debugSetEnergy(float value, Unit unit)`	Sets the energy level on a unit.
`DebugInterface`	`debugSetLife(float value, Unit unit)`	Sets the life on a unit.
`DebugInterface`	`debugSetScore(float score)`	Sets the scripted "curriculum" score.
`DebugInterface`	`debugSetShields(float value, Unit unit)`	Sets shields on a unit.
`DebugInterface`	`debugShowMap()`	Makes the entire map visible, i.e., removes the fog-of-war.
`DebugInterface`	`debugSphereOut(Point p, float r, Color color)`	Outputs a sphere specified as a 3D point in the game world and a radius.
`DebugInterface`	`debugTestApp(DebugTestProcess.Test appTest, int delayMs)`	Cause the game to fail; useful to test library behavior.
`DebugInterface`	`debugTextOut(java.lang.String out, Color color)`	Outputs text at the top, left of the screen.
`DebugInterface`	`debugTextOut(java.lang.String out, Point2d ptVirtual2d, Color color, int size)`	Outputs text at any 2D point on the screen.
`DebugInterface`	`debugTextOut(java.lang.String out, Point pt3d, Color color, int size)`	Outputs text at any 3D point in the game world.
`boolean`	`sendDebug()`	Dispatch all queued debug commands.

- Method Detail
  - debugTextOut
```
DebugInterface debugTextOut(java.lang.String out,
                            Color color)
```
    Outputs text at the top, left of the screen.
    
    Parameters:
    
    out - The string of text to display.
    
    color - (Optional) Color of the text.
  - debugTextOut
```
DebugInterface debugTextOut(java.lang.String out,
                            Point2d ptVirtual2d,
                            Color color,
                            int size)
```
    Outputs text at any 2D point on the screen. Coordinate ranges are 0..1 in X and Y.
    
    Parameters:
    
    out - The string of text to display.
    
    ptVirtual2d - The screen position to draw text at.
    
    color - (Optional) Color of the text.
    
    size - (Optional) Pixel height of the text.
  - debugTextOut
```
DebugInterface debugTextOut(java.lang.String out,
                            Point pt3d,
                            Color color,
                            int size)
```
    Outputs text at any 3D point in the game world. Map coordinates are used.
    
    Parameters:
    
    out - The string of text to display.
    
    pt3d - The world position to draw text at.
    
    color - (Optional) Color of the text.
    
    size - (Optional) Pixel height of the text.
  - debugLineOut
```
DebugInterface debugLineOut(Point p0,
                            Point p1,
                            Color color)
```
    Outputs a line between two 3D points in the game world. Map coordinates are used.
    
    Parameters:
    
    p0 - The starting position of the line.
    
    p1 - The ending position of the line.
    
    color - (Optional) Color of the line.
  - debugBoxOut
```
DebugInterface debugBoxOut(Point p0,
                           Point p1,
                           Color color)
```
    Outputs a box specified as two 3D points in the game world. Map coordinates are used.
    
    Parameters:
    
    p0 - One corner of the box.
    
    p1 - The far corner of the box.
    
    color - (Optional) Color of the lines.
  - debugSphereOut
```
DebugInterface debugSphereOut(Point p,
                              float r,
                              Color color)
```
    Outputs a sphere specified as a 3D point in the game world and a radius. Map coordinates are used.
    
    Parameters:
    
    p - Center of the sphere.
    
    r - Radius of the sphere.
    
    color - (Optional) Color of the lines.
  - debugCreateUnit
```
DebugInterface debugCreateUnit(UnitType unitType,
                               PointI p,
                               int playerId,
                               int count)
```
    See Also:
    
    debugCreateUnit(UnitType, Point2d, int, int)
  - debugCreateUnit
```
DebugInterface debugCreateUnit(UnitType unitType,
                               Point2d p,
                               int playerId,
                               int count)
```
    Creates a unit at the given position.
    
    Parameters:
    
    unitType - Type of unit to create.
    
    p - Position to create the unit at.
    
    playerId - Player the unit should belong to.
    
    count - Number of units to create.
  - debugKillUnit
```
DebugInterface debugKillUnit(Unit unit)
```
    Destroy a unit.
    
    Parameters:
    
    unit - Unit to destroy.
  - debugShowMap
```
DebugInterface debugShowMap()
```
    Makes the entire map visible, i.e., removes the fog-of-war.
  - debugEnemyControl
```
DebugInterface debugEnemyControl()
```
    Enables commands to be issued to enemy units.
  - debugIgnoreFood
```
DebugInterface debugIgnoreFood()
```
    Disables the food check.
  - debugIgnoreResourceCost
```
DebugInterface debugIgnoreResourceCost()
```
    Disables resource checks.
  - debugGiveAllResources
```
DebugInterface debugGiveAllResources()
```
    Gives a bunch of minerals and gas.
  - debugGodMode
```
DebugInterface debugGodMode()
```
    Makes the units of a player indestructible.
  - debugIgnoreMineral
```
DebugInterface debugIgnoreMineral()
```
    Ignores mineral costs.
  - debugNoCooldowns
```
DebugInterface debugNoCooldowns()
```
    Cooldowns become instant.
  - debugGiveAllTech
```
DebugInterface debugGiveAllTech()
```
    All tech becomes available.
  - debugGiveAllUpgrades
```
DebugInterface debugGiveAllUpgrades()
```
    All upgrades are available.
  - debugFastBuild
```
DebugInterface debugFastBuild()
```
    Structures and units are built much faster.
  - debugSetScore
```
DebugInterface debugSetScore(float score)
```
    Sets the scripted "curriculum" score.
  - debugEndGame
```
DebugInterface debugEndGame(boolean victory)
```
    Ends a game.
    
    Parameters:
    
    victory - If true, this player is victorious. If false, this player surrenders.
  - debugSetEnergy
```
DebugInterface debugSetEnergy(float value,
                              Unit unit)
```
    Sets the energy level on a unit.
    
    Parameters:
    
    value - The new energy level.
    
    unit - The unit.
  - debugSetLife
```
DebugInterface debugSetLife(float value,
                            Unit unit)
```
    Sets the life on a unit.
    
    Parameters:
    
    value - The new life.
    
    unit - The unit.
  - debugSetShields
```
DebugInterface debugSetShields(float value,
                               Unit unit)
```
    Sets shields on a unit.
    
    Parameters:
    
    value - The new shields.
    
    unit - The unit.
  - debugMoveCamera
```
DebugInterface debugMoveCamera(PointI pos)
```
    See Also:
    
    debugMoveCamera(Point)
  - debugMoveCamera
```
DebugInterface debugMoveCamera(Point pos)
```
    Sets the position of the camera.
    
    Parameters:
    
    pos - The camera position in world space.
  - debugTestApp
```
DebugInterface debugTestApp(DebugTestProcess.Test appTest,
                            int delayMs)
```
    Cause the game to fail; useful to test library behavior.
    
    Parameters:
    
    appTest - State to put the game into.
    
    delayMs - Time to elapse before invoking the game state.
  - sendDebug
```
boolean sendDebug()
```
    Dispatch all queued debug commands. No debug commands will be sent until this is called. This will also clear or set new debug primitives like text and lines.

Interface DebugInterface

Method Summary

Method Detail

debugTextOut

debugTextOut

debugTextOut

debugLineOut

debugBoxOut

debugSphereOut

debugCreateUnit

debugCreateUnit

debugKillUnit

debugShowMap

debugEnemyControl

debugIgnoreFood

debugIgnoreResourceCost

debugGiveAllResources

debugGodMode

debugIgnoreMineral

debugNoCooldowns

debugGiveAllTech

debugGiveAllUpgrades

debugFastBuild

debugSetScore

debugEndGame

debugSetEnergy

debugSetLife

debugSetShields

debugMoveCamera

debugMoveCamera

debugTestApp

sendDebug