talezero/integration
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix a bug in function registry, improve docs

Browse Source
This commit is contained in:
jyelon
2021-12-23 14:38:01 -05:00
parent b4639c70db
commit 82381ada2e
5 changed files with 112 additions and 41 deletions
Download Patch File Download Diff File Expand all files Collapse all files

96
luprex/core/cpp/world-accessor.cpp
View File

@@ -17,7 +17,9 @@ static void tangible_getall(LuaStack &LS0, LuaSlot list, const util::IdVector &i
LS.result();
}
LuaDefine(tangible_animstate, "tan", "get the final animation state of the tangible") {
LuaDefine(tangible_animstate, "tan",
"|Get the entire animation state of the tangible."
"|Returns six values: graphic,plane,x,y,z,facing.") {
LuaArg tanobj;
LuaRet graphic, plane, x, y, z, facing;
LuaStack LS(L, tanobj, graphic, plane, x, y, z, facing);
@@ -33,7 +35,25 @@ LuaDefine(tangible_animstate, "tan", "get the final animation state of the tangi
return LS.result();
}
LuaDefine(tangible_animate, "tan,configtable", "add an animation step to the tangible") {
LuaDefine(tangible_xyz, "tan",
"|Get the current coordinates of the tangible."
"|Returns three values: x, y, z") {
LuaArg tanobj;
LuaRet x, y, z;
LuaStack LS(L, tanobj, x, y, z);
World *w = World::fetch_global_pointer(L);
Tangible *tan = w->tangible_get(LS, tanobj);
const AnimStep &aqback = tan->anim_queue_.back();
LS.set(x, aqback.xyz().x);
LS.set(y, aqback.xyz().y);
LS.set(z, aqback.xyz().z);
return LS.result();
}
LuaDefine(tangible_animate, "tan,configtable",
"|Add an animation step to the tangible."
"|The configtable is a table containing any of the following:"
"|action,graphic,plane,x,y,z,facing") {
LuaArg tanobj, config;
LuaStack LS(L, tanobj, config);
World *w = World::fetch_global_pointer(L);
@@ -50,7 +70,11 @@ LuaDefine(tangible_animate, "tan,configtable", "add an animation step to the tan
return LS.result();
}
LuaDefine(tangible_setclass, "tan,classname", "set the class of the tangible") {
LuaDefine(tangible_setclass, "tan,class",
"|Set the class of the tangible."
"|The class can be a 'class table' (ie, a table of methods), "
"|or it can be a string that names a class. The tangible is "
"|given an __index metamethod that points at the class table.") {
LuaArg tanobj, classname;
LuaVar classtab, mt;
LuaStack LS(L, tanobj, classname, classtab, mt);
@@ -66,7 +90,10 @@ LuaDefine(tangible_setclass, "tan,classname", "set the class of the tangible") {
return LS.result();
}
LuaDefine(tangible_getclass, "tan", "get the class of the tangible, if any") {
LuaDefine(tangible_getclass, "tan",
"|Get the class of the tangible, if any."
"|The return value is a string, the class name, not"
"|the class table.") {
LuaArg tanobj;
LuaVar mt, classtab;
LuaRet classname;
@@ -84,7 +111,10 @@ LuaDefine(tangible_getclass, "tan", "get the class of the tangible, if any") {
return LS.result();
}
LuaDefine(tangible_delete, "tan", "delete the specified tangible") {
LuaDefine(tangible_delete, "tan",
"|Delete the specified tangible."
"|This cannot be used to delete player tangibles,"
"|To delete a player, use tangible.redirect") {
LuaArg tanobj;
LuaStack LS(L, tanobj);
World *w = World::fetch_global_pointer(L);
@@ -98,7 +128,10 @@ LuaDefine(tangible_delete, "tan", "delete the specified tangible") {
return LS.result();
}
LuaDefine(tangible_build, "configtable", "build a new tangible object") {
LuaDefine(tangible_build, "configtable",
"|Build a new tangible object."
"|The configtable must contain: class,x,y,z,plane,graphic."
"|The configtable can optionally contain: facing.") {
LuaArg config;
LuaVar classname, classtab, mt;
LuaRet database;
@@ -148,7 +181,10 @@ LuaDefine(tangible_build, "configtable", "build a new tangible object") {
return LS.result();
}
LuaDefine(tangible_get, "id", "get the tangible with the specified id (debugging only)") {
LuaDefine(tangible_get, "id",
"|Get the tangible with the specified id."
"|This is for debugging only and will be removed in"
"|the released version.") {
LuaArg id;
LuaVar tangibles;
LuaRet database;
@@ -162,7 +198,8 @@ LuaDefine(tangible_get, "id", "get the tangible with the specified id (debugging
return LS.result();
}
LuaDefine(tangible_redirect, "tan1,tan2,bulldozetan1", "redirect is not working yet") {
LuaDefine(tangible_redirect, "tan1,tan2,bulldozetan1",
"|Redirect is not working yet") {
LuaArg actor1, actor2, bldz;
LuaStack LS(L, actor1, actor2, bldz);
World *w = World::fetch_global_pointer(L);
@@ -184,7 +221,10 @@ LuaDefine(tangible_redirect, "tan1,tan2,bulldozetan1", "redirect is not working
return LS.result();
}
LuaDefine(tangible_id, "tan", "return the tangible's id number (debugging only)") {
LuaDefine(tangible_id, "tan",
"|Return the tangible's id number."
"|This is for debugging only and will be removed"
"|in the released version.") {
LuaArg tanobj;
LuaRet id;
LuaStack LS(L, tanobj, id);
@@ -196,7 +236,8 @@ LuaDefine(tangible_id, "tan", "return the tangible's id number (debugging only)"
return LS.result();
}
LuaDefine(tangible_actor, "", "return the current actor") {
LuaDefine(tangible_actor, "",
"|Return the current actor.") {
LuaRet actor;
LuaVar tangibles;
LuaStack LS(L, tangibles, actor);
@@ -206,7 +247,8 @@ LuaDefine(tangible_actor, "", "return the current actor") {
return LS.result();
}
LuaDefine(tangible_place, "", "return the current place") {
LuaDefine(tangible_place, "",
"|Return the current place.") {
LuaRet place;
LuaVar tangibles;
LuaStack LS(L, tangibles, place);
@@ -216,7 +258,11 @@ LuaDefine(tangible_place, "", "return the current place") {
return LS.result();
}
LuaDefine(tangible_near, "tan,radius,omit_nowhere,omit_self", "scan near the specified tangible") {
LuaDefine(tangible_near, "tan,radius,omit_nowhere,omit_self",
"|Scan near the specified tangible."
"|If omit_nowhere is true, and the tangible is on the nowhere plane,"
"|then the scan returns empty. If omit_self is true, then the "
"|tangible passed in is omitted from the results.") {
LuaArg ltan, lradius, lomit_nowhere, lomit_self;
LuaRet list;
LuaStack LS(L, ltan, lradius, lomit_nowhere, lomit_self, list);
@@ -231,7 +277,10 @@ LuaDefine(tangible_near, "tan,radius,omit_nowhere,omit_self", "scan near the spe
return LS.result();
}
LuaDefine(tangible_scan, "plane,x,y,radius,omit_nowhere", "scan the specified plane") {
LuaDefine(tangible_scan, "plane,x,y,radius,omit_nowhere",
"|Scan the specified plane."
"|If omit_nowhere is true, and the plane is 'nowhere', then"
"|the scan returns empty.") {
LuaArg lplane, lx, ly, lradius, lomit_nowhere;
LuaRet list;
LuaStack LS(L, lplane, lx, ly, lradius, lomit_nowhere, list);
@@ -246,14 +295,16 @@ LuaDefine(tangible_scan, "plane,x,y,radius,omit_nowhere", "scan the specified pl
return LS.result();
}
LuaDefine(wait, "nticks", "wait the specified number of ticks") {
LuaDefine(wait, "nticks",
"|Wait the specified number of ticks.") {
if ((lua_gettop(L) != 1) || (lua_type(L, -1) != LUA_TNUMBER)) {
luaL_error(L, "Argument to wait must be a number.");
}
return lua_yield(L, 1);
}
LuaDefine(tangible_nopredict, "", "stop predictive execution of this thread") {
LuaDefine(tangible_nopredict, "",
"|Stop predictive execution of this thread.") {
if (lua_gettop(L) != 0) {
luaL_error(L, "tangible.nopredict takes no arguments");
}
@@ -265,7 +316,8 @@ LuaDefine(tangible_nopredict, "", "stop predictive execution of this thread") {
}
}
LuaDefine(pprint, "obj1,obj2,...", "pretty-print all the objects") {
LuaDefine(pprint, "obj1,obj2,...",
"|Pretty-print object or objects.") {
World *w = World::fetch_global_pointer(L);
std::ostream *ostream = w->lthread_print_stream();
LuaStack LS(L);
@@ -277,19 +329,23 @@ LuaDefine(pprint, "obj1,obj2,...", "pretty-print all the objects") {
return LS.result();
}
LuaDefine(print, "obj1,obj2,...", "print all the objects") {
LuaDefine(print, "obj1,obj2,...",
"|Print object or objects.") {
World *w = World::fetch_global_pointer(L);
std::ostream *ostream = w->lthread_print_stream();
LuaStack LS(L);
for (int i = 1; i <= lua_gettop(L); i++) {
int n = lua_gettop(L);
for (int i = 1; i <= n; i++) {
LuaSpecial root(i);
atomic_print(LS, root, false, ostream);
(*ostream) << std::endl;
if (i < n) (*ostream) << " ";
}
(*ostream) << std::endl;
return LS.result();
}
LuaDefine(doc, "function", "print documentation for specified function") {
LuaDefine(doc, "function",
"|Print documentation for specified function.") {
World *w = World::fetch_global_pointer(L);
std::ostream *ostream = w->lthread_print_stream();
LuaArg func;