Difference between revisions of "Engine Function Documentation Template"
| Line 1: | Line 1: | ||
| − | {''You can use the code of this page as a template when creating a function documentation in the | + | {''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.''} |
== SetWorldPosition(...)=== | == SetWorldPosition(...)=== | ||
Revision as of 15:38, 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.}
SetWorldPosition(...)=
Function Type: Engine API {Is it an API or a default ruleset function?}
Description
Set 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
Return Values
- (boolean) mBool: True on success. False otherwise.
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) )
