Difference between revisions of "Default Ruleset Function Documentation Template"
(→Examples) |
|||
| Line 2: | Line 2: | ||
{REMOVEME: Template for API Functions} | {REMOVEME: Template for API Functions} | ||
| + | <pre> | ||
== <code>'''OpenTitleWindow(user)'''</code> === | == <code>'''OpenTitleWindow(user)'''</code> === | ||
{| | {| | ||
| Line 21: | Line 22: | ||
Parameters: | Parameters: | ||
| − | + | {| | |
| + | |<code>(GameObj)</code> || <code>user:</code> || user to show his title window | ||
| + | |- | ||
| + | |<code>(type)</code> || <code>name:</code> || Description | ||
| + | |} | ||
| + | |||
| + | Return Values | ||
| + | {| | ||
| + | |- | ||
| + | |<code>(type)</code> || <code>name:</code> || Description | ||
| + | |} | ||
| + | |||
| + | |||
| + | === Notes and Caveats === | ||
| + | none | ||
| + | === Examples === | ||
| + | <syntaxhighlight lang="lua"> | ||
| + | -- opens the title window for user "this" | ||
| + | OpenTitleWindow(this) | ||
| + | </syntaxhighlight> | ||
| + | |||
| + | |||
| + | [[Category:Default Ruleset]][[Category:Function Reference]] | ||
| + | </pre> | ||
| + | |||
| + | |||
| + | == <code>'''OpenTitleWindow(user)'''</code> === | ||
| + | {| | ||
| + | |- | ||
| + | | Function Type: || Default Ruleset | ||
| + | |- | ||
| + | | Module: || player | ||
| + | |- | ||
| + | | File: || base_player_titles.lua | ||
| + | |} | ||
| + | |||
| + | ===Description === | ||
| + | Opens the title window for the given user | ||
| + | |||
| + | === Prototype === | ||
| + | <syntaxhighlight lang="lua"> | ||
| + | OpenTitleWindow(user) | ||
| + | </syntaxhighlight> | ||
| + | |||
| + | Parameters: | ||
| + | {| | ||
| + | |<code>(GameObj)</code> || <code>user:</code> || user to show his title window | ||
| + | |- | ||
| + | |<code>(type)</code> || <code>name:</code> || Description | ||
| + | |} | ||
Return Values | Return Values | ||
| − | + | {| | |
| + | |- | ||
| + | |<code>(type)</code> || <code>name:</code> || Description | ||
| + | |} | ||
| + | |||
=== Notes and Caveats === | === Notes and Caveats === | ||
Revision as of 19:15, 1 November 2016
{You can use the code of this page as a template when creating a function documentation in the Category:Shards Online Lua Interface or Category:Function Reference category. Everything italic in curly brackets is just a comment or explanation and not part of the template.}
{REMOVEME: Template for API Functions}
== <code>'''OpenTitleWindow(user)'''</code> ===
{|
|-
| Function Type: || Default Ruleset
|-
| Module: || player
|-
| File: || base_player_titles.lua
|}
===Description ===
Opens the title window for the given user
=== Prototype ===
<syntaxhighlight lang="lua">
OpenTitleWindow(user)
</syntaxhighlight>
Parameters:
{|
|<code>(GameObj)</code> || <code>user:</code> || user to show his title window
|-
|<code>(type)</code> || <code>name:</code> || Description
|}
Return Values
{|
|-
|<code>(type)</code> || <code>name:</code> || Description
|}
=== Notes and Caveats ===
none
=== Examples ===
<syntaxhighlight lang="lua">
-- opens the title window for user "this"
OpenTitleWindow(this)
</syntaxhighlight>
[[Category:Default Ruleset]][[Category:Function Reference]]
OpenTitleWindow(user) =
| Function Type: | Default Ruleset |
| Module: | player |
| File: | base_player_titles.lua |
Description
Opens the title window for the given user
Prototype
OpenTitleWindow(user)
Parameters:
(GameObj) |
user: |
user to show his title window |
(type) |
name: |
Description |
Return Values
(type) |
name: |
Description |
Notes and Caveats
none
Examples
-- opens the title window for user "this"
OpenTitleWindow(this)
