EHandle - Revision history

Outerbeast at 19:03, 1 February 2026

2026-02-01T19:03:23Z

← Older revision		Revision as of 21:03, 1 February 2026
Line 1:		Line 1:
	This type is used to store a handle to an entity across multiple frames. If the entity is removed, EHandle will return null instead. Using EHandle is very easy:		This type is used to store a handle to an entity across multiple frames: either in global state, or shared state as passed around in scheduled functions or in class fields.

			If the entity is removed, EHandle will return null instead. Using EHandle is very easy:

	<nowiki>		<nowiki>

Outerbeast at 17:55, 14 February 2025

2025-02-14T17:55:24Z

@@ Line 47: / Line 47: @@
          DoSomethingWithEntity( hEntity.GetEntity() );
 }</nowiki>
 [[Category:Scripting]]

Outerbeast at 19:35, 13 February 2025

2025-02-13T19:35:23Z

← Older revision		Revision as of 21:35, 13 February 2025
Line 17:		Line 17:
	//Do something with "pEntity"		//Do something with "pEntity"
	}		}
	}		}</nowiki>
	</nowiki>

	You should always check if the handle is valid before using it, otherwise, Angelscript will stop executing and raise an error.		You should always check if the handle is valid before using it, otherwise, Angelscript will stop executing and raise an error.
Line 37:		Line 36:
	g_Scheduler.SetTimeout( "DoSomethingWithEntity", 0.0f, EHandle( pEntity ) );		g_Scheduler.SetTimeout( "DoSomethingWithEntity", 0.0f, EHandle( pEntity ) );
	}		}


	void DoSomethingWithEntity( CBaseEntity@ pEntity ) // Original function		void DoSomethingWithEntity( CBaseEntity@ pEntity ) // Original function
Line 48:		Line 46:
	if( hEntity )		if( hEntity )
	DoSomethingWithEntity( hEntity.GetEntity() );		DoSomethingWithEntity( hEntity.GetEntity() );
	}		}</nowiki>
	</nowiki>

	[[Category:Scripting]]		[[Category:Scripting]]

Outerbeast at 17:30, 13 February 2025

2025-02-13T17:30:52Z

← Older revision		Revision as of 19:30, 13 February 2025
Line 50:		Line 50:
	}		}
	</nowiki>		</nowiki>

			[[Category:Scripting]]

Outerbeast: Created page with "This type is used to store a handle to an entity across multiple frames. If the entity is removed, EHandle will return null instead. Using EHandle is very easy: EHa..."

2025-02-13T16:49:32Z

Created page with "This type is used to store a handle to an entity across multiple frames. If the entity is removed, EHandle will return null instead. Using EHandle is very easy: <nowiki> EHa..."

New page

This type is used to store a handle to an entity across multiple frames. If the entity is removed, EHandle will return null instead. Using EHandle is very easy:

<nowiki>
EHandle g_hHandle;

void StoreEntity( CBaseEntity@ pEntity )
{
g_hHandle = pEntity; // CBaseEntity@ (and child types) instances implicitly cast to EHandle
}

void DoSomethingWithStoredEntity()
{
if( g_hHandle ) // Check if the EHandle is valid first before using it.
{
CBaseEntity@ pEntity = g_hHandle.GetEntity();

//Do something with "pEntity"
}
}
</nowiki>

You should always check if the handle is valid before using it, otherwise, Angelscript will stop executing and raise an error.

You should always use EHandle when storing entity handles, unless you know that it will only be used in current frame. Even then, it is safer to use EHandle to avoid problems.

Never declare a CBase* handle as a global or member variable, always use EHandle.

For the same reason, avoid passing CBase* handles through scheduled function/method parameters. In situations where you have to pass an entity through a scheduled function, its recommended to overload the scheduled function changing the CBase* parameter to EHandle and scheduling that overload:

<nowiki>
void ScheduleEntity( CBaseEntity@ pEntity )
{
// This will schedule "DoSomethingWithEntity( CBaseEntity@ pEntity )" - unsafe, avoid doing this
// g_Scheduler.SetTimeout( "DoSomethingWithEntity", 0.0f, pEntity );

// This will schedule "DoSomethingWithEntity( EHandle hEntity )" - safe
g_Scheduler.SetTimeout( "DoSomethingWithEntity", 0.0f, EHandle( pEntity ) );
}

void DoSomethingWithEntity( CBaseEntity@ pEntity ) // Original function
{
pEntity.DoSomething();
}

void DoSomethingWithEntity( EHandle hEntity ) // Overload
{
if( hEntity )
DoSomethingWithEntity( hEntity.GetEntity() );
}
</nowiki>