MTA:Eir/functions/engineStreamingSetGCOnDemandEnabled: Difference between revisions
(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...") |
(Renamed template) |
||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{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. | ||
| Line 13: | Line 14: | ||
===Returns=== | ===Returns=== | ||
Returns '''true''' | Returns '''true''' if enabled is passed as valid boolean, '''false''' otherwise. | ||
==Example== | ==Example== | ||
Latest revision as of 08:17, 28 September 2023
This function is used to add a 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
bool engineStreamingSetGCOnDemandEnabled ( bool enabled )
Arguments
- enabled: a boolean to decide whether to garbage collect on lacking free Streaming GC nodes
Returns
Returns true if enabled is passed as valid boolean, false otherwise.
Example
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.
engineStreamingSetGCOnDemandEnabled( true ); engineSetInfiniteStreamingEnabled( false ); engineSetStrictNodeDistributionEnabled( true );