Documentation
¶
Index ¶
Constants ¶
const ( // MinCols Define the min number of cols allowed on the field division by the Map MinCols int = 4 // MinRows Define the min number of rows allowed on the field division by the Map MinRows int = 2 // MaxCols Define the max number of cols allowed on the field division by the Map MaxCols int = 200 // MaxRows Define the max number of rows allowed on the field division by the Map MaxRows int = 100 )
Variables ¶
var ( // ErrMinCols defines an error for invalid number of cols ErrMinCols = errors.New("number of cols lower the minimum") // ErrMaxCols defines an error for invalid number of cols ErrMaxCols = errors.New("number of cols higher the maximum") // ErrMinRows defines an error for invalid number of rows ErrMinRows = errors.New("number of rows lower the minimum") // ErrMaxRows defines an error for invalid number of rows ErrMaxRows = errors.New("number of rows higher the maximum") )
var ( North = Orientation(proto.North()) South = Orientation(proto.South()) East = Orientation(proto.East()) West = Orientation(proto.West()) NorthEast = Orientation(proto.NorthEast()) SouthEast = Orientation(proto.SouthEast()) NorthWest = Orientation(proto.NorthWest()) SouthWest = Orientation(proto.SouthWest()) )
Functions ¶
func FieldCenter ¶
Types ¶
type Goal ¶
type Goal struct {
// Center the is coordinate of the center of the goal
Center proto.Point
// Place identifies the team of this goal (the team that should defend this goal)
Place proto.Team_Side
// TopPole is the coordinates of the pole with a higher Y coordinate
TopPole proto.Point
// BottomPole is the coordinates of the pole with a lower Y coordinate
BottomPole proto.Point
}
Goal is a set of value about a goal from a team
func AwaySideTeamGoal ¶
func AwaySideTeamGoal() Goal
func HomeSideTeamGoal ¶
func HomeSideTeamGoal() Goal
type Map ¶
func (*Map) GetAttackGoal ¶
func (*Map) GetDefenseGoal ¶
func (*Map) GetMyTeamSide ¶
func (*Map) GetOpponentSide ¶
type Mapper ¶
type Mapper interface {
// GetRegion Returns a MapArea based on the coordinates and on the current field division
GetRegion(col, row int) (Region, error)
// GetPointRegion returns the MapArea where that point is in
GetPointRegion(point *proto.Point) (Region, error)
GetDefenseGoal() Goal
GetAttackGoal() Goal
GetMyTeamSide() proto.Team_Side
GetOpponentSide() proto.Team_Side
}
Mapper Helps the bots to see the fields from their team perspective instead of using the cartesian plan provided by the game server. Instead of base your logic on the axes X and Y, the Map create a MapArea map based on the team side. The MapArea coordinates uses the defensive field's right corner as its origin. This mechanism if specially useful to define players regions based on their roles, since you do not have to mirror the coordinate, neither do extra logic to define regions on the field where the player should be.
type Orientation ¶
type Region ¶
type Region interface {
fmt.Stringer
// Col The col coordinate based on the field division
Col() int
// Row The row coordinate based on the field division
Row() int
// Center Return the point at the center of the quadrant represented by this Region. It is not always precise.
Center() *proto.Point
// Front is the MapArea immediately in front of this one from the player perspective
// Important: The same MapArea is returned if the requested MapArea is not valid
Front() Region
// Back is the MapArea immediately behind this one from the player perspective
// Important: The same MapArea is returned if the requested MapArea is not valid
Back() Region
// Left is the MapArea immediately on left of this one from the player perspective
// Important: The same MapArea is returned if the requested MapArea is not valid
Left() Region
// Right is the MapArea immediately on right of this one from the player perspective
// Important: The same MapArea is returned if the requested MapArea is not valid
Right() Region
// Eq does not check if the passed region is on a map of same size!
Eq(region Region) bool
}
Region represent a quadrant on the field. It is not always squared form because you may define how many cols/rows the field will be divided in. So, based on that division (e.g. 4 rows, 6 cols) there will be a fixed number of regions and their coordinates will be zero-index (e.g. from 0 to 3 rows when divided in 4 rows).
Source Files