API

An API (Application Programming Interface) describes how software programs can interact with a system. For a code package like Retro, the API provides a complete description of each class.

• Game
  • Game
    • Game.add_agent()
    • Game.end()
    • Game.get_agent_by_name()
    • Game.get_agents_by_position()
    • Game.is_empty()
    • Game.log()
    • Game.on_board()
    • Game.on_view()
    • Game.play()
    • Game.remove_agent()
    • Game.remove_agent_by_name()
    • Game.start()
    • Game.step()
  • agent_occupied_positions()
• Agent
  • Agent
    • Agent.position
    • Agent.character
    • Agent.name
    • Agent.color
    • Agent.display
    • Agent.z
    • Agent.size
    • Agent.handle_keystroke()
    • Agent.play_turn()
  • ArrowKeyAgent
    • ArrowKeyAgent.handle_keystroke()
    • ArrowKeyAgent.try_to_move()
  • CenterViewAgent
    • CenterViewAgent.margin
    • CenterViewAgent.center_view()
    • CenterViewAgent.distance_to_edge_of_view()
    • CenterViewAgent.needs_to_center_view()
  • Tombstone