Difference between revisions of "Engine Function Documentation Template"

From Legends of Aria Admin and Modding Wiki
Jump to: navigation, search
(Examples)
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(...)'''
+
==CanDrop(...)==
  
 
=== Prototype ===
 
=== Prototype ===

Revision as of 15:11, 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"..tostring(CanDrop(mObj,mLoc)))

And here goes some explanation