dvander@554: /**
dvander@554: * vim: set ts=4 :
ds@1330: * =============================================================================
skamonkey@3293: * SourceMod (C)2004-2011 AlliedModders LLC. All rights reserved.
ds@1330: * =============================================================================
ds@1330: *
ds@1330: * This file is part of the SourceMod/SourcePawn SDK.
dvander@554: *
ds@1330: * This program is free software; you can redistribute it and/or modify it under
ds@1330: * the terms of the GNU General Public License, version 3.0, as published by the
ds@1330: * Free Software Foundation.
ds@1330: *
ds@1330: * This program is distributed in the hope that it will be useful, but WITHOUT
ds@1330: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
ds@1330: * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
ds@1330: * details.
ds@1330: *
ds@1330: * You should have received a copy of the GNU General Public License along with
ds@1330: * this program. If not, see .
ds@1330: *
ds@1330: * As a special exception, AlliedModders LLC gives you permission to link the
ds@1330: * code of this program (as well as its derivative works) to "Half-Life 2," the
ds@1330: * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
ds@1330: * by the Valve Corporation. You must obey the GNU General Public License in
ds@1330: * all respects for all other code used. Additionally, AlliedModders LLC grants
ds@1330: * this exception to all derivative works. AlliedModders LLC defines further
ds@1330: * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
ds@1330: * or .
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@610: /**
dvander@610: * Property types for entities.
dvander@610: */
dvander@610: enum PropType
dvander@610: {
dvander@610: Prop_Send = 0, /**< This property is networked. */
dvander@1847: Prop_Data = 1, /**< This property is for save game data fields. */
dvander@610: };
dvander@555:
dvander@555: /**
faluco@1040: * @section For more information on these, see the HL2SDK (public/edict.h)
dvander@555: */
faluco@1040: #define FL_EDICT_CHANGED (1<<0) /**< Game DLL sets this when the entity state changes
dvander@555: Mutually exclusive with FL_EDICT_PARTIAL_CHANGE. */
faluco@1040: #define FL_EDICT_FREE (1<<1) /**< this edict if free for reuse */
faluco@1040: #define FL_EDICT_FULL (1<<2) /**< this is a full server entity */
faluco@1040: #define FL_EDICT_FULLCHECK (0<<0) /**< call ShouldTransmit() each time, this is a fake flag */
faluco@1040: #define FL_EDICT_ALWAYS (1<<3) /**< always transmit this entity */
faluco@1040: #define FL_EDICT_DONTSEND (1<<4) /**< don't transmit this entity */
faluco@1040: #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)
faluco@1040: #define FL_FULL_EDICT_CHANGED (1<<8)
faluco@1040:
dvander@1847: enum PropFieldType
dvander@1847: {
dvander@1847: PropField_Unsupported, /**< The type is unsupported. */
dvander@1847: PropField_Integer, /**< Valid for SendProp and Data fields */
dvander@1847: PropField_Float, /**< Valid for SendProp and Data fields */
dvander@1847: PropField_Entity, /**< Valid for Data fields only (SendProp shows as int) */
dvander@1847: PropField_Vector, /**< Valid for SendProp and Data fields */
dvander@1847: PropField_String, /**< Valid for SendProp and Data fields */
dvander@1884: PropField_String_T, /**< Valid for Data fields. Read only.
dvander@1884: Note that the size of a string_t is dynamic, and
dvander@1884: thus FindDataMapOffs() will return the constant size
dvander@1884: of the string_t container (which is 32 bits right now).
dvander@1884: */
dvander@1847: };
dvander@1847:
faluco@1040: /**
faluco@1040: * @endsection
faluco@1040: */
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@561: * @param changeState If true, change will be sent over the network.
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@1837: native SetEntData(entity, offset, any:value, size=4, bool:changeState=false);
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: /**
mibusby@3330: * Peeks into an entity's object data and sets 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@561: * @param changeState If true, change will be sent over the network.
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@561: native SetEntDataFloat(entity, offset, Float:value, bool:changeState=false);
dvander@557:
dvander@557: /**
dvander@1847: * This function is deprecated. Use GetEntDataEnt2 instead, for
dvander@1847: * reasons explained in the notes.
dvander@1847: *
dvander@1847: * Note: This function returns 0 on failure, which may be misleading,
dvander@1847: * as the number 0 is also used for the world entity index.
dvander@1847: *
dvander@1847: * Note: This function makes no attempt to validate the returned
dvander@1847: * entity, and in fact, it could be garbage or completely unexpected.
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: */
ds@2098: #pragma deprecated Use GetEntDataEnt2() instead.
dvander@557: native GetEntDataEnt(entity, offset);
dvander@557:
dvander@557: /**
ds@2098: * This function is deprecated. Use SetEntDataEnt2 instead, for
dvander@1847: * reasons explained in the notes.
dvander@1847: *
dvander@1847: * Note: This function uses 0 as an indicator to unset data, but
dvander@1847: * 0 is also the world entity index. Thus, the a property cannot
dvander@1847: * be set to the world entity using this native.
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@561: * @param changeState If true, change will be sent over the network.
dvander@557: * @noreturn
dvander@557: * @error Invalid entity or offset out of reasonable bounds.
dvander@557: */
ds@2098: #pragma deprecated Use SetEntDataEnt2() instead.
dvander@561: native SetEntDataEnt(entity, offset, other, bool:changeState=false);
dvander@557:
dvander@557: /**
dvander@1847: * Peeks into an entity's object data and retrieves the entity index
dvander@1847: * at the given offset.
dvander@1847: *
dvander@1847: * Note: This will only work on offsets that are stored as "entity
dvander@1847: * handles" (which usually looks like m_h* in properties). These
dvander@1847: * are not SourceMod Handles, but internal Source structures.
dvander@1847: *
dvander@1847: * @param entity Edict index.
dvander@1847: * @param offset Offset to use.
dvander@1847: * @return Entity index at the given location. If there is no entity,
dvander@1847: * or the stored entity is invalid, then -1 is returned.
dvander@1847: * @error Invalid input entity, or offset out of reasonable bounds.
dvander@1847: */
dvander@1847: native GetEntDataEnt2(entity, offset);
dvander@1847:
dvander@1847: /**
dvander@1847: * Peeks into an entity's object data and sets the entity index at the
dvander@1847: * given offset.
dvander@1847: *
dvander@1847: * Note: This will only work on offsets that are stored as "entity
dvander@1847: * handles" (which usually looks like m_h* in properties). These
dvander@1847: * are not SourceMod Handles, but internal Source structures.
dvander@1847: *
dvander@1847: * @param entity Edict index.
dvander@1847: * @param offset Offset to use.
dvander@1847: * @param other Entity index to set, or -1 to clear.
dvander@1847: * @param changeState If true, change will be sent over the network.
dvander@1847: * @noreturn
dvander@1847: * @error Invalid input entity, or offset out of reasonable bounds.
dvander@1847: */
dvander@1847: native SetEntDataEnt2(entity, offset, other, bool:changeState=false);
dvander@1847:
dvander@1847: /**
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@561: * @param changeState If true, change will be sent over the network.
dvander@557: * @noreturn
dvander@557: * @error Invalid entity or offset out of reasonable bounds.
dvander@557: */
dvander@561: native SetEntDataVector(entity, offset, const Float:vec[3], bool:changeState=false);
dvander@561:
dvander@561: /**
faluco@694: * Peeks into an entity's object data and retrieves the string at
faluco@694: * the given offset.
faluco@694: *
faluco@694: * @param entity Edict index.
faluco@694: * @param offset Offset to use.
faluco@694: * @param buffer Destination string buffer.
faluco@694: * @param maxlen Maximum length of output string buffer.
faluco@694: * @return Number of non-null bytes written.
faluco@694: * @error Invalid entity or offset out of reasonable bounds.
faluco@694: */
faluco@694: native GetEntDataString(entity, offset, String:buffer[], maxlen);
faluco@694:
faluco@694: /**
faluco@694: * Peeks into an entity's object data and sets the string at
faluco@694: * the given offset.
faluco@694: *
faluco@694: * @param entity Edict index.
faluco@694: * @param offset Offset to use.
faluco@694: * @param buffer String to set.
faluco@694: * @param maxlen Maximum length of bytes to write.
faluco@694: * @param changeState If true, change will be sent over the network.
faluco@694: * @return Number of non-null bytes written.
faluco@694: * @error Invalid entity or offset out of reasonable bounds.
faluco@694: */
faluco@694: native SetEntDataString(entity, offset, const String:buffer[], maxlen, bool:changeState=false);
faluco@694:
faluco@694: /**
dvander@619: * @endsection
dvander@619: */
dvander@619:
dvander@619: /**
dvander@561: * Given a ServerClass name, finds a networkable send property offset.
dvander@561: * This information is cached for future calls.
dvander@561: *
dvander@1847: * Note, this function may return offsets that do not work!
dvander@1847: * If a property is nested beneath a parent object, the resulting offset
dvander@1847: * will be invalid for direct use with data functions. Therefore, you
dvander@1847: * should use FindSendPropInfo() instead. An example of such a property is
dvander@1847: * CTFPlayer::DT_LocalPlayer.m_nDisguiseClass on Team Fortress.
dvander@1847: *
dvander@561: * @param cls Classname.
dvander@561: * @param prop Property name.
dvander@561: * @return An offset, or -1 on failure.
dvander@561: */
dvander@561: native FindSendPropOffs(const String:cls[], const String:prop[]);
dvander@561:
dvander@561: /**
dvander@1847: * Given a ServerClass name, finds a networkable send property offset.
dvander@1847: * This information is cached for future calls.
dvander@1847: *
dvander@1847: * Note: This function will correctly compute nested offsets, unlike
dvander@1847: * FindSendPropOffs(). YOU SHOULD NOT use this function to self-compute
dvander@1847: * nested offsets. For example, it is okay to add indexes for arrays,
dvander@1847: * but not to add DT_LocalPlayer to m_nDisguiseClass.
dvander@1847: *
dvander@1847: * @param cls Classname.
dvander@1847: * @param prop Property name.
dvander@1847: * @param type Optional parameter to store the type.
dvander@1847: * @param num_bits Optional parameter to store the number of bits the field
dvander@1847: * uses, if applicable (otherwise 0 is stored). The number
dvander@1847: * of bits varies for integers and floats, and is always 0
dvander@1847: * for strings.
dvander@1847: * @param local_offset Optional parameter to store the local offset, as
dvander@1847: * FindSendPropOffs() would return.
dvander@1847: * @return On success, returns an absolutely computed offset.
dvander@1847: * If no offset is available, 0 is returned.
dvander@1847: * If the property is not found, -1 is returned.
dvander@1847: */
dvander@1847: native FindSendPropInfo(const String:cls[],
dvander@1847: const String:prop[],
dvander@1847: &PropFieldType:type=PropFieldType:0,
dvander@1847: &num_bits=0,
dvander@1847: &local_offset=0);
dvander@1847:
dvander@1847: /**
faluco@682: * Given an entity, finds a datamap property offset.
faluco@682: * This information is cached for future calls.
faluco@682: *
faluco@682: * @param entity Entity index.
faluco@682: * @param prop Property name.
dvander@1847: * @param type Optional parameter to store the type.
dvander@1847: * @param num_bits Optional parameter to store the number of bits the field
dvander@1847: * uses. The bit count will either be 1 (for boolean) or
dvander@1847: * divisible by 8 (including 0 if unknown).
faluco@682: * @return An offset, or -1 on failure.
faluco@682: */
dvander@1847: native FindDataMapOffs(entity,
dvander@1847: const String:prop[],
dvander@1847: &PropFieldType:type=PropFieldType:0,
dvander@1847: &num_bits=0);
faluco@682:
faluco@682: /**
dvander@561: * Wrapper function for finding a send property for a particular entity.
dvander@561: *
dvander@561: * @param ent Entity index.
dvander@561: * @param prop Property name.
dvander@1847: * @param actual Defaults to false for backwards compatibility.
dvander@1847: * If true, the newer FindSendPropInfo() function
dvander@1847: * is used instead.
dvander@561: * @return An offset, or -1 on failure.
dvander@561: */
dvander@1847: stock GetEntSendPropOffs(ent, const String:prop[], bool:actual=false)
dvander@561: {
dvander@561: decl String:cls[64];
dvander@561:
dvander@561: if (!GetEntityNetClass(ent, cls, sizeof(cls)))
dvander@561: {
dvander@561: return -1;
dvander@561: }
dvander@561:
dvander@1847: if (actual)
dvander@1847: {
dvander@1847: return FindSendPropInfo(cls, prop);
dvander@1847: }
dvander@1847: else
dvander@1847: {
dvander@1847: return FindSendPropOffs(cls, prop);
dvander@1847: }
dvander@561: }
dvander@561:
dvander@561: /**
dvander@1847: * Retrieves an integer value from an entity's property.
dvander@1847: *
dvander@1847: * This function is considered safer and more robust over GetEntData,
dvander@2337: * because it performs strict offset checking and typing rules.
dvander@561: *
dvander@1847: * @param entity Entity/edict index.
dvander@610: * @param type Property type.
dvander@1847: * @param prop Property name.
dvander@1847: * @param size Number of bytes to write (valid values are 1, 2, or 4).
dvander@1847: * This value is auto-detected, and the size parameter is
dvander@1847: * only used as a fallback in case detection fails.
skamonkey@3293: * @param element Element # (starting from 0) if property is an array.
dvander@561: * @return Value at the given property offset.
dvander@561: * @error Invalid entity or property not found.
dvander@561: */
skamonkey@3293: native GetEntProp(entity, PropType:type, const String:prop[], size=4, element=0);
dvander@561:
dvander@561: /**
dvander@1847: * Sets an integer value in an entity's property.
dvander@561: *
dvander@1847: * This function is considered safer and more robust over SetEntData,
dvander@2337: * because it performs strict offset checking and typing rules.
dvander@1847: *
dvander@1847: * @param entity Entity/edict index.
dvander@610: * @param type Property type.
dvander@1847: * @param prop Property name.
skamonkey@3293: * @param value Value to set.
dvander@561: * @param size Number of bytes to write (valid values are 1, 2, or 4).
dvander@1847: * This value is auto-detected, and the size parameter is
dvander@1847: * only used as a fallback in case detection fails.
skamonkey@3293: * @param element Element # (starting from 0) if property is an array.
dvander@561: * @error Invalid entity or offset out of reasonable bounds.
dvander@561: * @noreturn
dvander@561: */
skamonkey@3293: native SetEntProp(entity, PropType:type, const String:prop[], any:value, size=4, element=0);
dvander@561:
dvander@561: /**
dvander@1847: * Retrieves a float value from an entity's property.
dvander@1847: *
dvander@1847: * This function is considered safer and more robust over GetEntDataFloat,
dvander@2337: * because it performs strict offset checking and typing rules.
dvander@561: *
dvander@1847: * @param entity Entity/edict index.
dvander@610: * @param type Property type.
dvander@1847: * @param prop Property name.
skamonkey@3293: * @param element Element # (starting from 0) if property is an array.
faluco@694: * @return Value at the given property offset.
dvander@561: * @error Invalid entity or offset out of reasonable bounds.
dvander@561: */
skamonkey@3293: native Float:GetEntPropFloat(entity, PropType:type, const String:prop[], element=0);
dvander@561:
dvander@561: /**
dvander@1847: * Sets a float value in an entity's property.
dvander@1847: *
dvander@1847: * This function is considered safer and more robust over SetEntDataFloat,
dvander@2337: * because it performs strict offset checking and typing rules.
dvander@561: *
dvander@1847: * @param entity Entity/edict index.
dvander@610: * @param type Property type.
dvander@1847: * @param prop Property name.
dvander@561: * @param value Value to set.
skamonkey@3293: * @param element Element # (starting from 0) if property is an array.
dvander@561: * @noreturn
dvander@561: * @error Invalid entity or offset out of reasonable bounds.
dvander@561: */
skamonkey@3293: native SetEntPropFloat(entity, PropType:type, const String:prop[], Float:value, element=0);
dvander@561:
dvander@561: /**
dvander@1847: * Retrieves an entity index from an entity's property.
dvander@1847: *
dvander@1847: * This function is considered safer and more robust over GetEntDataEnt*,
dvander@2337: * because it performs strict offset checking and typing rules.
dvander@561: *
dvander@1847: * @param entity Entity/edict index.
dvander@610: * @param type Property type.
dvander@1847: * @param prop Property name.
skamonkey@3293: * @param element Element # (starting from 0) if property is an array.
dvander@1847: * @return Entity index at the given property.
dvander@1847: * If there is no entity, or the entity is not valid,
dvander@1847: * then -1 is returned.
dvander@561: * @error Invalid entity or offset out of reasonable bounds.
dvander@561: */
skamonkey@3293: native GetEntPropEnt(entity, PropType:type, const String:prop[], element=0);
dvander@561:
dvander@561: /**
dvander@1847: * Sets an entity index in an entity's property.
dvander@1847: *
dvander@1847: * This function is considered safer and more robust over SetEntDataEnt*,
dvander@2337: * because it performs strict offset checking and typing rules.
dvander@561: *
dvander@1847: * @param entity Entity/edict index.
dvander@610: * @param type Property type.
dvander@1847: * @param prop Property name.
dvander@1847: * @param other Entity index to set, or -1 to unset.
skamonkey@3293: * @param element Element # (starting from 0) if property is an array.
dvander@561: * @noreturn
dvander@561: * @error Invalid entity or offset out of reasonable bounds.
dvander@561: */
skamonkey@3293: native SetEntPropEnt(entity, PropType:type, const String:prop[], other, element=0);
dvander@561:
dvander@561: /**
dvander@1847: * Retrieves a vector of floats from an entity, given a named network property.
dvander@1847: *
dvander@1847: * This function is considered safer and more robust over GetEntDataVector,
dvander@2337: * because it performs strict offset checking and typing rules.
dvander@561: *
dvander@1847: * @param entity Entity/edict index.
dvander@610: * @param type Property type.
dvander@1847: * @param prop Property name.
dvander@561: * @param vec Vector buffer to store data in.
skamonkey@3293: * @param element Element # (starting from 0) if property is an array.
dvander@561: * @noreturn
dvander@1847: * @error Invalid entity, property not found, or property not
dvander@1847: * actually a vector data type.
dvander@561: */
skamonkey@3293: native GetEntPropVector(entity, PropType:type, const String:prop[], Float:vec[3], element=0);
dvander@561:
dvander@561: /**
dvander@1847: * Sets a vector of floats in an entity, given a named network property.
dvander@1847: *
dvander@1847: * This function is considered safer and more robust over SetEntDataVector,
dvander@2337: * because it performs strict offset checking and typing rules.
dvander@561: *
dvander@1847: * @param entity Entity/edict index.
dvander@610: * @param type Property type.
dvander@1847: * @param prop Property name.
dvander@561: * @param vec Vector to set.
skamonkey@3293: * @param element Element # (starting from 0) if property is an array.
dvander@561: * @noreturn
dvander@1847: * @error Invalid entity, property not found, or property not
dvander@1847: * actually a vector data type.
dvander@561: */
skamonkey@3293: native SetEntPropVector(entity, PropType:type, const String:prop[], const Float:vec[3], element=0);
faluco@694:
faluco@694: /**
faluco@694: * Gets a network property as a string.
faluco@694: *
faluco@694: * @param entity Edict index.
faluco@694: * @param type Property type.
faluco@694: * @param prop Property to use.
faluco@694: * @param buffer Destination string buffer.
faluco@694: * @param maxlen Maximum length of output string buffer.
skamonkey@3293: * @param element Element # (starting from 0) if property is an array.
faluco@694: * @return Number of non-null bytes written.
faluco@694: * @error Invalid entity, offset out of reasonable bounds, or property is not a valid string.
faluco@694: */
skamonkey@3293: native GetEntPropString(entity, PropType:type, const String:prop[], String:buffer[], maxlen, element=0);
faluco@694:
faluco@694: /**
faluco@694: * Sets a network property as a string.
dvander@1884: *
dvander@1884: * This cannot set property fields of type PropField_String_T (such as "m_target").
dvander@1884: * To set such fields, you should use DispatchKeyValue() from SDKTools.
faluco@694: *
faluco@694: * @param entity Edict index.
faluco@694: * @param type Property type.
faluco@694: * @param prop Property to use.
faluco@694: * @param buffer String to set.
faluco@694: * @return Number of non-null bytes written.
faluco@694: * @error Invalid entity, offset out of reasonable bounds, or property is not a valid string.
faluco@694: */
faluco@694: native SetEntPropString(entity, PropType:type, const String:prop[], const String:buffer[]);
dvander@823:
dvander@823: /**
skamonkey@3293: * Retrieves the count of values that an entity property's array can store.
skamonkey@3293: *
skamonkey@3293: * @param entity Entity/edict index.
skamonkey@3293: * @param type Property type.
skamonkey@3293: * @param prop Property name.
skamonkey@3293: * @return Size of array (in elements) or 1 if property is not an array.
skamonkey@3293: * @error Invalid entity or property not found.
skamonkey@3293: */
skamonkey@3293: native GetEntPropArraySize(entity, PropType:type, const String:prop[]);
skamonkey@3293:
skamonkey@3293: /**
dvander@823: * Copies an array of cells from an entity at a given offset.
dvander@823: *
dvander@823: * @param entity Entity index.
dvander@823: * @param offset Offset to use.
dvander@823: * @param array Array to read into.
dvander@823: * @param arraySize Number of values to read.
dvander@823: * @param dataSize Size of each value in bytes (1, 2, or 4).
dvander@823: * @noreturn
dvander@823: * @error Invalid entity or offset out of reasonable bounds.
dvander@823: */
dvander@827: stock GetEntDataArray(entity, offset, array[], arraySize, dataSize=4)
dvander@823: {
dvander@823: for (new i=0; i