MTA:Eir/functions/engineStreamingSetProperty - Revision history

Tracer: Renamed template

2023-09-28T08:21:39Z

Renamed template

← Older revision		Revision as of 08:21, 28 September 2023
Line 1:		Line 1:
	{{*Client_function}}		{{MTA:Eir/Client_function}}
	__NOTOC__		__NOTOC__
	This function changes the behavior of the GTA:SA streaming system. It is meant to optimize the performance of the game for your custom server. Changes in these properties affect the gameplay quality of the entire server.		This function changes the behavior of the GTA:SA streaming system. It is meant to optimize the performance of the game for your custom server. Changes in these properties affect the gameplay quality of the entire server.

TEDERIs: Undo revision 39626 by TEDERIs (talk)

2014-05-28T07:45:36Z

Undo revision 39626 by TEDERIs (talk)

← Older revision		Revision as of 07:45, 28 May 2014
Line 78:		Line 78:
	</syntaxhighlight>		</syntaxhighlight>
	</section>		</section>

	~~[[ru:engineStreamingSetProperty]]~~

TEDERIs at 07:22, 28 May 2014

2014-05-28T07:22:59Z

← Older revision		Revision as of 07:22, 28 May 2014
Line 78:		Line 78:
	</syntaxhighlight>		</syntaxhighlight>
	</section>		</section>

			[[ru:engineStreamingSetProperty]]

The GTA at 21:14, 31 March 2014

2014-03-31T21:14:22Z

← Older revision		Revision as of 21:14, 31 March 2014
Line 15:		Line 15:
	{{:MTA:Eir/functions/engineStreamingSetProperty/validProps}}		{{:MTA:Eir/functions/engineStreamingSetProperty/validProps}}

	==Useful Media==		===Useful Media===
	* https://dl.dropboxusercontent.com/u/55896914/eir_resources/streaming_opt.zip - streaming debugging resource		* https://dl.dropboxusercontent.com/u/55896914/eir_resources/streaming_opt.zip - streaming debugging resource
	* https://dl.dropboxusercontent.com/u/55896914/eir_resources/streaming_test.zip - streaming mode example resource		* https://dl.dropboxusercontent.com/u/55896914/eir_resources/streaming_test.zip - streaming mode example resource

The GTA at 21:13, 31 March 2014

2014-03-31T21:13:59Z

← Older revision		Revision as of 21:13, 31 March 2014
Line 14:		Line 14:
	===Valid Properties===		===Valid Properties===
	{{:MTA:Eir/functions/engineStreamingSetProperty/validProps}}		{{:MTA:Eir/functions/engineStreamingSetProperty/validProps}}

			==Useful Media==
			* https://dl.dropboxusercontent.com/u/55896914/eir_resources/streaming_opt.zip - streaming debugging resource
			* https://dl.dropboxusercontent.com/u/55896914/eir_resources/streaming_test.zip - streaming mode example resource
			* http://youtu.be/sk8WsHwPgsU - showcase video

	===Returns===		===Returns===

The GTA at 16:02, 29 March 2014

2014-03-29T16:02:47Z

@@ Line 13: / Line 13: @@
 ===Valid Properties===
-{|class="wikitable"
+{{:MTA:Eir/functions/engineStreamingSetProperty/validProps}}
 ===Returns===

The GTA at 15:57, 29 March 2014

2014-03-29T15:57:47Z

← Older revision		Revision as of 15:57, 29 March 2014
Line 54:		Line 54:

	===Returns===		===Returns===
	Returns ''true'' if ~~enabled is~~ passed ~~as valid bool~~, ''false'' otherwise.		Returns ''true'' if valid arguments have been passed, ''false'' otherwise.

	==Examples==		==Examples==

The GTA: Created page with "{{*Client_function}} NOTOC This function changes the behavior of the GTA:SA streaming system. It is meant to optimize the performance of the game for your custom server. Cha..."

2014-03-29T15:55:44Z

Created page with "{{*Client_function}} __NOTOC__ This function changes the behavior of the GTA:SA streaming system. It is meant to optimize the performance of the game for your custom server. Cha..."

New page

{{*Client_function}}
__NOTOC__
This function changes the behavior of the GTA:SA streaming system. It is meant to optimize the performance of the game for your custom server. Changes in these properties affect the gameplay quality of the entire server.

==Syntax==
<syntaxhighlight lang="lua">
bool engineStreamingSetProperty ( string propertyName, var propValue )
</syntaxhighlight>

===Arguments===
*'''propertyName:''' the name of the streaming property you want to change
*'''propValue:''' value to pass to the property

===Valid Properties===
{|class="wikitable"
|-
! Name
! Type
! Description
! Default
|-
|strictNodeDistrib
|boolean
|It is only valid in conjunction with '''infiniteStreaming'''. If enabled, entities first allocate from existing nodes. If disabled, entities are allowed to allocate new streaming nodes from the heap without touching existing nodes.
|Enabled
|-
|infiniteStreaming
|boolean
|Enables or disables heap allocation of [[GTA:SA_Streaming_Garbage_Collection|streaming garbage collector]] nodes. The allocation behavior order is changed using '''strictNodeDistrib'''. If enabled, GTA:SA can keep an theoretically infinite amount of entities inside of the streaming garbage collector. This also means that an theoretically infinite amount of entities can render on-screen at a time.
|Disabled
|-
|gcOnDemand
|boolean
|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.
|Disabled
|-
|nodeStealing
|boolean
|Allows or disallows the [[GTA:SA_Streaming_Garbage_Collection|Streaming GC]] node stealing performed by native GTA:SA. This is the functionality that directly causes world flickering if the engine encounters Streaming GC node shortage. Disabling this functionality will greatly reduce the amount of entities that can be freed of their Streaming GC nodes.
|Enabled
|-
|isFibered
|boolean
|Switches between original and fibered loading of the [[GTA:SA_Resource_Streaming|GTA:SA Streaming system]]. In original mode, most resources are loaded in one go, but big ones (exceeding slicer buffer size) are loaded exclusively and in two pulses. In fibered mode, the Streaming system can only take a user-defined percentage of the game frame time, meaning that resources can take an arbitrary amount of pulses depending on the complexity of said resources.
|Enabled
|-
|fiberedPerfMult
|number
|This function changes the fibered loading frame time execution percentage of the [[GTA:SA_Resource_Streaming|MTA:Eir Streaming system]]. 100% means that the Streaming system can take as much as the last frame time the engine took. If set to 0%, the Streaming system will not halt but take a step at a time, disregarding any time settings.

Lower percentages decrease the CPU load that the Streaming loader issues every frame. While it does not affect high-end CPUs, low end CPUs can greatly benefit from lower percentages when traveling across the world or entering dense areas. In general, lower percentages reduce lag spikes that occur when loading dense areas.
|0.6
|}

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

==Examples==
<section name="Client" class="client" show="true">
This snippet ultimatively fixes the world flickering.
<syntaxhighlight lang="lua">
engineStreamingSetProperty( "strictNodeDistrib", false );
engineStreamingSetProperty( "infiniteStreaming", true );
</syntaxhighlight>
</section>

<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">
engineStreamingSetProperty( "gcOnDemand", true );
engineStreamingSetProperty( "infiniteStreaming", false );
engineStreamingSetProperty( "strictNodeDistrib", true );
</syntaxhighlight>
</section>

<section name="Client" class="client" show="true">
This snippet turns on fibered loading when the Streaming system is busy and leaves it that way for five seconds.
<syntaxhighlight lang="lua">
engineStreamingSetProperty( "isFibered", false );

local lastBusyTime = false;
local fiberedDuration = 5000;

addEventHandler( "onClientRender", root,
function()
local isBusy = engineGetStreamingInfo().isBusy;

if ( isBusy ) then
local now = getTickCount();

if not ( lastBusyTime ) then
lastBusyTime = now;

engineStreamingSetProperty( "isFibered", true );
end
elseif ( lastBusyTime ) then
if ( now - lastBusyTime > fiberedDuration ) then
engineStreamingSetProperty( "isFibered", false );
end
end
end
);
</syntaxhighlight>
</section>

<section name="Client" class="client" show="true">
This snippet makes the world load very slow. Lag spikes cannot occur due to Streaming loading anymore.
<syntaxhighlight lang="lua">
engineStreamingSetProperty( "isFibered", true );
engineStreamingSetProperty( "fiberedPerfMult", 0 );
</syntaxhighlight>
</section>