Engine Function Documentation Template

You can use the code of this page as a template when creating a function documentation in the "Shards Online Lua Interface" category.

CanDrop(...)

Prototype

function CanDrop(mObj, mLoc)

Parameters:

• (gameObj) mObj: The target gameobject
• (Loc) mLoc: The Location used in the function

Return Values

• (boolean): Returns true when mObj can be dropped at mLoc, false otherwise

Caveats

Non existing sample function for documentation prototyping only.

Examples

print("My example code goes here")

And here goes some explanation