Engine 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.}
You can copypaste this block for your function Documentation:
SetWorldPosition(...)
=
Function Type: | Engine API |
Function Category: | GameObj |
Description
Sets the position of this object in the worldPrototype
mBool = mObj:SetWorldPosition(mLoc )
(GameObj) mObj: |
The gameobject you want to place somewhere in the world |
(Loc) mLoc: |
The location where to put the object |
Notes and Caveats
This works for both mobile and non-mobile objects. This will remove objects from containers and equipment slotsDon'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) )