docs.html 2.01 KB
Newer Older
nachtgold's avatar
nachtgold committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101

{% extends '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 "docs/docs.css" %}" />
{% 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></p>


<h2><a href="#Functions">Functions</a></h2>
<table class="function_list">
	<tr>
	<td class="name" nowrap><a href="#run">run (current_heading)</a></td>
	<td class="summary">Main cycle
 Run is executed each frame.</td>
	</tr>
	<tr>
	<td class="name" nowrap><a href="#api:get_rotation_speed">api:get_rotation_speed ()</a></td>
	<td class="summary">API #1</td>
	</tr>
</table>


    <h2><a name="Functions"></a>Functions</h2>

    <dl class="function">
    <dt>
    <a name = "run"></a>
    <strong>run (current_heading)</strong>
    </dt>
    <dd>
    Main cycle
 Run is executed each frame.


    <h4>Parameters:</h4>
    <ul>
        <li><code>current_heading</code>
         first parameter
        </li>
    </ul>




    <h4>Usage:</h4>
    <ul>
        <pre class="usage"><code class="lua"> <span class="keyword">function</span> run(current_heading)
   <span class="keyword">return</span> (current_heading + <span class="number">45</span>) % <span class="number">360</span>
 <span class="keyword">end</span></code></pre>
    </ul>

</dd>
    <dt>
    <a name = "api:get_rotation_speed"></a>
    <strong>api:get_rotation_speed ()</strong>
    </dt>
    <dd>
    API #1



    <h4>Returns:</h4>
    <ol>

        allowed rotation speed by the game engine
    </ol>



    <h4>Usage:</h4>
    <ul>
        <pre class="usage"><code class="lua"><span class="keyword">local</span> x = current_heading + api:get_rotation_speed()</code></pre>
    </ul>

</dd>
</dl>


</div> <!-- id="content" -->
</div> <!-- id="main" -->
</div> <!-- id="container" -->

{% endblock %}