Default Ruleset Function Documentation Template

From Legends of Aria Admin and Modding Wiki
Revision as of 16:03, 1 November 2016 by Yorlik (talk | contribs) (Examples)
Jump to: navigation, search

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

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

Return Values

none

Notes and Caveats

none

Examples

-- opens the title window for this
OpenTitleWindow(this)