Improve documentation in engine_const.inc (#665)

This commit is contained in:
voed 2019-02-11 13:15:45 +02:00 committed by Vincent Herbet
parent f392c90729
commit f623126fe1

View File

@ -12,7 +12,7 @@
// //
#if defined _engine_const_included #if defined _engine_const_included
#endinput #endinput
#endif #endif
#define _engine_const_included #define _engine_const_included
@ -212,54 +212,63 @@ enum {
*/ */
#if defined _jghg_enums #if defined _jghg_enums
#endinput #endinput
#endif #endif
#define _jghg_enums #define _jghg_enums
/**
* Used by get_global_[edict/float/int/string/vector]()
*/
enum { enum {
// Edict
GL_trace_ent = 0,
// Float // Edict
GL_coop, GL_trace_ent = 0,
GL_deathmatch,
GL_force_retouch,
GL_found_secrets,
GL_frametime,
GL_serverflags,
GL_teamplay,
GL_time,
GL_trace_allsolid,
GL_trace_fraction,
GL_trace_inopen,
GL_trace_inwater,
GL_trace_plane_dist,
GL_trace_startsolid,
// Int // Float
GL_cdAudioTrack, GL_coop,
GL_maxClients, GL_deathmatch,
GL_maxEntities, GL_force_retouch,
GL_msg_entity, GL_found_secrets,
GL_trace_flags, GL_frametime,
GL_trace_hitgroup, GL_serverflags,
GL_teamplay,
GL_time,
GL_trace_allsolid,
GL_trace_fraction,
GL_trace_inopen,
GL_trace_inwater,
GL_trace_plane_dist,
GL_trace_startsolid,
// String // Int
GL_pStringBase, GL_cdAudioTrack,
GL_mapname, GL_maxClients,
GL_startspot, GL_maxEntities,
GL_msg_entity,
GL_trace_flags,
GL_trace_hitgroup,
// Vector // String
GL_trace_endpos, GL_pStringBase,
GL_trace_plane_normal, GL_mapname,
GL_v_forward, GL_startspot,
GL_v_right,
GL_v_up,
GL_vecLandmarkOffset,
// Void (not supported) // Vector
GL_pSaveData GL_trace_endpos,
GL_trace_plane_normal,
GL_v_forward,
GL_v_right,
GL_v_up,
GL_vecLandmarkOffset,
// Void (not supported)
GL_pSaveData
}; };
/**
* Used by [get/set]_usercmd()
*/
enum enum
{ {
usercmd_float_start, usercmd_float_start,
@ -282,7 +291,9 @@ enum
usercmd_vec_end usercmd_vec_end
}; };
// Used by the traceresult() native. /**
* Used by the traceresult()
*/
enum enum
{ {
TR_AllSolid, // (int) if true, plane is not valid TR_AllSolid, // (int) if true, plane is not valid