Skip to content
/ docs Public

add whitespace for better readability in battlesnake.md #58

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bvanvugt merged 1 commit into from
Jun 24, 2025
Merged

add whitespace for better readability in battlesnake.md #58

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions docs/api/03-objects/battlesnake.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,13 @@ sidebar_position: 4

| **Property** | **Type** | **Description** |
| ------------------ | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **id** | string | Unique identifier for this Battlesnake in the context of the current Game.<em>Example: "totally-unique-snake-id"</em> |
| **name** | string | Name given to this Battlesnake by its author.<em>Example: "Sneky McSnek Face"</em> |
| **health** | integer | Health value of this Battlesnake, between 0 and 100 inclusively.<em>Example: 54</em> |
| **body** | array | Array of coordinates representing this Battlesnake's location on the game board. This array is ordered from head to tail.<em>Example: [{"x": 0, "y": 0}, ..., {"x": 2, "y": 0}]</em> |
| **latency** | string | The previous response time of this Battlesnake, in milliseconds. If the Battlesnake timed out and failed to respond, the game timeout will be returned (<code>game.timeout</code>)<em>Example: "500"</em> |
| **head** | object | Coordinates for this Battlesnake's head. Equivalent to the first element of the body array.<em>Example: {"x": 0, "y": 0}</em> |
| **length** | integer | Length of this Battlesnake from head to tail. Equivalent to the length of the body array.<em>Example: 3</em> |
| **shout** | string | Message shouted by this Battlesnake on the previous turn.<em>Example: "why are we shouting??"</em> |
| **squad** | string | The squad that the Battlesnake belongs to. Used to identify squad members in Squad Mode games.<em>Example: "1"</em> |
| **id** | string | Unique identifier for this Battlesnake in the context of the current Game. <em>Example: "totally-unique-snake-id"</em> |
| **name** | string | Name given to this Battlesnake by its author. <em>Example: "Sneky McSnek Face"</em> |
| **health** | integer | Health value of this Battlesnake, between 0 and 100 inclusively. <em>Example: 54</em> |
| **body** | array | Array of coordinates representing this Battlesnake's location on the game board. This array is ordered from head to tail. <em>Example: [{"x": 0, "y": 0}, ..., {"x": 2, "y": 0}]</em> |
| **latency** | string | The previous response time of this Battlesnake, in milliseconds. If the Battlesnake timed out and failed to respond, the game timeout will be returned (<code>game.timeout</code>) <em>Example: "500"</em> |
| **head** | object | Coordinates for this Battlesnake's head. Equivalent to the first element of the body array. <em>Example: {"x": 0, "y": 0}</em> |
| **length** | integer | Length of this Battlesnake from head to tail. Equivalent to the length of the body array. <em>Example: 3</em> |
| **shout** | string | Message shouted by this Battlesnake on the previous turn. <em>Example: "why are we shouting??"</em> |
| **squad** | string | The squad that the Battlesnake belongs to. Used to identify squad members in Squad Mode games. <em>Example: "1"</em> |
| **customizations** | object | The collection of customizations that control how this Battlesnake is displayed. _Example: {"color":"#888888", "head":"default", "tail":"default" }_ |