Skip to content

Commit

Permalink
LuaConstCOB.cpp: Update Lua docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@rhys-vdw
rhys-vdw committed Nov 17, 2024
1 parent f9d2bc7 commit 9e70eb3
Showing 1 changed file with 109 additions and 105 deletions.
214 changes: 109 additions & 105 deletions rts/Lua/LuaConstCOB.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,85 +19,86 @@ bool LuaConstCOB::PushEntries(lua_State* L)
{
#define PUSH_COB(cmd) LuaPushNamedNumber(L, #cmd, cmd)

/*** @class COB
*
* @param number ACTIVATION
* @param number STANDINGMOVEORDERS
* @param number STANDINGFIREORDERS
* @param number HEALTH
* @param number INBUILDSTANCE
* @param number BUSY
* @param number PIECE_XZ
* @param number PIECE_Y
* @param number UNIT_XZ
* @param number UNIT_Y
* @param number UNIT_HEIGHT
* @param number XZ_ATAN
* @param number XZ_HYPOT
* @param number ATAN
* @param number HYPOT
* @param number GROUND_HEIGHT
* @param number BUILD_PERCENT_LEFT
* @param number YARD_OPEN
* @param number BUGGER_OFF
* @param number ARMORED
* @param number IN_WATER
* @param number CURRENT_SPEED
* @param number VETERAN_LEVEL
* @param number ON_ROAD
* @param number MAX_ID
* @param number MY_ID
* @param number UNIT_TEAM
* @param number UNIT_BUILD_PERCENT_LEFT
* @param number UNIT_ALLIED
* @param number MAX_SPEED
* @param number CLOAKED
* @param number WANT_CLOAK
* @param number GROUND_WATER_HEIGHT
* @param number UPRIGHT
* @param number POW
* @param number PRINT
* @param number HEADING
* @param number TARGET_ID
* @param number LAST_ATTACKER_ID
* @param number LOS_RADIUS
* @param number AIR_LOS_RADIUS
* @param number RADAR_RADIUS
* @param number JAMMER_RADIUS
* @param number SONAR_RADIUS
* @param number SONAR_JAM_RADIUS
* @param number SEISMIC_RADIUS
* @param number DO_SEISMIC_PING
* @param number CURRENT_FUEL
* @param number TRANSPORT_ID
* @param number SHIELD_POWER
* @param number STEALTH
* @param number CRASHING
* @param number CHANGE_TARGET
* @param number CEG_DAMAGE
* @param number COB_ID
* @param number PLAY_SOUND
* @param number KILL_UNIT
* @param number ALPHA_THRESHOLD
* @param number SET_WEAPON_UNIT_TARGET
* @param number SET_WEAPON_GROUND_TARGET
* @param number SONAR_STEALTH
* @param number REVERSING
* @param number FLANK_B_MODE
* @param number FLANK_B_DIR
* @param number FLANK_B_MOBILITY_ADD
* @param number FLANK_B_MAX_DAMAGE
* @param number FLANK_B_MIN_DAMAGE
* @param number WEAPON_RELOADSTATE
* @param number WEAPON_RELOADTIME
* @param number WEAPON_ACCURACY
* @param number WEAPON_SPRAY
* @param number WEAPON_RANGE
* @param number WEAPON_PROJECTILE_SPEED
* @param number MIN
* @param number MAX
* @param number ABS
* @param number GAME_FRAME
/***
* @class COB
* @metatable COB
* @field ACTIVATION number
* @field STANDINGMOVEORDERS number
* @field STANDINGFIREORDERS number
* @field HEALTH number
* @field INBUILDSTANCE number
* @field BUSY number
* @field PIECE_XZ number
* @field PIECE_Y number
* @field UNIT_XZ number
* @field UNIT_Y number
* @field UNIT_HEIGHT number
* @field XZ_ATAN number
* @field XZ_HYPOT number
* @field ATAN number
* @field HYPOT number
* @field GROUND_HEIGHT number
* @field BUILD_PERCENT_LEFT number
* @field YARD_OPEN number
* @field BUGGER_OFF number
* @field ARMORED number
* @field IN_WATER number
* @field CURRENT_SPEED number
* @field VETERAN_LEVEL number
* @field ON_ROAD number
* @field MAX_ID number
* @field MY_ID number
* @field UNIT_TEAM number
* @field UNIT_BUILD_PERCENT_LEFT number
* @field UNIT_ALLIED number
* @field MAX_SPEED number
* @field CLOAKED number
* @field WANT_CLOAK number
* @field GROUND_WATER_HEIGHT number
* @field UPRIGHT number
* @field POW number
* @field PRINT number
* @field HEADING number
* @field TARGET_ID number
* @field LAST_ATTACKER_ID number
* @field LOS_RADIUS number
* @field AIR_LOS_RADIUS number
* @field RADAR_RADIUS number
* @field JAMMER_RADIUS number
* @field SONAR_RADIUS number
* @field SONAR_JAM_RADIUS number
* @field SEISMIC_RADIUS number
* @field DO_SEISMIC_PING number
* @field CURRENT_FUEL number
* @field TRANSPORT_ID number
* @field SHIELD_POWER number
* @field STEALTH number
* @field CRASHING number
* @field CHANGE_TARGET number
* @field CEG_DAMAGE number
* @field COB_ID number
* @field PLAY_SOUND number
* @field KILL_UNIT number
* @field ALPHA_THRESHOLD number
* @field SET_WEAPON_UNIT_TARGET number
* @field SET_WEAPON_GROUND_TARGET number
* @field SONAR_STEALTH number
* @field REVERSING number
* @field FLANK_B_MODE number
* @field FLANK_B_DIR number
* @field FLANK_B_MOBILITY_ADD number
* @field FLANK_B_MAX_DAMAGE number
* @field FLANK_B_MIN_DAMAGE number
* @field WEAPON_RELOADSTATE number
* @field WEAPON_RELOADTIME number
* @field WEAPON_ACCURACY number
* @field WEAPON_SPRAY number
* @field WEAPON_RANGE number
* @field WEAPON_PROJECTILE_SPEED number
* @field MIN number
* @field MAX number
* @field ABS number
* @field GAME_FRAME number
*/

PUSH_COB(ACTIVATION);
Expand Down Expand Up @@ -200,20 +201,24 @@ bool LuaConstCOB::PushEntries(lua_State* L)

bool LuaConstSFX::PushEntries(lua_State* L)
{
/*** Piece Flags for Spring.UnitScript.Explode
*
/***
* @class SFX
*
* @param number SHATTER
* @param number EXPLODE
* @param number EXPLODE_ON_HIT
* @param number FALL
* @param number SMOKE
* @param number FIRE
* @param number NONE
* @param number NO_CEG_TRAIL
* @param number NO_HEATCLOUD
* @param number RECURSIVE
* @metatable SFX
*/

/* Piece Flags for Spring.UnitScript.Explode */
/***
* @class SFX
* @field SHATTER number
* @field EXPLODE number
* @field EXPLODE_ON_HIT number
* @field FALL number
* @field SMOKE number
* @field FIRE number
* @field NONE number
* @field NO_CEG_TRAIL number
* @field NO_HEATCLOUD number
* @field RECURSIVE number
*/
LuaPushNamedNumber(L, "SHATTER", PF_Shatter);
LuaPushNamedNumber(L, "EXPLODE", PF_Explode);
Expand All @@ -226,20 +231,19 @@ bool LuaConstSFX::PushEntries(lua_State* L)
LuaPushNamedNumber(L, "NO_HEATCLOUD", PF_NoHeatCloud);
LuaPushNamedNumber(L, "RECURSIVE", PF_Recursive);

/*** For Spring.UnitScript.EmitSfx
*
/* For Spring.UnitScript.EmitSfx */
/***
* @class SFX
*
* @param number VTOL
* @param number WAKE
* @param number REVERSE_WAKE
* @param number WHITE_SMOKE
* @param number BLACK_SMOKE
* @param number BUBBLE
* @param number CEG
* @param number FIRE_WEAPON
* @param number DETONATE_WEAPON
* @param number GLOBAL
* @field VTOL number
* @field WAKE number
* @field REVERSE_WAKE number
* @field WHITE_SMOKE number
* @field BLACK_SMOKE number
* @field BUBBLE number
* @field CEG number
* @field FIRE_WEAPON number
* @field DETONATE_WEAPON number
* @field GLOBAL number
*/
LuaPushNamedNumber(L, "VTOL", SFX_VTOL);
LuaPushNamedNumber(L, "WAKE", SFX_WAKE);
Expand Down

0 comments on commit 9e70eb3

Please sign in to comment.