Difference between revisions of "Engine Function Documentation Template"
(Created page with "You can use the code of this page as a template when creating a function documentation in the "Shards Online Lua Interface" category. == MyFunction == prototype: <syntaxhigh...") |
(→MyFunction) |
||
| Line 1: | Line 1: | ||
You can use the code of this page as a template when creating a function documentation in the "Shards Online Lua Interface" category. | 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 === | |
| − | <syntaxhighlight lang=lua> | + | <syntaxhighlight lang="lua"> |
| − | function | + | function CanDrop(mObj, mLoc) |
| − | </syntaxhighlight lang=lua> | + | </syntaxhighlight> |
| + | 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 === | ||
| + | <syntaxhighlight lang="lua"> | ||
| + | print("My example code goes here") | ||
| + | </syntaxhighlight> | ||
| + | And here goes some explanation | ||
Revision as of 15:07, 1 November 2016
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
