dvander@554: /** dvander@554: * vim: set ts=4 : dvander@554: * =============================================================== dvander@554: * SourceMod (C)2004-2007 AlliedModders LLC. All rights reserved. dvander@554: * =============================================================== dvander@554: * dvander@554: * This file is part of the SourceMod/SourcePawn SDK. This file may only be used dvander@554: * or modified under the Terms and Conditions of its License Agreement, which is found dvander@554: * in LICENSE.txt. The Terms and Conditions for making SourceMod extensions/plugins dvander@554: * may change at any time. To view the latest information, see: dvander@554: * http://www.sourcemod.net/license.php dvander@554: * dvander@554: * Version: $Id$ dvander@554: */ dvander@554: dvander@554: #if defined _entity_included dvander@554: #endinput dvander@554: #endif dvander@554: #define _entity_included dvander@554: dvander@555: dvander@555: /** dvander@555: * For more information on these, see the HL2SDK (public/edict.h) dvander@555: */ dvander@555: #define FL_EDICT_CHANGED (1<<0) /**< Game DLL sets this when the entity state changes dvander@555: Mutually exclusive with FL_EDICT_PARTIAL_CHANGE. */ dvander@555: #define FL_EDICT_FREE (1<<1) /**< this edict if free for reuse */ dvander@555: #define FL_EDICT_FULL (1<<2) /**< this is a full server entity */ dvander@555: #define FL_EDICT_FULLCHECK (0<<0) /**< call ShouldTransmit() each time, this is a fake flag */ dvander@555: #define FL_EDICT_ALWAYS (1<<3) /**< always transmit this entity */ dvander@555: #define FL_EDICT_DONTSEND (1<<4) /**< don't transmit this entity */ dvander@555: #define FL_EDICT_PVSCHECK (1<<5) /**< always transmit entity, but cull against PVS */ dvander@555: #define FL_EDICT_PENDING_DORMANT_CHECK (1<<6) dvander@555: #define FL_EDICT_DIRTY_PVS_INFORMATION (1<<7) dvander@555: #define FL_FULL_EDICT_CHANGED (1<<8) dvander@555: dvander@554: /** dvander@554: * Returns the maximum number of entities. dvander@554: * dvander@554: * @return Maximum number of entities. dvander@554: */ dvander@554: native GetMaxEntities(); dvander@554: dvander@554: /** dvander@554: * Returns the number of entities in the server. dvander@554: * dvander@554: * @return Number of entities in the server. dvander@554: */ dvander@554: native GetEntityCount(); dvander@554: dvander@554: /** dvander@554: * Returns whether or not an entity is valid. Returns false dvander@554: * if there is no matching CBaseEntity for this edict index. dvander@554: * dvander@555: * @param edict Index of the entity/edict. dvander@554: * @return True if valid, false otherwise. dvander@554: */ dvander@554: native bool:IsValidEntity(edict); dvander@554: dvander@554: /** dvander@554: * Returns whether or not an edict index is valid. dvander@554: * dvander@554: * @param edict Index of the edict. dvander@554: * @return True if valid, false otherwise. dvander@554: */ dvander@554: native bool:IsValidEdict(edict); dvander@554: dvander@554: /** dvander@555: * Returns whether or not an entity is a valid networkable edict. dvander@555: * dvander@555: * @param edict Index of the edict. dvander@555: * @return True if networkable, false if invalid or not networkable. dvander@555: */ dvander@555: native bool:IsEntNetworkable(edict); dvander@555: dvander@555: /** dvander@554: * Creates a new edict (the basis of a networkable entity) dvander@554: * dvander@555: * @return Index of the edict, 0 on failure. dvander@554: */ dvander@554: native CreateEdict(); dvander@554: dvander@554: /** dvander@554: * Removes an edict from the world. dvander@554: * dvander@555: * @param edict Index of the edict. dvander@554: * @noreturn dvander@555: * @error Invalid edict index. dvander@554: */ dvander@554: native RemoveEdict(edict); dvander@555: dvander@555: /** dvander@555: * Returns the flags on an edict. These are not the same as entity flags. dvander@555: * dvander@555: * @param edict Index of the entity. dvander@555: * @return Edict flags. dvander@555: * @error Invalid edict index. dvander@555: */ dvander@555: native GetEdictFlags(edict); dvander@555: dvander@555: /** dvander@555: * Sets the flags on an edict. These are not the same as entity flags. dvander@555: * dvander@555: * @param edict Index of the entity. dvander@555: * @param flags Flags to set. dvander@555: * @noreturn dvander@555: * @error Invalid edict index. dvander@555: */ dvander@556: native SetEdictFlags(edict, flags); dvander@556: dvander@556: /** dvander@556: * Retrieves an edict classname. dvander@556: * dvander@556: * @param edict Index of the entity. dvander@556: * @param clsname Buffer to store the classname. dvander@556: * @param maxlength Maximum length of the buffer. dvander@556: * @return True on success, false if there is no classname set. dvander@556: */ dvander@556: native bool:GetEdictClassname(edict, String:clsname[], maxlength); dvander@556: dvander@556: /** dvander@556: * Retrieves an entity's networkable serverclass name. dvander@556: * This is not the same as the classname and is used for networkable state changes. dvander@556: * dvander@556: * @param edict Index of the entity. dvander@556: * @param clsname Buffer to store the serverclass name. dvander@556: * @param maxlength Maximum lnegth of the buffer. dvander@556: * @return True on success, false if the edict is not networkable. dvander@556: * @error Invalid edict index. dvander@556: */ dvander@556: native bool:GetEntityNetClass(edict, String:clsname[], maxlength); dvander@557: dvander@557: /** dvander@557: * @section Entity offset functions dvander@557: * dvander@557: * Offsets should be specified in byte distance from the CBaseEntity dvander@557: * structure, not short (double byte) or integer (four byte) multiples. dvander@557: * It is somewhat common practice to use offsets aligned to their final dvander@557: * type, and thus make sure you are not falling to this error in SourceMod. dvander@557: * For example, if your "integer-aligned" offset was 119, your byte-aligned dvander@557: * offset is 119*4, or 476. dvander@557: dvander@557: * Specifying incorrect offsets or the incorrect data type for an offset dvander@557: * can have fatal consequences. If you are hardcoding offsets, and the dvander@557: * layout of CBaseEntity does not match, you can easily crash the server. dvander@557: * dvander@557: * The reasonable bounds for offsets is greater than or equal to 0 and dvander@557: * below 32768. Offsets out of these bounds will throw an error. However, dvander@557: * this does not represent any real range, it is simply a sanity check for dvander@557: * illegal values. Any range outside of the CBaseEntity structure's private dvander@557: * size will cause undefined behaviour or even crash. dvander@557: */ dvander@558: dvander@558: /** dvander@558: * Marks an entity as state changed. This can be useful if you set an offset dvander@558: * and wish for it to be immediately changed over the network. By default this dvander@558: * is not done for offset setting functions. dvander@558: * dvander@558: * @param edict Index to the edict. dvander@558: * @param offset Offset to mark as changed. If 0, dvander@558: * the entire edict is marked as changed. dvander@558: * @noreturn dvander@558: * @error Invalid entity or offset out of bounds. dvander@558: */ dvander@558: native ChangeEdictState(edict, offset = 0); dvander@557: dvander@557: /** dvander@557: * Peeks into an entity's object data and retrieves the integer value at dvander@557: * the given offset. dvander@557: * dvander@557: * @param entity Edict index. dvander@557: * @param offset Offset to use. dvander@557: * @param size Number of bytes to read (valid values are 1, 2, or 4). dvander@557: * @return Value at the given memory location. dvander@557: * @error Invalid entity or offset out of reasonable bounds. dvander@557: */ dvander@557: native GetEntData(entity, offset, size=4); dvander@557: dvander@557: /** dvander@557: * Peeks into an entity's object data and sets the integer value at dvander@557: * the given offset. dvander@557: * dvander@557: * @param entity Edict index. dvander@557: * @param offset Offset to use. dvander@557: * @param size Number of bytes to write (valid values are 1, 2, or 4). dvander@557: * @return Value at the given memory location. dvander@557: * @error Invalid entity or offset out of reasonable bounds. dvander@557: * @noreturn dvander@557: */ dvander@557: native SetEntData(entity, offset, value, size=4); dvander@557: dvander@557: /** dvander@557: * Peeks into an entity's object data and retrieves the float value at dvander@557: * the given offset. dvander@557: * dvander@557: * @param entity Edict index. dvander@557: * @param offset Offset to use. dvander@557: * @return Value at the given memory location. dvander@557: * @error Invalid entity or offset out of reasonable bounds. dvander@557: */ dvander@557: native Float:GetEntDataFloat(entity, offset); dvander@557: dvander@557: /** dvander@557: * Peeks into an entity's object data and sets the integer value at dvander@557: * the given offset. dvander@557: * dvander@557: * @param entity Edict index. dvander@557: * @param offset Offset to use. dvander@557: * @return Value at the given memory location. dvander@557: * @error Invalid entity or offset out of reasonable bounds. dvander@557: * @noreturn dvander@557: */ dvander@557: native SetEntDataFloat(entity, offset, Float:value); dvander@557: dvander@557: /** dvander@557: * Peeks into an entity's object data and retrieves the entity handle dvander@557: * info at the given offset. dvander@557: * dvander@557: * @param entity Edict index. dvander@557: * @param offset Offset to use. dvander@557: * @return Entity index at the given location, or 0 if none. dvander@557: * @error Invalid entity or offset out of reasonable bounds. dvander@557: */ dvander@557: native GetEntDataEnt(entity, offset); dvander@557: dvander@557: /** dvander@557: * Peeks into an entity's object data and sest the entity handle info dvander@557: * at the given offset. dvander@557: * dvander@557: * @param entity Edict index. dvander@557: * @param offset Offset to use. dvander@557: * @param other Entity index to set, or 0 to clear. dvander@557: * @noreturn dvander@557: * @error Invalid entity or offset out of reasonable bounds. dvander@557: */ dvander@557: native SetEntDataEnt(entity, offset, other); dvander@557: dvander@557: /** dvander@557: * Peeks into an entity's object data and retrieves the vector at the dvander@557: * given offset. dvander@557: * @note Both a Vector and a QAngle are three floats. This is a dvander@557: * convenience function and will work with both types. dvander@557: * dvander@557: * @param entity Edict index. dvander@557: * @param offset Offset to use. dvander@557: * @param vec Vector buffer to store data in. dvander@557: * @noreturn dvander@557: * @error Invalid entity or offset out of reasonable bounds. dvander@557: */ dvander@557: native GetEntDataVector(entity, offset, Float:vec[3]); dvander@557: dvander@557: /** dvander@557: * Peeks into an entity's object data and sets the vector at the given dvander@557: * offset. dvander@557: * @note Both a Vector and a QAngle are three floats. This is a dvander@557: * convenience function and will work with both types. dvander@557: * dvander@557: * @param entity Edict index. dvander@557: * @param offset Offset to use. dvander@557: * @param vec Vector to set. dvander@557: * @noreturn dvander@557: * @error Invalid entity or offset out of reasonable bounds. dvander@557: */ dvander@557: native SetEntDataVector(entity, offset, const Float:vec[3]);