aboutsummaryrefslogtreecommitdiff
path: root/doc/nerv.md
diff options
context:
space:
mode:
authorDeterminant <ted.sybil@gmail.com>2015-06-01 17:39:20 +0800
committerDeterminant <ted.sybil@gmail.com>2015-06-01 17:39:20 +0800
commitbf05d75bf173e1a496a277c76593537dc9cdb28a (patch)
treeee7b85bfca4d70a4517066f7b6ddc24f20e16181 /doc/nerv.md
parenta309ce5e33b22030bcac348c63576187676abee3 (diff)
parentae05d335f247ef2e83ad29ed9dca76260a9d7dff (diff)
Merge branch 'master' of github.com:Determinant/nerv
Diffstat (limited to 'doc/nerv.md')
-rw-r--r--doc/nerv.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/doc/nerv.md b/doc/nerv.md
index 85a86ca..22b4072 100644
--- a/doc/nerv.md
+++ b/doc/nerv.md
@@ -1,5 +1,15 @@
#The Nerv utility functions#
Part of the [Nerv](../README.md) toolkit.
##Methods##
+* __string = nerv.typename(obj a)__
+A registered function, the original function is `luaT_lua_typename`. In some cases if you call `type(a)` for object of some class in __Nerv__(like __Nerv.CuMatrix__) it will only return "userdata"(because it is created in C), in this case you can use this method to get its type.
+
+---
+
+* __metatable = nerv.getmetatable(string tname)__
+A registered function, the original function is `luaT_lua_getmetatable`. `tname` should be a class name that has been registered in __luaT__.
+
+* __metatable = nerv.newmetatable(string tname, string parenttname, function constructor, function destructor, function factory)__
+A registered function, the original function is `luaT_newmetatable`, it returns the metatable of the created class by the name `tname`.
* __string = nerv.setmetatable(table self, string tname)__
A registered function, the original function is `luaT_lua_setmetatable`. It assigns the metatable registered in __luaT__ by the name *tname* to the table *self*. And return *tname* to user.