Default Ruleset Function Documentation Template

{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)