Difference between revisions of "Engine Function Documentation Template"
(→CanDrop(...)) |
|||
| Line 7: | Line 7: | ||
function CanDrop(mObj, mLoc) | function CanDrop(mObj, mLoc) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| − | Parameters: | + | '''Parameters:''' |
* (gameObj) mObj: The target gameobject | * (gameObj) mObj: The target gameobject | ||
* (Loc) mLoc: The Location used in the function | * (Loc) mLoc: The Location used in the function | ||
| − | Return Values | + | '''Return Values''' |
* (boolean): Returns true when mObj can be dropped at mLoc, false otherwise | * (boolean): Returns true when mObj can be dropped at mLoc, false otherwise | ||
| + | '''Description:''' CanDrop() is an example function used for this template. When implemented, it might tell you if you can drop something (mObj) somewhere (mLoc) and returns if it is possible (boolean). | ||
=== Caveats === | === Caveats === | ||
Non existing sample function for documentation prototyping only. | Non existing sample function for documentation prototyping only. | ||
Revision as of 15:14, 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
Description: CanDrop() is an example function used for this template. When implemented, it might tell you if you can drop something (mObj) somewhere (mLoc) and returns if it is possible (boolean).
Caveats
Non existing sample function for documentation prototyping only.
Examples
print("My example code goes here"..tostring(CanDrop(mObj,mLoc)))
And here goes some explanation
