MTA:Eir/functions/engineStreamingSetGCOnDemandEnabled - Revision history

Tracer: Renamed template

2023-09-28T08:17:06Z

Renamed template

← Older revision		Revision as of 08:17, 28 September 2023
Line 1:		Line 1:
	{{*Client_function}}		{{MTA:Eir/Client_function}}
	__NOTOC__		__NOTOC__
	This function is used to add a [[GTA:SA_Streaming_Garbage_Collection\|Streaming garbage collector]] run to the event that the engine runs out of freely available Streaming GC nodes. The whole world is checked for off-screen or far-away entities. Every entity it finds loses its RenderWare data. When the model info of the specific entity model is not used anymore, it is freed. This way multiple Streaming GC nodes are made available for allocation. It is a safer way to free nodes from in-game entities than the Streaming node stealing implemented by Rockstar Games.		This function is used to add a [[GTA:SA_Streaming_Garbage_Collection\|Streaming garbage collector]] run to the event that the engine runs out of freely available Streaming GC nodes. The whole world is checked for off-screen or far-away entities. Every entity it finds loses its RenderWare data. When the model info of the specific entity model is not used anymore, it is freed. This way multiple Streaming GC nodes are made available for allocation. It is a safer way to free nodes from in-game entities than the Streaming node stealing implemented by Rockstar Games.

Qaisjp at 01:58, 12 January 2014

2014-01-12T01:58:54Z

← Older revision		Revision as of 01:58, 12 January 2014
Line 1:		Line 1:
			{{*Client_function}}
	__NOTOC__		__NOTOC__
	This function is used to add a [[GTA:SA_Streaming_Garbage_Collection\|Streaming garbage collector]] run to the event that the engine runs out of freely available Streaming GC nodes. The whole world is checked for off-screen or far-away entities. Every entity it finds loses its RenderWare data. When the model info of the specific entity model is not used anymore, it is freed. This way multiple Streaming GC nodes are made available for allocation. It is a safer way to free nodes from in-game entities than the Streaming node stealing implemented by Rockstar Games.		This function is used to add a [[GTA:SA_Streaming_Garbage_Collection\|Streaming garbage collector]] run to the event that the engine runs out of freely available Streaming GC nodes. The whole world is checked for off-screen or far-away entities. Every entity it finds loses its RenderWare data. When the model info of the specific entity model is not used anymore, it is freed. This way multiple Streaming GC nodes are made available for allocation. It is a safer way to free nodes from in-game entities than the Streaming node stealing implemented by Rockstar Games.

The GTA: /* Returns */

2013-12-11T06:19:08Z

Returns

← Older revision		Revision as of 06:19, 11 December 2013
Line 13:		Line 13:

	===Returns===		===Returns===
	Returns '''true''' is enabled is passed as valid boolean, '''false''' otherwise.		Returns '''true''' if enabled is passed as valid boolean, '''false''' otherwise.

	==Example==		==Example==

The GTA: Created page with "NOTOC This function is used to add a Streaming garbage collector run to the event that the engine runs out of freely available Stream..."

2013-12-11T06:18:13Z

Created page with "__NOTOC__ This function is used to add a Streaming garbage collector run to the event that the engine runs out of freely available Stream..."

New page

__NOTOC__
This function is used to add a [[GTA:SA_Streaming_Garbage_Collection|Streaming garbage collector]] run to the event that the engine runs out of freely available Streaming GC nodes. The whole world is checked for off-screen or far-away entities. Every entity it finds loses its RenderWare data. When the model info of the specific entity model is not used anymore, it is freed. This way multiple Streaming GC nodes are made available for allocation. It is a safer way to free nodes from in-game entities than the Streaming node stealing implemented by Rockstar Games.

By default, Streaming GC on demand is disabled.

==Syntax==
<syntaxhighlight lang="lua">
bool engineStreamingSetGCOnDemandEnabled ( bool enabled )
</syntaxhighlight>

===Arguments===
*'''enabled:''' a boolean to decide whether to garbage collect on lacking free Streaming GC nodes

===Returns===
Returns '''true''' is enabled is passed as valid boolean, '''false''' otherwise.

==Example==
<section name="Client" class="client" show="true">
This snippet sets the Streaming GC system to sparse mode. In this mode only the preallocated amount of Streaming GC nodes is allowed. Keeping a low amount of Streaming nodes is interesting for performance optimizations.
<syntaxhighlight lang="lua">
engineStreamingSetGCOnDemandEnabled( true );
engineSetInfiniteStreamingEnabled( false );
engineSetStrictNodeDistributionEnabled( true );
</syntaxhighlight>
</section>

MTA:Eir/functions/engineStreamingSetGCOnDemandEnabled - Revision history

Tracer: Renamed template

Qaisjp at 01:58, 12 January 2014

The GTA: /* Returns */

The GTA: Created page with "__NOTOC__ This function is used to add a Streaming garbage collector run to the event that the engine runs out of freely available Stream..."

The GTA: Created page with "NOTOC This function is used to add a Streaming garbage collector run to the event that the engine runs out of freely available Stream..."