diff --git a/plugins/include/engine_const.inc b/plugins/include/engine_const.inc index 9a88dec6..c48bbda2 100755 --- a/plugins/include/engine_const.inc +++ b/plugins/include/engine_const.inc @@ -18,17 +18,35 @@ #include -#define SPEAK_NORMAL 0 -#define SPEAK_MUTED 1 -#define SPEAK_ALL 2 -#define SPEAK_LISTENALL 4 +/** + * Flags for the [set|get]_speak() natives. + * + * @note These do not correspond to any HLSDK constants and are only relevant to + * the custom functionality provided by the engine module. + */ +#define SPEAK_NORMAL 0 // Normal behavior, client follows alltalk rules +#define SPEAK_MUTED 1 // Client can not talk +#define SPEAK_ALL 2 // Client can talk to every other client +#define SPEAK_LISTENALL 4 // Client can listen to every other client -#define CAMERA_NONE 0 -#define CAMERA_3RDPERSON 1 -#define CAMERA_UPLEFT 2 -#define CAMERA_TOPDOWN 3 +/** + * View types for the set_view() native. + * + * @note These do not correspond to any HLSDK constants and are only relevant to + * the custom functionality provided by the engine module. + */ +#define CAMERA_NONE 0 +#define CAMERA_3RDPERSON 1 +#define CAMERA_UPLEFT 2 +#define CAMERA_TOPDOWN 3 -/* Int */ +/** + * @section Entvar constants used with entity_[get|set]_* functions. + */ + +/** + * Integers, use with entity_[get|set]_int() + */ enum { EV_INT_gamestate = 0, EV_INT_oldbuttons, @@ -69,7 +87,9 @@ enum { EV_INT_deadflag, }; -/* Float */ +/** + * Floats, use with entity_[get|set]_float() + */ enum { EV_FL_impacttime = 0, EV_FL_starttime, @@ -110,7 +130,9 @@ enum { EV_FL_fuser4, }; -/* Vector */ +/** + * Vectors, use with entity_[get|set]_vector() + */ enum { EV_VEC_origin = 0, EV_VEC_oldorigin, @@ -137,7 +159,9 @@ enum { EV_VEC_vuser4, }; -/* Edict */ +/** + * Edicts, use with entity_[get|set]_edict() + */ enum { EV_ENT_chain = 0, EV_ENT_dmg_inflictor, @@ -152,7 +176,9 @@ enum { EV_ENT_euser4, }; -/* String */ +/** + * Strings, use with entity_[get|set]_string() + */ enum { EV_SZ_classname = 0, EV_SZ_globalname, @@ -169,7 +195,9 @@ enum { EV_SZ_weaponmodel, }; -/* Byte */ +/** + * Bytearrays, use with entity_[get|set]_byte() + */ enum { EV_BYTE_controller1 = 0, EV_BYTE_controller2, @@ -179,6 +207,10 @@ enum { EV_BYTE_blending2, }; +/** + * @endsection + */ + #if defined _jghg_enums #endinput #endif @@ -231,37 +263,37 @@ enum { enum { usercmd_float_start, - usercmd_forwardmove, // Float - usercmd_sidemove, // Float - usercmd_upmove, // Float + usercmd_forwardmove, // Float + usercmd_sidemove, // Float + usercmd_upmove, // Float usercmd_float_end, usercmd_int_start, - usercmd_lerp_msec, // short - usercmd_msec, // byte - usercmd_lightlevel, // byte - usercmd_buttons, // unsigned short - usercmd_impulse, // byte - usercmd_weaponselect, // byte - usercmd_impact_index, // int + usercmd_lerp_msec, // short + usercmd_msec, // byte + usercmd_lightlevel, // byte + usercmd_buttons, // unsigned short + usercmd_impulse, // byte + usercmd_weaponselect, // byte + usercmd_impact_index, // int usercmd_int_end, usercmd_vec_start, - usercmd_viewangles, // Vector - usercmd_impact_position, // vec + usercmd_viewangles, // Vector + usercmd_impact_position, // vec usercmd_vec_end }; // Used by the traceresult() native. enum { - TR_AllSolid, // (int) if true, plane is not valid - TR_StartSolid, // (int) if true, the initial point was in a solid area - TR_InOpen, // (int) - TR_InWater, // (int) - TR_Fraction, // (float) time completed, 1.0 = didn't hit anything - TR_EndPos, // (vector) final position - TR_PlaneDist, // (float) - TR_PlaneNormal, // (vector) surface normal at impact - TR_Hit, // (entity) entity the surface is on - TR_Hitgroup // (int) 0 == generic, non zero is specific body part + TR_AllSolid, // (int) if true, plane is not valid + TR_StartSolid, // (int) if true, the initial point was in a solid area + TR_InOpen, // (int) + TR_InWater, // (int) + TR_Fraction, // (float) time completed, 1.0 = didn't hit anything + TR_EndPos, // (vector) final position + TR_PlaneDist, // (float) + TR_PlaneNormal, // (vector) surface normal at impact + TR_Hit, // (entity) entity the surface is on + TR_Hitgroup // (int) 0 == generic, non zero is specific body part };