qf/quakeforge
0
0
Fork 0
mirror of https://git.code.sf.net/p/quake/quakeforge synced 2025-03-28 05:01:28 +00:00
Code Issues Projects Releases Packages Wiki Activity

[gamecode] Clarify docs for PR_CallFunction

Browse source 
I found the docs in PR_ExecuteProgram and PR_CallFunction to be a little
confusing, so making it explicit that PR_ExecuteProgram calls
PR_CallFunction and that PR_CallFunction should be called only in a
builtin seemed like a good idea.
This commit is contained in:
Bill Currie 2022-01-22 11:38:26 +09:00
parent 06b1ea6837
commit 68d87de251
1 changed files with 4 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
include/QF/progs.h
View file

@ -166,6 +166,7 @@ void PR_PopFrame (progs_t *pr);
return to the caller. Nested calls are fully supported.
\param pr pointer to ::progs_t VM struct
\param fnum number of the function to call
\note Calls PR_CallFunction()
*/
void PR_ExecuteProgram (progs_t *pr, pr_func_t fnum);
@ -179,6 +180,9 @@ void PR_ExecuteProgram (progs_t *pr, pr_func_t fnum);
written
\return true if \p fnum was a progs function, false if \p fnum was
a builtin
\note Called by PR_ExecuteProgram, so the only time this should be called
is in a builtin function that calls a progs function and returns
immediately (eg, to implement `return progsfunc();`).
*/
int PR_CallFunction (progs_t *pr, pr_func_t fnum, pr_type_t *return_ptr);