Difference between revisions of "Default Ruleset Function Documentation Template"

From Legends of Aria Admin and Modding Wiki
Jump to: navigation, search
(→‎SetWorldPosition(...) =)
Line 2: Line 2:
  
 
{REMOVEME: Template for API Functions}
 
{REMOVEME: Template for API Functions}
−
== <code>'''SetWorldPosition(...)'''</code> ===
+
== <code>'''OpenTitleWindow(user)'''</code> ===
 
{|
 
{|
 
|-
 
|-
 
| Function Type: || Default Ruleset
 
| Function Type: || Default Ruleset
 
|-
 
|-
−
| File: || base_quest_sys.lua
+
| Module: || player
 +
|-
 +
| File: || base_player_titles.lua
 
|}
 
|}
  
 
===Description ===
 
===Description ===
−
Sets the position of this object in the world
+
Opens the tile window for the given user
  
 
=== Prototype ===
 
=== Prototype ===
 
<syntaxhighlight lang="lua">
 
<syntaxhighlight lang="lua">
−
mBool = mObj:SetWorldPosition(mLoc )
+
OpenTitleWindow(user)
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
Parameters:
 
Parameters:
−
  (GameObj) mObj: The gameobject you want to place somewhere in the world
+
  (GameObj) user: user to show his title window
−
(Loc)    mLoc: The location where to put the object
 
  
 
Return Values
 
Return Values
−
  (boolean) mBool: True on success. False otherwise.
+
  none
  
 
=== Notes and Caveats ===
 
=== Notes and Caveats ===
−
This works for both mobile and non-mobile objects. This will remove objects from containers and equipment slots
+
none
−
<br>Don't place GameObjects outside the map coordinates. Just don't do it. Its evil
 
−
 
 
 
=== Examples ===
 
=== Examples ===
 
<syntaxhighlight lang="lua">
 
<syntaxhighlight lang="lua">
−
-- puts "this" to the map origin
+
-- opens the titl window for mUser
−
mLoc = Loc(0,0,0)
+
OpenTitleWindow(mUser)
−
mResult = this:SetWorldPosition(mLoc)
 
−
print("Success: "..tostring(mResult) )
 
 
</syntaxhighlight>
 
</syntaxhighlight>
−
The example places the object mObj to the map origin Loc(0,0,0)
 
  
−
[[Category:Shards Online Lua Interface]][[Category:Function Reference]]
+
 
 +
[[Category:Default Ruleset]][[Category:Function Reference]]

Revision as of 16:02, 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}

OpenTitleWindow(user) =

Function Type: Default Ruleset
Module: player
File: base_player_titles.lua

Description

Opens the tile 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 titl window for mUser
OpenTitleWindow(mUser)
Retrieved from "https://adminwiki.legendsofaria.com/index.php?title=Default_Ruleset_Function_Documentation_Template&oldid=238"