ubergames/rpgxef
0
0
Fork 0
mirror of https://github.com/UberGames/rpgxEF.git synced 2024-11-10 07:11:34 +00:00
Code Issues Projects Releases Packages Wiki Activity

Update code/game/lua_mover.c

Browse source 
Added an example for a parseable comment describing a Lua function (mover.AsTrain).
Add some point all comments should look like this. I'm writing a program that'll parse them and convert them into latex.
This commit is contained in:
Walter Julius Hennecke 2012-11-26 11:24:22 +01:00
parent 5500407c65
commit 460b7da012
1 changed files with 8 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
code/game/lua_mover.c
View file

@ -69,6 +69,14 @@ extern void Reached_Train(gentity_t *ent);
extern void Think_SetupTrainTargets(gentity_t *ent);
extern void SetMoverState(gentity_t *ent, moverState_t moverState, int time);
/* This is an example for a parseable comment that describes a lua function. */
/*
* \function mover.AsTrain(entity mover, entity target, float speed)
* \param entity mover entity to move.
* \param entity target path_corner entity to move to.
* \param float speed Speed to move with to the first path_corner.
* \desc Moves an entity like a func_train entity. Targets have to be path_corner entities.
*/
// mover.AsTrain(entity mover, entity target, float speed)
// Moves an entity like a func_train entity. Targets have to be path_corner entities.
// * ent the entity to move