Entity References (SourceMod) - Revision history

Joinedsenses: Update highlighting

2020-05-04T14:09:29Z

Update highlighting

Joinedsenses: Update highlighting

2020-05-04T14:09:13Z

Update highlighting

Asherkin: Reverted edits by Joinedsenses (talk) to last revision by Xerox8521

2020-05-04T13:24:11Z

Reverted edits by Joinedsenses (talk) to last revision by Xerox8521

Joinedsenses: Update highlighting

2020-03-29T23:59:31Z

Update highlighting

Xerox8521: Updated to 1.7 Syntax

2015-08-23T15:23:48Z

Updated to 1.7 Syntax

Ddhoward at 19:10, 5 March 2014

2014-03-05T19:10:10Z

Foo bar at 08:34, 16 December 2013

2013-12-16T08:34:23Z

11530: /* Using References to handle a logic entity */ Changing code to use references instead of indices

2012-08-09T20:47:14Z

‎Using References to handle a logic entity: Changing code to use references instead of indices

Psychonic at 02:13, 12 December 2010

2010-12-12T02:13:40Z

GNCMatt: Undo revision 7796 by GNCMatt (Talk) My bad, I guess I just read it wrong.

2010-08-17T20:09:24Z

Undo revision 7796 by GNCMatt (Talk) My bad, I guess I just read it wrong.

@@ Line 21: / Line 21: @@
 	/* Reference wasn't valid - Entity must have been deleted */
+}
-</pawn>
+</sourcepawn>
 ==Using References to handle a logic entity==

@@ Line 5: / Line 5: @@
 ==Converting a backwards-compat index/ref to a guaranteed reference for safely caching==
-<pawn>
+<sourcepawn>
 int index = GetEntPropEnt(client, Prop_Send, "m_hActiveWeapon");
 /* Convert our backwards-compat index/ref to a guaranteed reference */
 int ref = EntIndexToEntRef(index);
-</pawn>
+</sourcepawn>
 ==Converting a reference back to an entity index==
-<pawn>
+<sourcepawn>
 int index = EntRefToEntIndex(ref);
@@ Line 25: / Line 25: @@
 ==Using References to handle a logic entity==
-<pawn>
+<sourcepawn>
 int ent = -1;
@@ Line 40: / Line 40: @@
+}
-</pawn>
+</sourcepawn>
 [[Category:SourceMod Scripting]]

@@ Line 1: / Line 1: @@
 An entity reference is a combination of a standard entity index (used for all entities in SourceMod previously) and a pseudo-unique serial number that identifies the entity. Since entities are constantly being created and destroyed a cached index doesn't guarantee the underlying entity is the same, references provide a way of verifying the same entity still exists. Generally speaking, if you have an entity index you wish to cache you should convert it to a reference first. Most Sourcemod-provided natives should be able to accept references in place of indexes (wherever the parameter asks for an entity - Not clients), and these will use the serial to check that the entity index contained in the reference is the same as when the reference was created. If you find a native that does not seem to support references in place of indexes, please file a bug report.
@@ Line 98: / Line 5: @@
 ==Converting a backwards-compat index/ref to a guaranteed reference for safely caching==
-<sourcepawn>
+<pawn>
 int index = GetEntPropEnt(client, Prop_Send, "m_hActiveWeapon");
 /* Convert our backwards-compat index/ref to a guaranteed reference */
 int ref = EntIndexToEntRef(index);
-</sourcepawn>
+</pawn>
 ==Converting a reference back to an entity index==
-<sourcepawn>
+<pawn>
 int index = EntRefToEntIndex(ref);
 if (index == INVALID_ENT_REFERENCE)
+{
-  /* Reference wasn't valid - Entity must have been deleted */
+	/* Reference wasn't valid - Entity must have been deleted */
+}
-</sourcepawn>
+</pawn>
 ==Using References to handle a logic entity==
-<sourcepawn>
+<pawn>
 int ent = -1;
@@ Line 133: / Line 40: @@
+}
-</sourcepawn>
+</pawn>
 [[Category:SourceMod Scripting]]

@@ Line 1: / Line 1: @@
 An entity reference is a combination of a standard entity index (used for all entities in SourceMod previously) and a pseudo-unique serial number that identifies the entity. Since entities are constantly being created and destroyed a cached index doesn't guarantee the underlying entity is the same, references provide a way of verifying the same entity still exists. Generally speaking, if you have an entity index you wish to cache you should convert it to a reference first. Most Sourcemod-provided natives should be able to accept references in place of indexes (wherever the parameter asks for an entity - Not clients), and these will use the serial to check that the entity index contained in the reference is the same as when the reference was created. If you find a native that does not seem to support references in place of indexes, please file a bug report.
@@ Line 5: / Line 98: @@
 ==Converting a backwards-compat index/ref to a guaranteed reference for safely caching==
-<pawn>
+<sourcepawn>
 int index = GetEntPropEnt(client, Prop_Send, "m_hActiveWeapon");
 /* Convert our backwards-compat index/ref to a guaranteed reference */
 int ref = EntIndexToEntRef(index);
-</pawn>
+</sourcepawn>
 ==Converting a reference back to an entity index==
-<pawn>
+<sourcepawn>
 int index = EntRefToEntIndex(ref);
 if (index == INVALID_ENT_REFERENCE)
+{
-	/* Reference wasn't valid - Entity must have been deleted */
+  /* Reference wasn't valid - Entity must have been deleted */
+}
-</pawn>
+</sourcepawn>
 ==Using References to handle a logic entity==
-<pawn>
+<sourcepawn>
 int ent = -1;
@@ Line 40: / Line 133: @@
+}
-</pawn>
+</sourcepawn>
 [[Category:SourceMod Scripting]]

@@ Line 6: / Line 6: @@
 <pawn>
-new index = GetEntPropEnt(client, Prop_Send, "m_hActiveWeapon");
+int index = GetEntPropEnt(client, Prop_Send, "m_hActiveWeapon");
 /* Convert our backwards-compat index/ref to a guaranteed reference */
-new ref = EntIndexToEntRef(index);
+int ref = EntIndexToEntRef(index);
 </pawn>
@@ Line 15: / Line 15: @@
 <pawn>
-new index = EntRefToEntIndex(ref);
+int index = EntRefToEntIndex(ref);
 if (index == INVALID_ENT_REFERENCE)
@@ Line 26: / Line 26: @@
 <pawn>
-new ent = -1;
+int ent = -1;
 while ((ent = FindEntityByClassname(ent, "logic_auto")) != -1)
@@ Line 34: / Line 34: @@
       * Should be a number >2048 since logic_auto is a non networked entity
       */
-     new ref = EntIndexToEntRef(ent);
+     int ref = EntIndexToEntRef(ent);
      /* Fire an input on this entity - We use the reference version since this includes a serial check */

← Older revision		Revision as of 19:10, 5 March 2014
Line 1:		Line 1:
−	An entity reference is a combination of a standard entity index (used for all entities in SourceMod previously) and a pseudo-unique serial number that identifies the entity. Since entities are constantly being created and destroyed a cached index doesn't guarantee the underlying entity is the same, references provide a way of verifying the same entity still exists. Generally speaking, if you have an entity index you wish to cache you should convert it to a reference first. ~~All~~ natives ~~(provided by SourceMod)~~ should be able to accept references in place of indexes (wherever the parameter asks for an entity - Not clients), and these will use the serial to check that the entity index contained in the reference is the same as when the reference was created.	+	An entity reference is a combination of a standard entity index (used for all entities in SourceMod previously) and a pseudo-unique serial number that identifies the entity. Since entities are constantly being created and destroyed a cached index doesn't guarantee the underlying entity is the same, references provide a way of verifying the same entity still exists. Generally speaking, if you have an entity index you wish to cache you should convert it to a reference first. Most Sourcemod-provided natives should be able to accept references in place of indexes (wherever the parameter asks for an entity - Not clients), and these will use the serial to check that the entity index contained in the reference is the same as when the reference was created. If you find a native that does not seem to support references in place of indexes, please file a bug report.

	SourceMod now also supports handling of logical (non-networked entities) and these use references exclusively. Natives that used to return an entity index will continue to do so in the case of networked entities (for backwards compatability) and will only return a reference for non-networked ones.		SourceMod now also supports handling of logical (non-networked entities) and these use references exclusively. Natives that used to return an entity index will continue to do so in the case of networked entities (for backwards compatability) and will only return a reference for non-networked ones.

← Older revision		Revision as of 08:34, 16 December 2013
Line 1:		Line 1:
−	An entity reference is a combination of a standard entity index (used for all entities in SourceMod previously) and a pseudo-unique serial number that identifies the entity. Since entities are constantly being created and destroyed a cached index doesn't guarantee the underlying entity is the same, references provide a way of verifying the same entity still exists. Generally speaking, if you have an entity index you wish to cache you should convert it to a reference first. All natives (provided by SourceMod) should be able to accept references in place of indexes (wherever the parameter asks for an entity - Not clients), and these will ~~check~~ use the serial to check that the entity index contained in the reference is the same as when the reference was created.	+	An entity reference is a combination of a standard entity index (used for all entities in SourceMod previously) and a pseudo-unique serial number that identifies the entity. Since entities are constantly being created and destroyed a cached index doesn't guarantee the underlying entity is the same, references provide a way of verifying the same entity still exists. Generally speaking, if you have an entity index you wish to cache you should convert it to a reference first. All natives (provided by SourceMod) should be able to accept references in place of indexes (wherever the parameter asks for an entity - Not clients), and these will use the serial to check that the entity index contained in the reference is the same as when the reference was created.

	SourceMod now also supports handling of logical (non-networked entities) and these use references exclusively. Natives that used to return an entity index will continue to do so in the case of networked entities (for backwards compatability) and will only return a reference for non-networked ones.		SourceMod now also supports handling of logical (non-networked entities) and these use references exclusively. Natives that used to return an entity index will continue to do so in the case of networked entities (for backwards compatability) and will only return a reference for non-networked ones.

@@ Line 37: / Line 37: @@
 	/* Fire an input on this entity - We use the reference version since this includes a serial check */
-	AcceptEntityInput(index, "Kill");
+	AcceptEntityInput(ent, "Kill");
+}