Commit cfd6bd3d authored by Hubert Denkmair's avatar Hubert Denkmair
Browse files

Merge branch 'branch/docs' into 'master'

New docs and doc styles

See merge request GPN18Programmierspiel/website!8
parents 40e34f45 5f278572
......@@ -17,11 +17,35 @@
border: none;
}
.markdown-body code,
.markdown-body tt {
color: white;
background-color: #333;
}
.markdown-body dl dt {
font-size: 1.2em;
}
table thead tr td {
background: rgb(0,0,0,.50);
background: #000;
font-weight: 700;
}
\ No newline at end of file
}
.markdown-body table tr {
background-color: #1a1a1a;
}
.markdown-body table tr:nth-child(2n) {
background-color: #242424;
}
th,
.markdown-body table td {
border-color: #303030;
}
.markdown-body a {
color: white;
text-decoration: underline;
}
......@@ -12,4 +12,8 @@
Jeder kann mitmachen! Einfach einen Account erstellen und losprogrammieren!
</p>
<p>
Erstelle dir deine eigene Schlange in Lua, fress dich voll und kollidiere nicht mit anderen.
</p>
{% endblock %}
\ No newline at end of file
--- This is a brief overview of all usable functions within the bot logic.
--- Every bot is allowed to store 100MB within the global namespace and the
--- data persists until the bot dies. So the bot can save data from frame
--- to frame.
--- Every player can start with a simple demo bot. You get the code in the
--- <a href="/snake/edit/latest">editor</a>. A snake hungers, so it constantly
--- loses size. Feed it and it will stay alive and grows. Your snake will die,
--- when it touches another snake with its head.
---
--- <h2>Lua global namespace</h2>
--- <p>Every snake is allowed to store 100MB within the global namespace and the
--- data persists until the bot dies. So the bot can save data from frame
--- to frame.</p>
--- <p>The following Lua standard functions are allowed:</p>
--- <p><a href="http://pgl.yoyo.org/luai/i/assert">assert</a>,
--- <a href="http://pgl.yoyo.org/luai/i/print">print</a>,
--- <a href="http://pgl.yoyo.org/luai/i/ipairs">ipairs</a>,
--- <a href="http://pgl.yoyo.org/luai/i/error">error</a>,
--- <a href="http://pgl.yoyo.org/luai/i/next">next</a>,
--- <a href="http://pgl.yoyo.org/luai/i/pairs">pairs</a>,
--- <a href="http://pgl.yoyo.org/luai/i/pcall">pcall</a>,
--- <a href="http://pgl.yoyo.org/luai/i/select">select</a>,
--- <a href="http://pgl.yoyo.org/luai/i/tonumber">tonumber</a>,
--- <a href="http://pgl.yoyo.org/luai/i/tostring">tostring</a>,
--- <a href="http://pgl.yoyo.org/luai/i/type">type</a>,
--- <a href="http://pgl.yoyo.org/luai/i/unpack">unpack</a>,
--- <a href="http://pgl.yoyo.org/luai/i/_VERSION">_VERSION</a>,
--- <a href="http://pgl.yoyo.org/luai/i/xpcall">xpcall</a></p>
--- <table>
--- <tr><td><a href="https://www.lua.org/manual/5.3/manual.html#pdf-assert">assert</a></td>
--- <td><a href="https://www.lua.org/manual/5.3/manual.html#pdf-print">print</a></td>
--- <td><a href="https://www.lua.org/manual/5.3/manual.html#pdf-ipairs">ipairs</a></td>
--- <td><a href="https://www.lua.org/manual/5.3/manual.html#pdf-error">error</a></td>
--- <td><a href="https://www.lua.org/manual/5.3/manual.html#pdf-next">next</a></td>
--- <td><a href="https://www.lua.org/manual/5.3/manual.html#pdf-pairs">pairs</a></td>
--- <td><a href="https://www.lua.org/manual/5.3/manual.html#pdf-pcall">pcall</a></td></tr>
--- <tr><td><a href="https://www.lua.org/manual/5.3/manual.html#pdf-select">select</a></td>
--- <td><a href="https://www.lua.org/manual/5.3/manual.html#pdf-tonumber">tonumber</a>,
--- <td><a href="https://www.lua.org/manual/5.3/manual.html#pdf-tostring">tostring</a></td>
--- <td><a href="https://www.lua.org/manual/5.3/manual.html#pdf-type">type</a></td>
--- <td><a href="https://www.lua.org/manual/5.3/manual.html#pdf-unpack">unpack</a></td>
--- <td><a href="https://www.lua.org/manual/5.3/manual.html#pdf-_VERSION">_VERSION</a></td>
--- <td><a href="https://www.lua.org/manual/5.3/manual.html#pdf-xpcall">xpcall</a></td></tr></table>
--- <p>From the module <code>math</code> you can use:</p>
--- <p><a href="http://pgl.yoyo.org/luai/i/math.abs">abs</a>,
--- <a href="http://pgl.yoyo.org/luai/i/math.acos">acos</a>,
--- <a href="http://pgl.yoyo.org/luai/i/math.asin">asin</a>,
--- <a href="http://pgl.yoyo.org/luai/i/math.atan">atan</a>,
--- <a href="http://pgl.yoyo.org/luai/i/math.atan2">atan2</a>,
--- <a href="http://pgl.yoyo.org/luai/i/math.ceil">ceil</a>,
--- <a href="http://pgl.yoyo.org/luai/i/math.cos">cos</a>,
--- <a href="http://pgl.yoyo.org/luai/i/math.cosh">cosh</a>,
--- <a href="http://pgl.yoyo.org/luai/i/math.deg">deg</a>,
--- <a href="http://pgl.yoyo.org/luai/i/math.exp">exp</a>,
--- <a href="http://pgl.yoyo.org/luai/i/math.floor">floor</a>,
--- <a href="http://pgl.yoyo.org/luai/i/math.fmod">fmod</a>,
--- <a href="http://pgl.yoyo.org/luai/i/math.frexp">frexp</a>,
--- <a href="http://pgl.yoyo.org/luai/i/math.huge">huge</a>,
--- <a href="http://pgl.yoyo.org/luai/i/math.ldexp">ldexp</a>,
--- <a href="http://pgl.yoyo.org/luai/i/math.log">log</a>,
--- <a href="http://pgl.yoyo.org/luai/i/math.log10">log10</a>,
--- <a href="http://pgl.yoyo.org/luai/i/math.max">max</a>,
--- <a href="http://pgl.yoyo.org/luai/i/math.min">min</a>,
--- <a href="http://pgl.yoyo.org/luai/i/math.modf">modf</a>,
--- <a href="http://pgl.yoyo.org/luai/i/math.pi">pi</a>,
--- <a href="http://pgl.yoyo.org/luai/i/math.pow">pow</a>,
--- <a href="http://pgl.yoyo.org/luai/i/math.rad">rad</a>,
--- <a href="http://pgl.yoyo.org/luai/i/math.random">random</a>,
--- <a href="http://pgl.yoyo.org/luai/i/math.randomseed">randomseed</a>,
--- <a href="http://pgl.yoyo.org/luai/i/math.sin">sin</a>,
--- <a href="http://pgl.yoyo.org/luai/i/math.sinh">sinh</a>,
--- <a href="http://pgl.yoyo.org/luai/i/math.sqrt">sqrt</a>,
--- <a href="http://pgl.yoyo.org/luai/i/math.tan">tan</a>,
--- <a href="http://pgl.yoyo.org/luai/i/math.tanh">tanh</a></p>
--- <table><tr><td><a href="https://www.lua.org/manual/5.3/manual.html#pdf-math.abs">abs</a></td>
--- <td><a href="https://www.lua.org/manual/5.3/manual.html#pdf-math.acos">acos</a></td>
--- <td><a href="https://www.lua.org/manual/5.3/manual.html#pdf-math.asin">asin</a></td>
--- <td><a href="https://www.lua.org/manual/5.3/manual.html#pdf-math.atan">atan</a></td>
--- <td><a href="https://www.lua.org/manual/5.3/manual.html#pdf-math.ceil">ceil</a></td>
--- <td><a href="https://www.lua.org/manual/5.3/manual.html#pdf-math.cos">cos</a></td>
--- <td><a href="https://www.lua.org/manual/5.3/manual.html#pdf-math.deg">deg</a></td></tr>
--- <tr><td><a href="https://www.lua.org/manual/5.3/manual.html#pdf-math.exp">exp</a></td>
--- <td><a href="https://www.lua.org/manual/5.3/manual.html#pdf-math.floor">floor</a></td>
--- <td><a href="https://www.lua.org/manual/5.3/manual.html#pdf-math.fmod">fmod</a></td>
--- <td><a href="https://www.lua.org/manual/5.3/manual.html#pdf-math.frexp">frexp</a></td>
--- <td><a href="https://www.lua.org/manual/5.3/manual.html#pdf-math.huge">huge</a></td>
--- <td><a href="https://www.lua.org/manual/5.3/manual.html#pdf-math.log">log</a></td>
--- <td><a href="https://www.lua.org/manual/5.3/manual.html#pdf-math.max">max</a></td></tr>
--- <tr><td><a href="https://www.lua.org/manual/5.3/manual.html#pdf-math.min">min</a></td>
--- <td><a href="https://www.lua.org/manual/5.3/manual.html#pdf-math.modf">modf</a></td>
--- <td><a href="https://www.lua.org/manual/5.3/manual.html#pdf-math.pi">pi</a></td>
--- <td><a href="https://www.lua.org/manual/5.3/manual.html#pdf-math.pow">pow</a></td>
--- <td><a href="https://www.lua.org/manual/5.3/manual.html#pdf-math.rad">rad</a></td>
--- <td><a href="https://www.lua.org/manual/5.3/manual.html#pdf-math.random">random</a></td>
--- <td><a href="https://www.lua.org/manual/5.3/manual.html#pdf-math.randomseed">randomseed</a></td></tr>
--- <tr><td><a href="https://www.lua.org/manual/5.3/manual.html#pdf-math.sin">sin</a></td>
--- <td><a href="https://www.lua.org/manual/5.3/manual.html#pdf-math.sqrt">sqrt</a></td>
--- <td><a href="https://www.lua.org/manual/5.3/manual.html#pdf-math.tan">tan</a></td></tr></table>
--- <p>From the module <code>os</code> you can use:</p>
--- <p><a href="http://pgl.yoyo.org/luai/i/os.clock">clock</a>,
--- <a href="http://pgl.yoyo.org/luai/i/os.difftime">difftime</a>,
--- <a href="http://pgl.yoyo.org/luai/i/os.time">time</a></p>
--- <table><tr><td><a href="https://www.lua.org/manual/5.3/manual.html#pdf-os.clock">clock</a></td>
--- <td><a href="https://www.lua.org/manual/5.3/manual.html#pdf-os.difftime">difftime</a></td>
--- <td><a href="https://www.lua.org/manual/5.3/manual.html#pdf-os.time">time</a></td></tr></table>
--- <p>From the module <code>table</code> you can use:</p>
--- <a href="http://pgl.yoyo.org/luai/i/table.maxn">maxn</a>,
--- <a href="http://pgl.yoyo.org/luai/i/table.insert">insert</a>,
--- <a href="http://pgl.yoyo.org/luai/i/table.remove">remove</a>,
--- <a href="http://pgl.yoyo.org/luai/i/table.sort">sort</a></p>
--- <table><tr><td><a href="https://www.lua.org/manual/5.3/manual.html#pdf-table.insert">insert</a></td>
--- <td><a href="https://www.lua.org/manual/5.3/manual.html#pdf-table.remove">remove</a></td>
--- <td><a href="https://www.lua.org/manual/5.3/manual.html#pdf-table.sort">sort</a></td></tr></table>
--- <h2>Globals</h2>
--- <p>Every snake can describe itself with the following attributes of the global variable <code>self</code>:</p>
--- <table>
--- <thead>
......@@ -69,22 +69,21 @@
--- <tr><td>mass</td><td>number</td><td>the weight of the snake</td></tr>
--- <tr><td>sight_radius</td><td>number</td><td>the field of view of the snake, which increases with the size of the snake</td></tr>
--- <tr><td>consume_radius</td><td>number</td><td>the field of feed of the snake, which increases with the size of the snake</td></tr>
--- <tr><td>max_step_angle</td><td>number</td><td>unknown definition</td></tr>
--- <tr><td>max_step_angle</td><td>number</td><td>limits the return value of the step function (-max_step_angle to +max_step_angle)</td></tr>
--- <tr><td>start_frame</td><td>number</td><td>the game frame, when the snake was born</td></tr>
--- <tr><td>current_frame</td><td>number</td><td>the current game frame</td></tr>
--- <tr><td>speed</td><td>number</td><td>default speed is 1, but it can change if a snake is using boost</td></tr>
--- <tr><td>food_consumed_natural</td><td>number</td><td>unknown definition</td></tr>
--- <tr><td>food_consumed_hunted_self</td><td>number</td><td>unknown definition</td></tr>
--- <tr><td>food_consumed_hunted_by_others</td><td>number</td><td>unknown definition</td></tr>
--- <tr><td>colors</td><td>{number}</td><td>table of colors (default color is 0x0000FF00, maximum count is 100, set is available in <a href="#init">init</a>)</td></tr>
--- <tr><td>food_consumed_natural</td><td>number</td><td>consumed food which appeared naturally in the world</td></tr>
--- <tr><td>food_consumed_hunted_self</td><td>number</td><td>consumed food from snakes that you killed</td></tr>
--- <tr><td>food_consumed_hunted_by_others</td><td>number</td><td>consumed food from snakes that were killed by others</td></tr>
--- <tr><td>colors</td><td>{number,..}</td><td>table of colors (default color is 0x0000FF00, maximum count is 100, set is available in <a href="#init">init</a>)</td></tr>
--- <tr><td>face</td><td>number</td><td>not implemented yet (returns 0, set is available in <a href="#init">init</a>)</td></tr>
--- <tr><td>logo</td><td>number</td><td>not implemented yet (returns 0, set is available in <a href="#init">init</a>)</td></tr></tr>
--- </tbody></table>
--- This function is called upon creation of a bot
-- Initialialize your environment here.
-- You can also access the "self" module here and, e.g. set your snake's colors.
-- You can also modify the "self" variables here and, e.g. set your snake's colors.
-- @usage function init()
-- self.colors = { 0xFF0000, 0xFFBF00, 0x80FF00, 0x00FF40, 0x00FFFF, 0x0015FF, 0x8000FF }
-- end
......@@ -92,26 +91,34 @@ function init()
end
--- That function returns all food as list.
-- The list is ordered by food value, from largest to lowest. The values of new spawning
-- food are calculated based on a mean value of 3.5 and a standard deviation of 2.
-- A killed snake drops a part of the consumed food, that is distributed by the same rule.
-- @param max_distance all food within the distance is included
-- @param minimum_food_value all lower food values are filtered (min: 0, max: unknown)
-- @usage local food = findFood(max_distance, 0.8)
-- for i, item in food:pairs() do
-- item.d -- angle in radian
-- item.d -- angle in radian (-π to +π)
-- item.dist -- distance
-- item.v -- food value
-- end
function findFood(max_distance, minimum_food_value)
end
--- That function returns all segments of all snakes within a certain radius as list.
-- All attributes of each item in the segments list are measured between the center of your head the the center of the item center.
-- The list is ordered by distance, from smallest to largest. All attributes of each
-- item in the segments list are measured between the center of your head the the center
-- of the item center.
-- @param max_distance all segements within that distance are included
-- @param include_own If true, your snake segments are included. Otherwise you get only enemy segments
-- @usage local segments = findSegments(50.0, false)
-- for i, item in segments:pairs() do
-- item.d -- angle in radian
-- item.r -- radius of the item
-- item.dist -- distance
-- item.bot -- id of the other snake
-- item.d -- angle in radian (-π to +π)
-- item.r -- radius of the item
-- item.dist -- distance
-- item.bot -- id of the other snake (new one after death)
-- item.bot_id -- id of the other snake (new one after death)
-- item.bot_name -- name of the other snake (will never change)
-- end
function findSegments(max_distance, include_own)
end
......@@ -121,12 +128,12 @@ end
function log(message)
end
--- That function is called each frame.
--- That function (defined by you) is called each frame.
-- Here you can implement you bot logic. The return value must be an radiant angle.
-- A negative angle means turn left and a positive angle
-- means turn right. With 0, the snake keeps its direction.
-- @return new angle relative to the head direction
--@return if true the snake will use boost, otherwise false or empty (optional)
-- @return if true the snake will use boost, otherwise false or empty (optional)
-- @usage function step()
-- return 0.005
-- end
......@@ -134,4 +141,5 @@ end
-- return 0.005, true
-- end
function step()
return 0.005
end
{% extends 'core/base.html' %}
{% load static %}
{% block earlycss %}
<link rel="stylesheet" type="text/css" href="{% static "docs/github-markdown.css" %}" />
{% endblock %}
{% block css %}
<link rel="stylesheet" type="text/css" href="{% static "core/highlight.js/styles/agate.css" %}" />
<link rel="stylesheet" type="text/css" href="{% static "docs/docs.css" %}" />
{% endblock %}
{% block js%}
<script src="{% static "core/highlight.js/highlight.pack.js" %}"></script>
<script>hljs.initHighlightingOnLoad();</script>
{% endblock %}
{% block content %}
<div class="docs_container markdown-body">
<h1>Bot Documentation</h1>
<div id="docs_content">
<p>This is a brief overview of all usable functions within the bot logic.</p>
<p>
Every bot is allowed to store 100MB within the global namespace and the
data persists until the bot dies. So the bot can save data from frame
to frame.
<h2>Lua global namespace</h2>
<p>The following Lua standard functions are allowed:</p>
<p><a href="http://pgl.yoyo.org/luai/i/assert">assert</a>,
<a href="http://pgl.yoyo.org/luai/i/print">print</a>,
<a href="http://pgl.yoyo.org/luai/i/ipairs">ipairs</a>,
<a href="http://pgl.yoyo.org/luai/i/error">error</a>,
<a href="http://pgl.yoyo.org/luai/i/next">next</a>,
<a href="http://pgl.yoyo.org/luai/i/pairs">pairs</a>,
<a href="http://pgl.yoyo.org/luai/i/pcall">pcall</a>,
<a href="http://pgl.yoyo.org/luai/i/select">select</a>,
<a href="http://pgl.yoyo.org/luai/i/tonumber">tonumber</a>,
<a href="http://pgl.yoyo.org/luai/i/tostring">tostring</a>,
<a href="http://pgl.yoyo.org/luai/i/type">type</a>,
<a href="http://pgl.yoyo.org/luai/i/unpack">unpack</a>,
<a href="http://pgl.yoyo.org/luai/i/_VERSION">_VERSION</a>,
<a href="http://pgl.yoyo.org/luai/i/xpcall">xpcall</a></p>
<p>From the module <code>math</code> you can use:</p>
<p><a href="http://pgl.yoyo.org/luai/i/math.abs">abs</a>,
<a href="http://pgl.yoyo.org/luai/i/math.acos">acos</a>,
<a href="http://pgl.yoyo.org/luai/i/math.asin">asin</a>,
<a href="http://pgl.yoyo.org/luai/i/math.atan">atan</a>,
<a href="http://pgl.yoyo.org/luai/i/math.atan2">atan2</a>,
<a href="http://pgl.yoyo.org/luai/i/math.ceil">ceil</a>,
<a href="http://pgl.yoyo.org/luai/i/math.cos">cos</a>,
<a href="http://pgl.yoyo.org/luai/i/math.cosh">cosh</a>,
<a href="http://pgl.yoyo.org/luai/i/math.deg">deg</a>,
<a href="http://pgl.yoyo.org/luai/i/math.exp">exp</a>,
<a href="http://pgl.yoyo.org/luai/i/math.floor">floor</a>,
<a href="http://pgl.yoyo.org/luai/i/math.fmod">fmod</a>,
<a href="http://pgl.yoyo.org/luai/i/math.frexp">frexp</a>,
<a href="http://pgl.yoyo.org/luai/i/math.huge">huge</a>,
<a href="http://pgl.yoyo.org/luai/i/math.ldexp">ldexp</a>,
<a href="http://pgl.yoyo.org/luai/i/math.log">log</a>,
<a href="http://pgl.yoyo.org/luai/i/math.log10">log10</a>,
<a href="http://pgl.yoyo.org/luai/i/math.max">max</a>,
<a href="http://pgl.yoyo.org/luai/i/math.min">min</a>,
<a href="http://pgl.yoyo.org/luai/i/math.modf">modf</a>,
<a href="http://pgl.yoyo.org/luai/i/math.pi">pi</a>,
<a href="http://pgl.yoyo.org/luai/i/math.pow">pow</a>,
<a href="http://pgl.yoyo.org/luai/i/math.rad">rad</a>,
<a href="http://pgl.yoyo.org/luai/i/math.random">random</a>,
<a href="http://pgl.yoyo.org/luai/i/math.randomseed">randomseed</a>,
<a href="http://pgl.yoyo.org/luai/i/math.sin">sin</a>,
<a href="http://pgl.yoyo.org/luai/i/math.sinh">sinh</a>,
<a href="http://pgl.yoyo.org/luai/i/math.sqrt">sqrt</a>,
<a href="http://pgl.yoyo.org/luai/i/math.tan">tan</a>,
<a href="http://pgl.yoyo.org/luai/i/math.tanh">tanh</a></p>
<p>From the module <code>os</code> you can use:</p>
<p><a href="http://pgl.yoyo.org/luai/i/os.clock">clock</a>,
<a href="http://pgl.yoyo.org/luai/i/os.difftime">difftime</a>,
<a href="http://pgl.yoyo.org/luai/i/os.time">time</a></p>
<p>From the module <code>table</code> you can use:</p>
<a href="http://pgl.yoyo.org/luai/i/table.maxn">maxn</a>,
<a href="http://pgl.yoyo.org/luai/i/table.insert">insert</a>,
<a href="http://pgl.yoyo.org/luai/i/table.remove">remove</a>,
<a href="http://pgl.yoyo.org/luai/i/table.sort">sort</a></p>
<p>Every snake can describe itself with the following attributes of the global variable <code>self</code>:</p>
<table>
<thead>
<tr><td>Variable within self</td><td>Type</td><td>Description</td></tr>
</thead>
<tbody>
<tr><td>id</td><td>number</td><td>internal identifier</td></tr>
<tr><td>segment_radius</td><td>number</td><td>the size of the snake</td></tr>
<tr><td>mass</td><td>number</td><td>the weight of the snake</td></tr>
<tr><td>sight_radius</td><td>number</td><td>the field of view of the snake, which increases with the size of the snake</td></tr>
<tr><td>consume_radius</td><td>number</td><td>the field of feed of the snake, which increases with the size of the snake</td></tr>
<tr><td>max_step_angle</td><td>number</td><td>unknown definition</td></tr>
<tr><td>start_frame</td><td>number</td><td>the game frame, when the snake was born</td></tr>
<tr><td>current_frame</td><td>number</td><td>the current game frame</td></tr>
<tr><td>speed</td><td>number</td><td>default speed is 1, but it can change if a snake is using boost</td></tr>
<tr><td>food_consumed_natural</td><td>number</td><td>unknown definition</td></tr>
<tr><td>food_consumed_hunted_self</td><td>number</td><td>unknown definition</td></tr>
<tr><td>food_consumed_hunted_by_others</td><td>number</td><td>unknown definition</td></tr>
<tr><td>colors</td><td>{number}</td><td>table of colors (default color is 0x0000FF00, maximum count is 100, set is available in <a href="#init">init</a>)</td></tr>
<tr><td>face</td><td>number</td><td>not implemented yet (returns 0, set is available in <a href="#init">init</a>)</td></tr>
<tr><td>logo</td><td>number</td><td>not implemented yet (returns 0, set is available in <a href="#init">init</a>)</td></tr></tr>
</tbody></table></p>
<h2><a href="#Functions">Functions</a></h2>
<table class="function_list">
<thead>
<tr>
<td>
Function name
</td>
<td>
Description
</td>
</tr>
</thead>
<tbody>
<tr>
<td class="name" nowrap><a href="#init">init ()</a></td>
<td class="summary">This function is called upon creation of a bot
Initialialize your environment here.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#findFood">findFood (max_distance, minimum_food_value)</a></td>
<td class="summary">That function returns all food as list.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#findSegments">findSegments (max_distance, include_own)</a></td>
<td class="summary">That function returns all segments of all snakes within a certain radius as list.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#log">log (message)</a></td>
<td class="summary">That function sends messages to the development console.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#step">step ()</a></td>
<td class="summary">That function is called each frame.</td>
</tr>
</tbody>
</table>
<h2><a name="Functions"></a>Functions</h2>
<dl class="function">
<dt>
<a name = "init"></a>
<strong>init ()</strong>
</dt>
<dd>
This function is called upon creation of a bot
Initialialize your environment here.
You can also access the "self" module here and, e.g. set your snake's colors.
<h4>Usage:</h4>
<ul>
<pre class="usage"><code class="lua"> <span class="keyword">function</span> init()
self.colors = { <span class="number">0xFF0000</span>, <span class="number">0xFFBF00</span>, <span class="number">0x80FF00</span>, <span class="number">0x00FF40</span>, <span class="number">0x00FFFF</span>, <span class="number">0x0015FF</span>, <span class="number">0x8000FF</span> }
<span class="keyword">end</span></code></pre>
</ul>
</dd>
<dt>
<a name = "findFood"></a>
<strong>findFood (max_distance, minimum_food_value)</strong>
</dt>
<dd>
That function returns all food as list.
<h4>Parameters:</h4>
<ul>
<li><code>max_distance</code>
all food within the distance is included
</li>
<li><code>minimum_food_value</code>
all lower food values are filtered (min: 0, max: unknown)
</li>
</ul>
<h4>Usage:</h4>
<ul>
<pre class="usage"><code class="lua"> <span class="keyword">local</span> food = findFood(max_distance, <span class="number">0.8</span>)
<span class="keyword">for</span> i, item <span class="keyword">in</span> food:<span class="global">pairs</span>() <span class="keyword">do</span>
item.d <span class="comment">-- angle in radian
</span> item.dist <span class="comment">-- distance
</span> <span class="keyword">end</span></code></pre>
</ul>
</dd>
<dt>
<a name = "findSegments"></a>
<strong>findSegments (max_distance, include_own)</strong>
</dt>
<dd>
That function returns all segments of all snakes within a certain radius as list.
All attributes of each item in the segments list are measured between the center of your head the the center of the item center.
<h4>Parameters:</h4>
<ul>
<li><code>max_distance</code>
all segements within that distance are included
</li>
<li><code>include_own</code>
If true, your snake segments are included. Otherwise you get only enemy segments
</li>
</ul>
<h4>Usage:</h4>
<ul>
<pre class="usage"><code class="lua"> <span class="keyword">local</span> segments = findSegments(<span class="number">50.0</span>, <span class="keyword">false</span>)
<span class="keyword">for</span> i, item <span class="keyword">in</span> segments:<span class="global">pairs</span>() <span class="keyword">do</span>
item.d <span class="comment">-- angle in radian
</span> item.r <span class="comment">-- radius of the item
</span> item.dist <span class="comment">-- distance
</span> item.bot <span class="comment">-- id of the other snake
</span> <span class="keyword">end</span></code></pre>
</ul>
</dd>
<dt>
<a name = "log"></a>
<strong>log (message)</strong>
</dt>
<dd>
That function sends messages to the development console.
<h4>Parameters:</h4>
<ul>
<li><code>message</code>
this string will be transfered to the console
</li>
</ul>
</dd>
<dt>
<a name = "step"></a>
<strong>step ()</strong>
</dt>
<dd>
That function is called each frame.
Here you can implement you bot logic. The return value must be an radiant angle.
A negative angle means turn left and a positive angle
means turn right. With 0, the snake keeps its direction.
<h4>Returns:</h4>
<ol>
<li>
new angle relative to the head direction</li>
<li>
if true the snake will use boost, otherwise false or empty (optional)</li>
</ol>
<h4>Usage:</h4>
<ul>
<li><pre class="usage"><code class="lua"> <span class="keyword">function</span> step()
<span class="keyword">return</span> <span class="number">0.005</span>
<span class="keyword">end</span></code></pre></li>
<li><pre class="usage"><code class="lua"> <span class="keyword">function</span> step()
<span class="keyword">return</span> <span class="number">0.005</span>, <span class="keyword">true</span>
<span class="keyword">end</span></code></pre></li>
</ul>
</dd>
</dl>
</div> <!-- id="content" -->
</div> <!-- id="main" -->
</div> <!-- id="container" -->
{% endblock %}
{% extends 'core/base.html' %}
{% load static %}
{% block earlycss %}
<link rel="stylesheet" type="text/css" href="{% static "docs/github-markdown.css" %}" />
{% endblock %}
{% block css %}
<link rel="stylesheet" type="text/css" href="{% static "core/highlight.js/styles/agate.css" %}" />
<link rel="stylesheet" type="text/css" href="{% static "docs/docs.css" %}" />
{% endblock %}
{% block js%}
<script src="{% static "core/highlight.js/highlight.pack.js" %}"></script>
<script>hljs.initHighlightingOnLoad();</script>
{% endblock %}
{% block content %}
<div class="docs_container markdown-body">
<h1>Bot Documentation</h1>
<div id="docs_content">
<p>This is a brief overview of all usable functions within the bot logic.</p>
<p>
Every player can start with a simple demo bot. You get the code in the
<a href="/snake/edit/latest">editor</a>. A snake hungers, so it constantly
loses size. Feed it and it will stay alive and grows. Your snake will die,
when it touches another snake with its head.
<h2>Lua global namespace</h2>
<p>Every snake is allowed to store 100MB within the global namespace and the
data persists until the bot dies. So the bot can save data from frame
to frame.</p>
<p>The following Lua standard functions are allowed:</p>
<table>
<tr><td><a href="https://www.lua.org/manual/5.3/manual.html#pdf-assert">assert</a></td>
<td><a href="https://www.lua.org/manual/5.3/manual.html#pdf-print">print</a></td>
<td><a href="https://www.lua.org/manual/5.3/manual.html#pdf-ipairs">ipairs</a></td>
<td><a href="https://www.lua.org/manual/5.3/manual.html#pdf-error">error</a></td>
<td><a href="https://www.lua.org/manual/5.3/manual.html#pdf-next">next</a></td>
<td><a href="https://www.lua.org/manual/5.3/manual.html#pdf-pairs">pairs</a></td>
<td><a href="https://www.lua.org/manual/5.3/manual.html#pdf-pcall">pcall</a></td></tr>
<tr><td><a href="https://www.lua.org/manual/5.3/manual.html#pdf-select">select</a></td>
<td><a href="https://www.lua.org/manual/5.3/manual.html#pdf-tonumber">tonumber</a>,
<td><a href="https://www.lua.org/manual/5.3/manual.html#pdf-tostring">tostring</a></td>
<td><a href="https://www.lua.org/manual/5.3/manual.html#pdf-type">type</a></td>
<td><a href="https://www.lua.org/manual/5.3/manual.html#pdf-unpack">unpack</a></td>
<td><a href="https://www.lua.org/manual/5.3/manual.html#pdf-_VERSION">_VERSION</a></td>
<td><a href="https://www.lua.org/manual/5.3/manual.html#pdf-xpcall">xpcall</a></td></tr></table>
<p>From the module <code>math</code> you can use:</p>
<table><tr><td><a href="https://www.lua.org/manual/5.3/manual.html#pdf-math.abs">abs</a></td>
<td><a href="https://www.lua.org/manual/5.3/manual.html#pdf-math.acos">acos</a></td>
<td><a href="https://www.lua.org/manual/5.3/manual.html#pdf-math.asin">asin</a></td>
<td><a href="https://www.lua.org/manual/5.3/manual.html#pdf-math.atan">atan</a></td>
<td><a href="https://www.lua.org/manual/5.3/manual.html#pdf-math.ceil">ceil</a></td>
<td><a href="https://www.lua.org/manual/5.3/manual.html#pdf-math.cos">cos</a></td>
<td><a href="https://www.lua.org/manual/5.3/manual.html#pdf-math.deg">deg</a></td></tr>
<tr><td><a href="https://www.lua.org/manual/5.3/manual.html#pdf-math.exp">exp</a></td>
<td><a href="https://www.lua.org/manual/5.3/manual.html#pdf-math.floor">floor</a></td>
<td><a href="https://www.lua.org/manual/5.3/manual.html#pdf-math.fmod">fmod</a></td>
<td><a href="https://www.lua.org/manual/5.3/manual.html#pdf-math.frexp">frexp</a></td>
<td><a href="https://www.lua.org/manual/5.3/manual.html#pdf-math.huge">huge</a></td>
<td><a href="https://www.lua.org/manual/5.3/manual.html#pdf-math.log">log</a></td>
<td><a href="https://www.lua.org/manual/5.3/manual.html#pdf-math.max">max</a></td></tr>