Flummi/amxmodx
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Engine: Clarify difference between the engine module trace handle and the "real" global trace

Browse Source
This commit is contained in:
Valentin Grünbacher 2015-05-11 00:10:25 +02:00
parent ebdd015aae
commit ee0bcc39f1
1 changed files with 9 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
plugins/include/engine.inc
View File

@ -25,7 +25,7 @@
#endif #endif
/** /**
* Retrieves a result from the global trace handle. * Retrieves a result from the global engine module trace handle.
* *
* @note For a list of trace results available see the TR_* constants in * @note For a list of trace results available see the TR_* constants in
* engine_const.inc. * engine_const.inc.
@ -964,8 +964,8 @@ native is_visible(entity, target);
* Fires a trace line between two origins, retrieving the end point and entity * Fires a trace line between two origins, retrieving the end point and entity
* hit. * hit.
* *
* @note This native writes to the global trace handle. Additional trace results * @note This native writes to the global engine module trace handle. Additional
* can be retrieved using traceresult(). * trace results can be retrieved using traceresult().
* @note This native returns 0 if the trace did not hit anything. As 0 is an * @note This native returns 0 if the trace did not hit anything. As 0 is an
* entity index that is considered to be a valid value for a trace hit * entity index that is considered to be a valid value for a trace hit
* ("worldspawn"), this native can potentially return a misleading value. * ("worldspawn"), this native can potentially return a misleading value.
@ -984,8 +984,8 @@ native trace_line(iIgnoreEnt, const Float:fStart[3], const Float:fEnd[3], Float:
/** /**
* Fires a trace line between two origins, retrieving the trace normal. * Fires a trace line between two origins, retrieving the trace normal.
* *
* @note This native writes to the global trace handle. Additional trace results * @note This native writes to the global engine module trace handle. Additional
* can be retrieved using traceresult(). * trace results can be retrieved using traceresult().
* *
* @param iIgnoreEnt Entity index that trace will ignore, -1 if trace should * @param iIgnoreEnt Entity index that trace will ignore, -1 if trace should
* not ignore any entities * not ignore any entities
@ -1001,8 +1001,8 @@ native trace_normal(iIgnoreEnt, const Float:fStart[3], const Float:fEnd[3], Floa
/** /**
* Fires a trace hull on a specified origin or between two origins. * Fires a trace hull on a specified origin or between two origins.
* *
* @note This native writes to the global trace handle. Additional trace results * @note This native writes to the global engine module trace handle. Additional
* can be retrieved using traceresult(). * trace results can be retrieved using traceresult().
* @note For a list of valid hull types see the HULL_* constants in * @note For a list of valid hull types see the HULL_* constants in
* hlsdk_const.inc * hlsdk_const.inc
* @note For a list of valid ignore types see the *IGNORE_* constants in * @note For a list of valid ignore types see the *IGNORE_* constants in
@ -1024,7 +1024,8 @@ native trace_hull(const Float:origin[3], hull, ignoredent = 0, ignoremonsters =
* direction, offset on the z-axis around an origin. * direction, offset on the z-axis around an origin.
* *
* @note The functionality of this native can mostly be replaced by a single * @note The functionality of this native can mostly be replaced by a single
* hull trace. This native does not write to the global trace handle. * hull trace. This native does not write to the global engine module
* trace handle.
* @note This native is intended to examine an obstacle in front of a standing * @note This native is intended to examine an obstacle in front of a standing
* player. Start should usually be the origin of a client while angle * player. Start should usually be the origin of a client while angle
* should be its forward angle vector. 73 traces are fired, each offset by * should be its forward angle vector. 73 traces are fired, each offset by