Engine Function Documentation Template

From Legends of Aria Admin and Modding Wiki
Revision as of 19:11, 1 November 2016 by Yorlik (talk | contribs)
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.
You can copypaste this block for your function Documentation:




SetWorldPosition(...) =

Function Type: Engine API
Function Category: GameObj
Official Documentation: SetWorldPosition

Description

Sets the position of this object in the world

Prototype

mBool = mObj:SetWorldPosition(mLoc )
Parameters:
(GameObj) mObj: The gameobject you want to place somewhere in the world
(Loc) mLoc: The location where to put the object
(type) name: Description
Return Values
(boolean) mBool: True on success. False otherwise.
(type) name: Description

Notes and Caveats

This works for both mobile and non-mobile objects. This will remove objects from containers and equipment slots
Don't place GameObjects outside the map coordinates. Just don't do it. Its evil

Examples

-- puts "this" to the map origin
mLoc = Loc(0,0,0)
mResult = this:SetWorldPosition(mLoc)
print("Success: "..tostring(mResult) )
The example places the object mObj to the map origin Loc(0,0,0)