Updated includes and spcomp to SourceMod 1.9
This commit is contained in:
Vendored
+206
-192
@@ -9,7 +9,7 @@
|
||||
* This program is free software; you can redistribute it and/or modify it under
|
||||
* the terms of the GNU General Public License, version 3.0, as published by the
|
||||
* Free Software Foundation.
|
||||
*
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful, but WITHOUT
|
||||
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
|
||||
* FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
|
||||
@@ -29,7 +29,7 @@
|
||||
*
|
||||
* Version: $Id$
|
||||
*/
|
||||
|
||||
|
||||
#if defined _entity_included
|
||||
#endinput
|
||||
#endif
|
||||
@@ -67,9 +67,9 @@ enum PropFieldType
|
||||
PropField_Entity, /**< Valid for Data fields only (SendProp shows as int) */
|
||||
PropField_Vector, /**< Valid for SendProp and Data fields */
|
||||
PropField_String, /**< Valid for SendProp and Data fields */
|
||||
PropField_String_T, /**< Valid for Data fields. Read only.
|
||||
Note that the size of a string_t is dynamic, and
|
||||
thus FindDataMapOffs() will return the constant size
|
||||
PropField_String_T, /**< Valid for Data fields. Read only.
|
||||
Note that the size of a string_t is dynamic, and
|
||||
thus FindDataMapOffs() will return the constant size
|
||||
of the string_t container (which is 32 bits right now).
|
||||
*/
|
||||
};
|
||||
@@ -79,27 +79,35 @@ enum PropFieldType
|
||||
*/
|
||||
|
||||
/**
|
||||
* Returns the maximum number of entities.
|
||||
* Returns the maximum number of networked entities.
|
||||
*
|
||||
* @return Maximum number of entities.
|
||||
* Note: For legacy reasons, this only returns the maximum
|
||||
* networked entities (maximum edicts), rather than total
|
||||
* maximum entities.
|
||||
*
|
||||
* @return Maximum number of networked entities.
|
||||
*/
|
||||
native GetMaxEntities();
|
||||
native int GetMaxEntities();
|
||||
|
||||
/**
|
||||
* Returns the number of entities in the server.
|
||||
* Returns the number of networked entities in the server.
|
||||
*
|
||||
* Note: For legacy reasons, this only returns the current count
|
||||
* of networked entities (current edicts), rather than total
|
||||
* count of current entities.
|
||||
*
|
||||
* @return Number of entities in the server.
|
||||
*/
|
||||
native GetEntityCount();
|
||||
native int GetEntityCount();
|
||||
|
||||
/**
|
||||
* Returns whether or not an entity is valid. Returns false
|
||||
* if there is no matching CBaseEntity for this edict index.
|
||||
* if there is no matching CBaseEntity for this entity index.
|
||||
*
|
||||
* @param edict Index of the entity/edict.
|
||||
* @param entity Index of the entity.
|
||||
* @return True if valid, false otherwise.
|
||||
*/
|
||||
native bool:IsValidEntity(edict);
|
||||
native bool IsValidEntity(int entity);
|
||||
|
||||
/**
|
||||
* Returns whether or not an edict index is valid.
|
||||
@@ -107,31 +115,30 @@ native bool:IsValidEntity(edict);
|
||||
* @param edict Index of the edict.
|
||||
* @return True if valid, false otherwise.
|
||||
*/
|
||||
native bool:IsValidEdict(edict);
|
||||
native bool IsValidEdict(int edict);
|
||||
|
||||
/**
|
||||
* Returns whether or not an entity is a valid networkable edict.
|
||||
* Returns whether or not an entity has a valid networkable edict.
|
||||
*
|
||||
* @param edict Index of the edict.
|
||||
* @param edict Index of the entity.
|
||||
* @return True if networkable, false if invalid or not networkable.
|
||||
*/
|
||||
native bool:IsEntNetworkable(edict);
|
||||
native bool IsEntNetworkable(int entiy);
|
||||
|
||||
/**
|
||||
* Creates a new edict (the basis of a networkable entity)
|
||||
*
|
||||
* @return Index of the edict, 0 on failure.
|
||||
*/
|
||||
native CreateEdict();
|
||||
native int CreateEdict();
|
||||
|
||||
/**
|
||||
/**
|
||||
* Removes an edict from the world.
|
||||
*
|
||||
* @param edict Index of the edict.
|
||||
* @noreturn
|
||||
* @error Invalid edict index.
|
||||
*/
|
||||
native RemoveEdict(edict);
|
||||
native void RemoveEdict(int edict);
|
||||
|
||||
/**
|
||||
* Returns the flags on an edict. These are not the same as entity flags.
|
||||
@@ -140,17 +147,16 @@ native RemoveEdict(edict);
|
||||
* @return Edict flags.
|
||||
* @error Invalid edict index.
|
||||
*/
|
||||
native GetEdictFlags(edict);
|
||||
native int GetEdictFlags(int edict);
|
||||
|
||||
/**
|
||||
* Sets the flags on an edict. These are not the same as entity flags.
|
||||
*
|
||||
* @param edict Index of the entity.
|
||||
* @param flags Flags to set.
|
||||
* @noreturn
|
||||
* @error Invalid edict index.
|
||||
*/
|
||||
native SetEdictFlags(edict, flags);
|
||||
native void SetEdictFlags(int edict, int flags);
|
||||
|
||||
/**
|
||||
* Retrieves an edict classname.
|
||||
@@ -160,7 +166,7 @@ native SetEdictFlags(edict, flags);
|
||||
* @param maxlength Maximum length of the buffer.
|
||||
* @return True on success, false if there is no classname set.
|
||||
*/
|
||||
native bool:GetEdictClassname(edict, String:clsname[], maxlength);
|
||||
native bool GetEdictClassname(int edict, char[] clsname, int maxlength);
|
||||
|
||||
/**
|
||||
* Retrieves an entity's networkable serverclass name.
|
||||
@@ -168,60 +174,59 @@ native bool:GetEdictClassname(edict, String:clsname[], maxlength);
|
||||
*
|
||||
* @param edict Index of the entity.
|
||||
* @param clsname Buffer to store the serverclass name.
|
||||
* @param maxlength Maximum lnegth of the buffer.
|
||||
* @param maxlength Maximum length of the buffer.
|
||||
* @return True on success, false if the edict is not networkable.
|
||||
* @error Invalid edict index.
|
||||
*/
|
||||
native bool:GetEntityNetClass(edict, String:clsname[], maxlength);
|
||||
native bool GetEntityNetClass(int edict, char[] clsname, int maxlength);
|
||||
|
||||
/**
|
||||
* @section Entity offset functions
|
||||
*
|
||||
* Offsets should be specified in byte distance from the CBaseEntity
|
||||
* structure, not short (double byte) or integer (four byte) multiples.
|
||||
* It is somewhat common practice to use offsets aligned to their final
|
||||
* Offsets should be specified in byte distance from the CBaseEntity
|
||||
* structure, not short (double byte) or integer (four byte) multiples.
|
||||
* It is somewhat common practice to use offsets aligned to their final
|
||||
* type, and thus make sure you are not falling to this error in SourceMod.
|
||||
* For example, if your "integer-aligned" offset was 119, your byte-aligned
|
||||
* offset is 119*4, or 476.
|
||||
|
||||
|
||||
* Specifying incorrect offsets or the incorrect data type for an offset
|
||||
* can have fatal consequences. If you are hardcoding offsets, and the
|
||||
* can have fatal consequences. If you are hardcoding offsets, and the
|
||||
* layout of CBaseEntity does not match, you can easily crash the server.
|
||||
*
|
||||
* The reasonable bounds for offsets is greater than or equal to 0 and
|
||||
* The reasonable bounds for offsets is greater than or equal to 0 and
|
||||
* below 32768. Offsets out of these bounds will throw an error. However,
|
||||
* this does not represent any real range, it is simply a sanity check for
|
||||
* illegal values. Any range outside of the CBaseEntity structure's private
|
||||
* size will cause undefined behaviour or even crash.
|
||||
* size will cause undefined behavior or even crash.
|
||||
*/
|
||||
|
||||
/**
|
||||
* Marks an entity as state changed. This can be useful if you set an offset
|
||||
* and wish for it to be immediately changed over the network. By default this
|
||||
* is not done for offset setting functions.
|
||||
*
|
||||
* @param edict Index to the edict.
|
||||
* @param offset Offset to mark as changed. If 0,
|
||||
* the entire edict is marked as changed.
|
||||
* @noreturn
|
||||
* @error Invalid entity or offset out of bounds.
|
||||
*/
|
||||
native ChangeEdictState(edict, offset = 0);
|
||||
|
||||
/**
|
||||
* Peeks into an entity's object data and retrieves the integer value at
|
||||
* Marks an entity as state changed. This can be useful if you set an offset
|
||||
* and wish for it to be immediately changed over the network. By default this
|
||||
* is not done for offset setting functions.
|
||||
*
|
||||
* @param edict Index to the edict.
|
||||
* @param offset Offset to mark as changed. If 0,
|
||||
* the entire edict is marked as changed.
|
||||
* @error Invalid entity or offset out of bounds.
|
||||
*/
|
||||
native void ChangeEdictState(int edict, int offset = 0);
|
||||
|
||||
/**
|
||||
* Peeks into an entity's object data and retrieves the integer value at
|
||||
* the given offset.
|
||||
*
|
||||
*
|
||||
* @param entity Edict index.
|
||||
* @param offset Offset to use.
|
||||
* @param size Number of bytes to read (valid values are 1, 2, or 4).
|
||||
* @return Value at the given memory location.
|
||||
* @error Invalid entity or offset out of reasonable bounds.
|
||||
*/
|
||||
native GetEntData(entity, offset, size=4);
|
||||
native int GetEntData(int entity, int offset, int size=4);
|
||||
|
||||
/**
|
||||
* Peeks into an entity's object data and sets the integer value at
|
||||
* Peeks into an entity's object data and sets the integer value at
|
||||
* the given offset.
|
||||
*
|
||||
* @param entity Edict index.
|
||||
@@ -229,139 +234,131 @@ native GetEntData(entity, offset, size=4);
|
||||
* @param value Value to set.
|
||||
* @param size Number of bytes to write (valid values are 1, 2, or 4).
|
||||
* @param changeState If true, change will be sent over the network.
|
||||
* @return Value at the given memory location.
|
||||
* @error Invalid entity or offset out of reasonable bounds.
|
||||
* @noreturn
|
||||
*/
|
||||
native SetEntData(entity, offset, any:value, size=4, bool:changeState=false);
|
||||
native void SetEntData(int entity, int offset, any value, int size=4, bool changeState=false);
|
||||
|
||||
/**
|
||||
* Peeks into an entity's object data and retrieves the float value at
|
||||
* Peeks into an entity's object data and retrieves the float value at
|
||||
* the given offset.
|
||||
*
|
||||
*
|
||||
* @param entity Edict index.
|
||||
* @param offset Offset to use.
|
||||
* @return Value at the given memory location.
|
||||
* @error Invalid entity or offset out of reasonable bounds.
|
||||
*/
|
||||
native Float:GetEntDataFloat(entity, offset);
|
||||
native float GetEntDataFloat(int entity, int offset);
|
||||
|
||||
/**
|
||||
* Peeks into an entity's object data and sets the float value at
|
||||
* Peeks into an entity's object data and sets the float value at
|
||||
* the given offset.
|
||||
*
|
||||
* @param entity Edict index.
|
||||
* @param offset Offset to use.
|
||||
* @param value Value to set.
|
||||
* @param changeState If true, change will be sent over the network.
|
||||
* @return Value at the given memory location.
|
||||
* @error Invalid entity or offset out of reasonable bounds.
|
||||
* @noreturn
|
||||
*/
|
||||
native SetEntDataFloat(entity, offset, Float:value, bool:changeState=false);
|
||||
native void SetEntDataFloat(int entity, int offset, float value, bool changeState=false);
|
||||
|
||||
/**
|
||||
* This function is deprecated. Use GetEntDataEnt2 instead, for
|
||||
* This function is deprecated. Use GetEntDataEnt2 instead, for
|
||||
* reasons explained in the notes.
|
||||
*
|
||||
* Note: This function returns 0 on failure, which may be misleading,
|
||||
* Note: This function returns 0 on failure, which may be misleading,
|
||||
* as the number 0 is also used for the world entity index.
|
||||
*
|
||||
* Note: This function makes no attempt to validate the returned
|
||||
* Note: This function makes no attempt to validate the returned
|
||||
* entity, and in fact, it could be garbage or completely unexpected.
|
||||
*
|
||||
*
|
||||
* @param entity Edict index.
|
||||
* @param offset Offset to use.
|
||||
* @return Entity index at the given location, or 0 if none.
|
||||
* @error Invalid entity or offset out of reasonable bounds.
|
||||
*/
|
||||
#pragma deprecated Use GetEntDataEnt2() instead.
|
||||
native GetEntDataEnt(entity, offset);
|
||||
native int GetEntDataEnt(int entity, int offset);
|
||||
|
||||
/**
|
||||
* This function is deprecated. Use SetEntDataEnt2 instead, for
|
||||
* This function is deprecated. Use SetEntDataEnt2 instead, for
|
||||
* reasons explained in the notes.
|
||||
*
|
||||
* Note: This function uses 0 as an indicator to unset data, but
|
||||
* 0 is also the world entity index. Thus, a property cannot
|
||||
* Note: This function uses 0 as an indicator to unset data, but
|
||||
* 0 is also the world entity index. Thus, a property cannot
|
||||
* be set to the world entity using this native.
|
||||
*
|
||||
*
|
||||
* @param entity Edict index.
|
||||
* @param offset Offset to use.
|
||||
* @param other Entity index to set, or 0 to clear.
|
||||
* @param changeState If true, change will be sent over the network.
|
||||
* @noreturn
|
||||
* @error Invalid entity or offset out of reasonable bounds.
|
||||
*/
|
||||
#pragma deprecated Use SetEntDataEnt2() instead.
|
||||
native SetEntDataEnt(entity, offset, other, bool:changeState=false);
|
||||
native void SetEntDataEnt(int entity, int offset, int other, bool changeState=false);
|
||||
|
||||
/**
|
||||
* Peeks into an entity's object data and retrieves the entity index
|
||||
* Peeks into an entity's object data and retrieves the entity index
|
||||
* at the given offset.
|
||||
*
|
||||
* Note: This will only work on offsets that are stored as "entity
|
||||
* handles" (which usually looks like m_h* in properties). These
|
||||
* Note: This will only work on offsets that are stored as "entity
|
||||
* handles" (which usually looks like m_h* in properties). These
|
||||
* are not SourceMod Handles, but internal Source structures.
|
||||
*
|
||||
*
|
||||
* @param entity Edict index.
|
||||
* @param offset Offset to use.
|
||||
* @return Entity index at the given location. If there is no entity,
|
||||
* @return Entity index at the given location. If there is no entity,
|
||||
* or the stored entity is invalid, then -1 is returned.
|
||||
* @error Invalid input entity, or offset out of reasonable bounds.
|
||||
*/
|
||||
native GetEntDataEnt2(entity, offset);
|
||||
native int GetEntDataEnt2(int entity, int offset);
|
||||
|
||||
/**
|
||||
* Peeks into an entity's object data and sets the entity index at the
|
||||
* Peeks into an entity's object data and sets the entity index at the
|
||||
* given offset.
|
||||
*
|
||||
* Note: This will only work on offsets that are stored as "entity
|
||||
* handles" (which usually looks like m_h* in properties). These
|
||||
* Note: This will only work on offsets that are stored as "entity
|
||||
* handles" (which usually looks like m_h* in properties). These
|
||||
* are not SourceMod Handles, but internal Source structures.
|
||||
*
|
||||
*
|
||||
* @param entity Edict index.
|
||||
* @param offset Offset to use.
|
||||
* @param other Entity index to set, or -1 to clear.
|
||||
* @param changeState If true, change will be sent over the network.
|
||||
* @noreturn
|
||||
* @error Invalid input entity, or offset out of reasonable bounds.
|
||||
*/
|
||||
native SetEntDataEnt2(entity, offset, other, bool:changeState=false);
|
||||
native void SetEntDataEnt2(int entity, int offset, int other, bool changeState=false);
|
||||
|
||||
/**
|
||||
* Peeks into an entity's object data and retrieves the vector at the
|
||||
* Peeks into an entity's object data and retrieves the vector at the
|
||||
* given offset.
|
||||
* @note Both a Vector and a QAngle are three floats. This is a
|
||||
* @note Both a Vector and a QAngle are three floats. This is a
|
||||
* convenience function and will work with both types.
|
||||
*
|
||||
*
|
||||
* @param entity Edict index.
|
||||
* @param offset Offset to use.
|
||||
* @param vec Vector buffer to store data in.
|
||||
* @noreturn
|
||||
* @error Invalid entity or offset out of reasonable bounds.
|
||||
*/
|
||||
native GetEntDataVector(entity, offset, Float:vec[3]);
|
||||
native void GetEntDataVector(int entity, int offset, float vec[3]);
|
||||
|
||||
/**
|
||||
* Peeks into an entity's object data and sets the vector at the given
|
||||
* Peeks into an entity's object data and sets the vector at the given
|
||||
* offset.
|
||||
* @note Both a Vector and a QAngle are three floats. This is a
|
||||
* @note Both a Vector and a QAngle are three floats. This is a
|
||||
* convenience function and will work with both types.
|
||||
*
|
||||
*
|
||||
* @param entity Edict index.
|
||||
* @param offset Offset to use.
|
||||
* @param vec Vector to set.
|
||||
* @param changeState If true, change will be sent over the network.
|
||||
* @noreturn
|
||||
* @error Invalid entity or offset out of reasonable bounds.
|
||||
*/
|
||||
native SetEntDataVector(entity, offset, const Float:vec[3], bool:changeState=false);
|
||||
native void SetEntDataVector(int entity, int offset, const float vec[3], bool changeState=false);
|
||||
|
||||
/**
|
||||
* Peeks into an entity's object data and retrieves the string at
|
||||
* Peeks into an entity's object data and retrieves the string at
|
||||
* the given offset.
|
||||
*
|
||||
*
|
||||
* @param entity Edict index.
|
||||
* @param offset Offset to use.
|
||||
* @param buffer Destination string buffer.
|
||||
@@ -369,12 +366,12 @@ native SetEntDataVector(entity, offset, const Float:vec[3], bool:changeState=fal
|
||||
* @return Number of non-null bytes written.
|
||||
* @error Invalid entity or offset out of reasonable bounds.
|
||||
*/
|
||||
native GetEntDataString(entity, offset, String:buffer[], maxlen);
|
||||
native int GetEntDataString(int entity, int offset, char[] buffer, int maxlen);
|
||||
|
||||
/**
|
||||
* Peeks into an entity's object data and sets the string at
|
||||
* Peeks into an entity's object data and sets the string at
|
||||
* the given offset.
|
||||
*
|
||||
*
|
||||
* @param entity Edict index.
|
||||
* @param offset Offset to use.
|
||||
* @param buffer String to set.
|
||||
@@ -383,7 +380,7 @@ native GetEntDataString(entity, offset, String:buffer[], maxlen);
|
||||
* @return Number of non-null bytes written.
|
||||
* @error Invalid entity or offset out of reasonable bounds.
|
||||
*/
|
||||
native SetEntDataString(entity, offset, const String:buffer[], maxlen, bool:changeState=false);
|
||||
native int SetEntDataString(int entity, int offset, const char[] buffer, int maxlen, bool changeState=false);
|
||||
|
||||
/**
|
||||
* @endsection
|
||||
@@ -394,44 +391,40 @@ native SetEntDataString(entity, offset, const String:buffer[], maxlen, bool:chan
|
||||
* This information is cached for future calls.
|
||||
*
|
||||
* Note, this function may return offsets that do not work!
|
||||
* If a property is nested beneath a parent object, the resulting offset
|
||||
* will be invalid for direct use with data functions. Therefore, you
|
||||
* should use FindSendPropInfo() instead. An example of such a property is
|
||||
* If a property is nested beneath a parent object, the resulting offset
|
||||
* will be invalid for direct use with data functions. Therefore, you
|
||||
* should use FindSendPropInfo() instead. An example of such a property is
|
||||
* CTFPlayer::DT_LocalPlayer.m_nDisguiseClass on Team Fortress.
|
||||
*
|
||||
* @param cls Classname.
|
||||
* @param prop Property name.
|
||||
* @return An offset, or -1 on failure.
|
||||
*/
|
||||
native FindSendPropOffs(const String:cls[], const String:prop[]);
|
||||
#pragma deprecated Use FindSendPropInfo instead, or HasEntProp if you just want to check for existence.
|
||||
native int FindSendPropOffs(const char[] cls, const char[] prop);
|
||||
|
||||
/**
|
||||
* Given a ServerClass name, finds a networkable send property offset.
|
||||
* This information is cached for future calls.
|
||||
*
|
||||
* Note: This function will correctly compute nested offsets, unlike
|
||||
* FindSendPropOffs(). YOU SHOULD NOT use this function to self-compute
|
||||
* nested offsets. For example, it is okay to add indexes for arrays,
|
||||
* but not to add DT_LocalPlayer to m_nDisguiseClass.
|
||||
*
|
||||
* @param cls Classname.
|
||||
* @param prop Property name.
|
||||
* @param type Optional parameter to store the type.
|
||||
* @param num_bits Optional parameter to store the number of bits the field
|
||||
* uses, if applicable (otherwise 0 is stored). The number
|
||||
* of bits varies for integers and floats, and is always 0
|
||||
* @param num_bits Optional parameter to store the number of bits the field
|
||||
* uses, if applicable (otherwise 0 is stored). The number
|
||||
* of bits varies for integers and floats, and is always 0
|
||||
* for strings.
|
||||
* @param local_offset Optional parameter to store the local offset, as
|
||||
* @param local_offset Optional parameter to store the local offset, as
|
||||
* FindSendPropOffs() would return.
|
||||
* @return On success, returns an absolutely computed offset.
|
||||
* If no offset is available, 0 is returned.
|
||||
* If the property is not found, -1 is returned.
|
||||
*/
|
||||
native FindSendPropInfo(const String:cls[],
|
||||
const String:prop[],
|
||||
&PropFieldType:type=PropFieldType:0,
|
||||
&num_bits=0,
|
||||
&local_offset=0);
|
||||
native int FindSendPropInfo(const char[] cls,
|
||||
const char[] prop,
|
||||
PropFieldType &type=view_as<PropFieldType>(0),
|
||||
int &num_bits=0,
|
||||
int &local_offset=0);
|
||||
|
||||
/**
|
||||
* Given an entity, finds a datamap property offset.
|
||||
@@ -440,16 +433,17 @@ native FindSendPropInfo(const String:cls[],
|
||||
* @param entity Entity index.
|
||||
* @param prop Property name.
|
||||
* @param type Optional parameter to store the type.
|
||||
* @param num_bits Optional parameter to store the number of bits the field
|
||||
* uses. The bit count will either be 1 (for boolean) or
|
||||
* @param num_bits Optional parameter to store the number of bits the field
|
||||
* uses. The bit count will either be 1 (for boolean) or
|
||||
* divisible by 8 (including 0 if unknown).
|
||||
* @return An offset, or -1 on failure.
|
||||
*/
|
||||
native FindDataMapOffs(entity,
|
||||
const String:prop[],
|
||||
&PropFieldType:type=PropFieldType:0,
|
||||
&num_bits=0);
|
||||
|
||||
#pragma deprecated Use FindDataMapInfo instead, or HasEntProp if you just want to check for existence.
|
||||
native int FindDataMapOffs(int entity,
|
||||
const char[] prop,
|
||||
PropFieldType &type=view_as<PropFieldType>(0),
|
||||
int &num_bits=0);
|
||||
|
||||
/**
|
||||
* Given an entity, finds a nested datamap property offset.
|
||||
* This information is cached for future calls.
|
||||
@@ -457,18 +451,18 @@ native FindDataMapOffs(entity,
|
||||
* @param entity Entity index.
|
||||
* @param prop Property name.
|
||||
* @param type Optional parameter to store the type.
|
||||
* @param num_bits Optional parameter to store the number of bits the field
|
||||
* uses. The bit count will either be 1 (for boolean) or
|
||||
* @param num_bits Optional parameter to store the number of bits the field
|
||||
* uses. The bit count will either be 1 (for boolean) or
|
||||
* divisible by 8 (including 0 if unknown).
|
||||
* @param local_offset Optional parameter to store the local offset, as
|
||||
* @param local_offset Optional parameter to store the local offset, as
|
||||
* FindDataMapOffs() would return.
|
||||
* @return An offset, or -1 on failure.
|
||||
*/
|
||||
native FindDataMapInfo(entity,
|
||||
const String:prop[],
|
||||
&PropFieldType:type=PropFieldType:0,
|
||||
&num_bits=0,
|
||||
&local_offset=0);
|
||||
native int FindDataMapInfo(int entity,
|
||||
const char[] prop,
|
||||
PropFieldType &type=view_as<PropFieldType>(0),
|
||||
int &num_bits=0,
|
||||
int &local_offset=0);
|
||||
|
||||
/**
|
||||
* Wrapper function for finding a send property for a particular entity.
|
||||
@@ -476,72 +470,99 @@ native FindDataMapInfo(entity,
|
||||
* @param ent Entity index.
|
||||
* @param prop Property name.
|
||||
* @param actual Defaults to false for backwards compatibility.
|
||||
* If true, the newer FindSendPropInfo() function
|
||||
* If true, the newer FindSendPropInfo() function
|
||||
* is used instead.
|
||||
* @return An offset, or -1 on failure.
|
||||
*/
|
||||
stock GetEntSendPropOffs(ent, const String:prop[], bool:actual=false)
|
||||
stock int GetEntSendPropOffs(int ent, const char[] prop, bool actual=false)
|
||||
{
|
||||
decl String:cls[64];
|
||||
|
||||
char cls[64];
|
||||
|
||||
if (!GetEntityNetClass(ent, cls, sizeof(cls)))
|
||||
{
|
||||
return -1;
|
||||
}
|
||||
|
||||
|
||||
int local = -1;
|
||||
int offset = FindSendPropInfo(cls, prop, _, _, local);
|
||||
|
||||
if (actual)
|
||||
{
|
||||
return FindSendPropInfo(cls, prop);
|
||||
return offset;
|
||||
} else {
|
||||
return local;
|
||||
}
|
||||
else
|
||||
{
|
||||
return FindSendPropOffs(cls, prop);
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks if an entity property exists on an entity.
|
||||
*
|
||||
* @param entity Entity/edict index.
|
||||
* @param type Property type.
|
||||
* @param prop Property name.
|
||||
* @return Whether the property exists on the entity.
|
||||
* @error Invalid entity.
|
||||
*/
|
||||
stock bool HasEntProp(int entity, PropType type, const char[] prop)
|
||||
{
|
||||
if (type == Prop_Data) {
|
||||
return (FindDataMapInfo(entity, prop) != -1);
|
||||
}
|
||||
|
||||
if (type != Prop_Send) {
|
||||
return false;
|
||||
}
|
||||
|
||||
char cls[64];
|
||||
if (!GetEntityNetClass(entity, cls, sizeof(cls))) {
|
||||
return false;
|
||||
}
|
||||
|
||||
return (FindSendPropInfo(cls, prop) != -1);
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieves an integer value from an entity's property.
|
||||
*
|
||||
* This function is considered safer and more robust over GetEntData,
|
||||
* This function is considered safer and more robust over GetEntData,
|
||||
* because it performs strict offset checking and typing rules.
|
||||
*
|
||||
*
|
||||
* @param entity Entity/edict index.
|
||||
* @param type Property type.
|
||||
* @param prop Property name.
|
||||
* @param size Number of bytes to write (valid values are 1, 2, or 4).
|
||||
* This value is auto-detected, and the size parameter is
|
||||
* This value is auto-detected, and the size parameter is
|
||||
* only used as a fallback in case detection fails.
|
||||
* @param element Element # (starting from 0) if property is an array.
|
||||
* @return Value at the given property offset.
|
||||
* @error Invalid entity or property not found.
|
||||
*/
|
||||
native GetEntProp(entity, PropType:type, const String:prop[], size=4, element=0);
|
||||
native int GetEntProp(int entity, PropType type, const char[] prop, int size=4, int element=0);
|
||||
|
||||
/**
|
||||
* Sets an integer value in an entity's property.
|
||||
*
|
||||
* This function is considered safer and more robust over SetEntData,
|
||||
* This function is considered safer and more robust over SetEntData,
|
||||
* because it performs strict offset checking and typing rules.
|
||||
*
|
||||
*
|
||||
* @param entity Entity/edict index.
|
||||
* @param type Property type.
|
||||
* @param prop Property name.
|
||||
* @param value Value to set.
|
||||
* @param size Number of bytes to write (valid values are 1, 2, or 4).
|
||||
* This value is auto-detected, and the size parameter is
|
||||
* This value is auto-detected, and the size parameter is
|
||||
* only used as a fallback in case detection fails.
|
||||
* @param element Element # (starting from 0) if property is an array.
|
||||
* @error Invalid entity or offset out of reasonable bounds.
|
||||
* @noreturn
|
||||
*/
|
||||
native SetEntProp(entity, PropType:type, const String:prop[], any:value, size=4, element=0);
|
||||
native void SetEntProp(int entity, PropType type, const char[] prop, any value, int size=4, int element=0);
|
||||
|
||||
/**
|
||||
* Retrieves a float value from an entity's property.
|
||||
*
|
||||
* This function is considered safer and more robust over GetEntDataFloat,
|
||||
* This function is considered safer and more robust over GetEntDataFloat,
|
||||
* because it performs strict offset checking and typing rules.
|
||||
*
|
||||
*
|
||||
* @param entity Entity/edict index.
|
||||
* @param type Property type.
|
||||
* @param prop Property name.
|
||||
@@ -549,130 +570,124 @@ native SetEntProp(entity, PropType:type, const String:prop[], any:value, size=4,
|
||||
* @return Value at the given property offset.
|
||||
* @error Invalid entity or offset out of reasonable bounds.
|
||||
*/
|
||||
native Float:GetEntPropFloat(entity, PropType:type, const String:prop[], element=0);
|
||||
native float GetEntPropFloat(int entity, PropType type, const char[] prop, int element=0);
|
||||
|
||||
/**
|
||||
* Sets a float value in an entity's property.
|
||||
*
|
||||
* This function is considered safer and more robust over SetEntDataFloat,
|
||||
* This function is considered safer and more robust over SetEntDataFloat,
|
||||
* because it performs strict offset checking and typing rules.
|
||||
*
|
||||
*
|
||||
* @param entity Entity/edict index.
|
||||
* @param type Property type.
|
||||
* @param prop Property name.
|
||||
* @param value Value to set.
|
||||
* @param element Element # (starting from 0) if property is an array.
|
||||
* @noreturn
|
||||
* @error Invalid entity or offset out of reasonable bounds.
|
||||
*/
|
||||
native SetEntPropFloat(entity, PropType:type, const String:prop[], Float:value, element=0);
|
||||
native void SetEntPropFloat(int entity, PropType type, const char[] prop, float value, int element=0);
|
||||
|
||||
/**
|
||||
* Retrieves an entity index from an entity's property.
|
||||
*
|
||||
* This function is considered safer and more robust over GetEntDataEnt*,
|
||||
* This function is considered safer and more robust over GetEntDataEnt*,
|
||||
* because it performs strict offset checking and typing rules.
|
||||
*
|
||||
*
|
||||
* @param entity Entity/edict index.
|
||||
* @param type Property type.
|
||||
* @param prop Property name.
|
||||
* @param element Element # (starting from 0) if property is an array.
|
||||
* @return Entity index at the given property.
|
||||
* If there is no entity, or the entity is not valid,
|
||||
* If there is no entity, or the entity is not valid,
|
||||
* then -1 is returned.
|
||||
* @error Invalid entity or offset out of reasonable bounds.
|
||||
*/
|
||||
native GetEntPropEnt(entity, PropType:type, const String:prop[], element=0);
|
||||
native int GetEntPropEnt(int entity, PropType type, const char[] prop, int element=0);
|
||||
|
||||
/**
|
||||
* Sets an entity index in an entity's property.
|
||||
*
|
||||
* This function is considered safer and more robust over SetEntDataEnt*,
|
||||
* This function is considered safer and more robust over SetEntDataEnt*,
|
||||
* because it performs strict offset checking and typing rules.
|
||||
*
|
||||
*
|
||||
* @param entity Entity/edict index.
|
||||
* @param type Property type.
|
||||
* @param prop Property name.
|
||||
* @param other Entity index to set, or -1 to unset.
|
||||
* @param element Element # (starting from 0) if property is an array.
|
||||
* @noreturn
|
||||
* @error Invalid entity or offset out of reasonable bounds.
|
||||
*/
|
||||
native SetEntPropEnt(entity, PropType:type, const String:prop[], other, element=0);
|
||||
native void SetEntPropEnt(int entity, PropType type, const char[] prop, int other, int element=0);
|
||||
|
||||
/**
|
||||
* Retrieves a vector of floats from an entity, given a named network property.
|
||||
*
|
||||
* This function is considered safer and more robust over GetEntDataVector,
|
||||
* This function is considered safer and more robust over GetEntDataVector,
|
||||
* because it performs strict offset checking and typing rules.
|
||||
*
|
||||
*
|
||||
* @param entity Entity/edict index.
|
||||
* @param type Property type.
|
||||
* @param prop Property name.
|
||||
* @param vec Vector buffer to store data in.
|
||||
* @param element Element # (starting from 0) if property is an array.
|
||||
* @noreturn
|
||||
* @error Invalid entity, property not found, or property not
|
||||
* @error Invalid entity, property not found, or property not
|
||||
* actually a vector data type.
|
||||
*/
|
||||
native GetEntPropVector(entity, PropType:type, const String:prop[], Float:vec[3], element=0);
|
||||
native void GetEntPropVector(int entity, PropType type, const char[] prop, float vec[3], int element=0);
|
||||
|
||||
/**
|
||||
* Sets a vector of floats in an entity, given a named network property.
|
||||
*
|
||||
* This function is considered safer and more robust over SetEntDataVector,
|
||||
* This function is considered safer and more robust over SetEntDataVector,
|
||||
* because it performs strict offset checking and typing rules.
|
||||
*
|
||||
*
|
||||
* @param entity Entity/edict index.
|
||||
* @param type Property type.
|
||||
* @param prop Property name.
|
||||
* @param vec Vector to set.
|
||||
* @param element Element # (starting from 0) if property is an array.
|
||||
* @noreturn
|
||||
* @error Invalid entity, property not found, or property not
|
||||
* @error Invalid entity, property not found, or property not
|
||||
* actually a vector data type.
|
||||
*/
|
||||
native SetEntPropVector(entity, PropType:type, const String:prop[], const Float:vec[3], element=0);
|
||||
native void SetEntPropVector(int entity, PropType type, const char[] prop, const float vec[3], int element=0);
|
||||
|
||||
/**
|
||||
* Gets a network property as a string.
|
||||
*
|
||||
*
|
||||
* @param entity Edict index.
|
||||
* @param type Property type.
|
||||
* @param prop Property to use.
|
||||
* @param buffer Destination string buffer.
|
||||
* @param maxlen Maximum length of output string buffer.
|
||||
* @param maxlen Maximum length of output string buffer.
|
||||
* @param element Element # (starting from 0) if property is an array.
|
||||
* @return Number of non-null bytes written.
|
||||
* @error Invalid entity, offset out of reasonable bounds, or property is not a valid string.
|
||||
*/
|
||||
native GetEntPropString(entity, PropType:type, const String:prop[], String:buffer[], maxlen, element=0);
|
||||
native int GetEntPropString(int entity, PropType type, const char[] prop, char[] buffer, int maxlen, int element=0);
|
||||
|
||||
/**
|
||||
* Sets a network property as a string.
|
||||
*
|
||||
* This cannot set property fields of type PropField_String_T (such as "m_target").
|
||||
* To set such fields, you should use DispatchKeyValue() from SDKTools.
|
||||
*
|
||||
* @param entity Edict index.
|
||||
* @param type Property type.
|
||||
* @param prop Property to use.
|
||||
* @param buffer String to set.
|
||||
* @param buffer String to set.
|
||||
* @param element Element # (starting from 0) if property is an array.
|
||||
* @return Number of non-null bytes written.
|
||||
* @error Invalid entity, offset out of reasonable bounds, or property is not a valid string.
|
||||
*/
|
||||
native SetEntPropString(entity, PropType:type, const String:prop[], const String:buffer[]);
|
||||
native int SetEntPropString(int entity, PropType type, const char[] prop, const char[] buffer, int element=0);
|
||||
|
||||
/**
|
||||
* Retrieves the count of values that an entity property's array can store.
|
||||
*
|
||||
*
|
||||
* @param entity Entity/edict index.
|
||||
* @param type Property type.
|
||||
* @param prop Property name.
|
||||
* @return Size of array (in elements) or 1 if property is not an array.
|
||||
* @error Invalid entity or property not found.
|
||||
*/
|
||||
native GetEntPropArraySize(entity, PropType:type, const String:prop[]);
|
||||
native int GetEntPropArraySize(int entity, PropType type, const char[] prop);
|
||||
|
||||
/**
|
||||
* Copies an array of cells from an entity at a given offset.
|
||||
@@ -699,12 +714,11 @@ stock void GetEntDataArray(int entity, int offset, int[] array, int arraySize, i
|
||||
* @param arraySize Number of values to copy.
|
||||
* @param dataSize Size of each value in bytes (1, 2, or 4).
|
||||
* @param changeState True to set the network state as changed; false otherwise.
|
||||
* @noreturn
|
||||
* @error Invalid entity or offset out of reasonable bounds.
|
||||
*/
|
||||
stock SetEntDataArray(entity, offset, const array[], arraySize, dataSize=4, bool:changeState=false)
|
||||
stock void SetEntDataArray(int entity, int offset, const int[] array, int arraySize, int dataSize=4, bool changeState=false)
|
||||
{
|
||||
for (new i=0; i<arraySize; i++)
|
||||
for (int i=0; i<arraySize; i++)
|
||||
{
|
||||
SetEntData(entity, offset + i*dataSize, array[i], dataSize, changeState);
|
||||
}
|
||||
@@ -712,12 +726,12 @@ stock SetEntDataArray(entity, offset, const array[], arraySize, dataSize=4, bool
|
||||
|
||||
/**
|
||||
* Gets the memory address of an entity.
|
||||
*
|
||||
*
|
||||
* @param entity Entity index.
|
||||
* @return Address of the entity.
|
||||
* @error Invalid entity.
|
||||
*/
|
||||
native Address:GetEntityAddress(entity);
|
||||
native Address GetEntityAddress(int entity);
|
||||
|
||||
/**
|
||||
* Retrieves the classname of an entity.
|
||||
@@ -729,7 +743,7 @@ native Address:GetEntityAddress(entity);
|
||||
* @param maxlength Maximum length of the buffer.
|
||||
* @return True on success, false if there is no classname set.
|
||||
*/
|
||||
stock bool:GetEntityClassname(entity, String:clsname[], maxlength)
|
||||
stock bool GetEntityClassname(int entity, char[] clsname, int maxlength)
|
||||
{
|
||||
return !!GetEntPropString(entity, Prop_Data, "m_iClassname", clsname, maxlength);
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user