Skip to content
GitLab
Menu
Projects
Groups
Snippets
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Menu
Open sidebar
Jochen Bauer
spn-website
Commits
0c480309
Commit
0c480309
authored
Apr 02, 2018
by
nachtgold
Browse files
Linux-style fixed
parent
61b66e38
Changes
2
Hide whitespace changes
Inline
Side-by-side
docs/lua/create_doc.sh
100644 → 100755
View file @
0c480309
# Lua must be installed (maybe also LuaFileSystem library, but it is normally already included)
# Lua must be installed (maybe also LuaFileSystem library, but it is normally already included)
lua ldoc/ldoc.lua
.
DIR
=
`
pwd
`
lua ldoc/ldoc.lua
$DIR
docs/templates/docs/docs.html
View file @
0c480309
{% extends 'base.html' %}
{% extends 'base.html' %}
{% load static %}
{% load static %}
{% block earlycss %}
{% block earlycss %}
<link
rel=
"stylesheet"
type=
"text/css"
href=
"{% static "
docs
/
github-markdown.css
"
%}"
/>
<link
rel=
"stylesheet"
type=
"text/css"
href=
"{% static "
docs
/
github-markdown.css
"
%}"
/>
{% endblock %}
{% endblock %}
{% block css %}
{% block css %}
<link
rel=
"stylesheet"
type=
"text/css"
href=
"{% static "
docs
/
docs.css
"
%}"
/>
<link
rel=
"stylesheet"
type=
"text/css"
href=
"{% static "
docs
/
docs.css
"
%}"
/>
{% endblock %}
{% endblock %}
{% block content %}
{% block content %}
<div
class=
"docs_container markdown-body"
>
<div
class=
"docs_container markdown-body"
>
<h1>
Bot Documentation
</h1>
<h1>
Bot Documentation
</h1>
<div
id=
"docs_content"
>
<div
id=
"docs_content"
>
<p>
This is a brief overview of all usable functions within the bot logic.
</p>
<p>
This is a brief overview of all usable functions within the bot logic.
</p>
<p></p>
<p></p>
<h2><a
href=
"#Functions"
>
Functions
</a></h2>
<h2><a
href=
"#Functions"
>
Functions
</a></h2>
<table
class=
"function_list"
>
<table
class=
"function_list"
>
<tr>
<tr>
<td
class=
"name"
nowrap
><a
href=
"#run"
>
run (current_heading)
</a></td>
<td
class=
"name"
nowrap
><a
href=
"#run"
>
run (current_heading)
</a></td>
<td
class=
"summary"
>
Main cycle
<td
class=
"summary"
>
Main cycle
Run is executed each frame.
</td>
Run is executed each frame.
</td>
</tr>
</tr>
<tr>
<tr>
<td
class=
"name"
nowrap
><a
href=
"#api:get_rotation_speed"
>
api:get_rotation_speed ()
</a></td>
<td
class=
"name"
nowrap
><a
href=
"#api:get_rotation_speed"
>
api:get_rotation_speed ()
</a></td>
<td
class=
"summary"
>
API #1
</td>
<td
class=
"summary"
>
API #1
</td>
</tr>
</tr>
</table>
</table>
<h2><a
name=
"Functions"
></a>
Functions
</h2>
<h2><a
name=
"Functions"
></a>
Functions
</h2>
<dl
class=
"function"
>
<dl
class=
"function"
>
<dt>
<dt>
<a
name =
"run"
></a>
<a
name =
"run"
></a>
<strong>
run (current_heading)
</strong>
<strong>
run (current_heading)
</strong>
</dt>
</dt>
<dd>
<dd>
Main cycle
Main cycle
Run is executed each frame.
Run is executed each frame.
<h4>
Parameters:
</h4>
<h4>
Parameters:
</h4>
<ul>
<ul>
<li><code>
current_heading
</code>
<li><code>
current_heading
</code>
first parameter
first parameter
</li>
</li>
</ul>
</ul>
<h4>
Usage:
</h4>
<h4>
Usage:
</h4>
<ul>
<ul>
<pre
class=
"usage"
><code
class=
"lua"
>
<span
class=
"keyword"
>
function
</span>
run(current_heading)
<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"
>
return
</span>
(current_heading +
<span
class=
"number"
>
45
</span>
) %
<span
class=
"number"
>
360
</span>
<span
class=
"keyword"
>
end
</span></code></pre>
<span
class=
"keyword"
>
end
</span></code></pre>
</ul>
</ul>
</dd>
</dd>
<dt>
<dt>
<a
name =
"api:get_rotation_speed"
></a>
<a
name =
"api:get_rotation_speed"
></a>
<strong>
api:get_rotation_speed ()
</strong>
<strong>
api:get_rotation_speed ()
</strong>
</dt>
</dt>
<dd>
<dd>
API #1
API #1
<h4>
Returns:
</h4>
<h4>
Returns:
</h4>
<ol>
<ol>
allowed rotation speed by the game engine
allowed rotation speed by the game engine
</ol>
</ol>
<h4>
Usage:
</h4>
<h4>
Usage:
</h4>
<ul>
<ul>
<pre
class=
"usage"
><code
class=
"lua"
><span
class=
"keyword"
>
local
</span>
x = current_heading + api:get_rotation_speed()
</code></pre>
<pre
class=
"usage"
><code
class=
"lua"
><span
class=
"keyword"
>
local
</span>
x = current_heading + api:get_rotation_speed()
</code></pre>
</ul>
</ul>
</dd>
</dd>
</dl>
</dl>
</div>
<!-- id="content" -->
</div>
<!-- id="content" -->
</div>
<!-- id="main" -->
</div>
<!-- id="main" -->
</div>
<!-- id="container" -->
</div>
<!-- id="container" -->
{% endblock %}
{% endblock %}
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment