SetElementStreamable - Revision history

Sbx320: Fixed documentation

2015-08-13T15:57:17Z

Fixed documentation

← Older revision		Revision as of 15:57, 13 August 2015
Line 17:		Line 17:

	===Returns===		===Returns===
	Returns ~~''true'' if~~ the element ~~was streamed in successfully right now, ''false'' if it~~ could ~~not~~ be ~~streamed in for some reason, for example limit reached, or invalid element~~.		Returns whether the element could be set to be streamable.

	==Example==		==Example==

AlexTMjugador: Added OOP syntax introduced in r6987, tidied up all the notes and improved the example

2014-12-31T13:14:45Z

Added OOP syntax introduced in r6987, tidied up all the notes and improved the example

← Older revision		Revision as of 13:14, 31 December 2014
Line 1:		Line 1:
	{{Client function}}		{{Client function}}
	__NOTOC__		__NOTOC__
	This function can be used to disable streaming for an element. This will make sure the element is not virtualized (streamed out from GTA) when the player moves far away from it. If the ~~limit for that element type is reached~~, ~~the furthest away elements that are streamable will be streamed out until it's below the limit~~.~~<br><br>~~		This function can be used to disable streaming for an element. This will make sure the element is not virtualized (streamed out from GTA) when the player moves far away from it. This function only works in elements with a physical representation in the world (entities), such as [[player\|players]], [[ped\|peds]], [[vehicle\|vehicles]] and [[object\|objects]].
	'''~~Note:~~''' ~~You shouldn't disable streaming on too many~~ elements ~~as there are limits~~ for every GTA ~~element~~ type. ~~Disabling streaming for some far-away~~ elements ~~will reduce number~~ of ~~elements~~ that ~~can be shown nearby~~.~~<br>~~		{{Tip\|'''Always use this function with caution'''. Not doing so can cause the following problems:
	~~'''Note:''' Disabling streaming for extremely~~ many ~~vehicles~~ (~~>80~~) can cause ~~low~~ FPS ~~and unwanted effect when warping players into far away vehicles~~.		* There is a limit of elements that can be streamed in safely for every GTA entity type. If you bypass said limit by using this function, the client can experience problems of disappearing objects and unstability when trying to stream in new elements of that type.
			* In general, if you disable too many elements (of the same type or not) to stream out, GTA will always try to render them, so it can cause a noticeable FPS drop.}}

	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool setElementStreamable ( element theElement, bool streamable )		bool setElementStreamable ( element theElement, bool streamable )
	</syntaxhighlight>		</syntaxhighlight>
			{{New feature/item\|3.0141\|1.4.0\|6987\|{{OOP\|\|[[element]]:setStreamable\|streamable\|isElementStreamable}}}}

	===Required Arguments===		===Required Arguments===
	*'''theElement:''' The element you wish to set the streaming of		*'''theElement:''' The element you wish to set the streaming of
	*'''streamable:''' ~~True~~ if this element should stream in/out like normal, false if it should always be streamed in		*'''streamable:''' ''true'' if this element should stream in/out like normal, ''false'' if it should always be streamed in.

	===Returns===		===Returns===
	Returns ''true'' if the element was streamed in successfully right now, ''false'' if it could not be streamed in for some reason, for example limit reached, or invalid element.		Returns ''true'' if the element was streamed in successfully right now, ''false'' if it could not be streamed in for some reason, for example limit reached, or invalid element.

	==Example==		==Example==
			This example creates an [[object]] at the center of the map which will always be streamed in when the resource which contains it starts.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function ~~setStreams~~()		local function testNonStreamableObjects()
	~~object1~~ = createObject ( 1097, 0, 0, 5 )		local object = createObject ( 1097, 0, 0, 5 )
	setElementStreamable ( ~~object1~~, ~~true~~ )		setElementStreamable ( object, false ) -- Make the object always be streamed in
	end		end
	addEventHandler ( "onClientResourceStart", resourceRoot, ~~setStreams~~ )		addEventHandler ( "onClientResourceStart", resourceRoot, testNonStreamableObjects )
	</syntaxhighlight>		</syntaxhighlight>

	==See Also==		==See Also==
	{{Client_element_functions}}		{{Client_element_functions}}

Carlos III: /* Example */

2011-06-25T03:04:35Z

Example

← Older revision		Revision as of 03:04, 25 June 2011
Line 19:		Line 19:
	==Example==		==Example==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
			function setStreams()
			object1 = createObject ( 1097, 0, 0, 5 )
			setElementStreamable ( object1, true )
			end
			addEventHandler ( "onClientResourceStart", resourceRoot, setStreams )
	</syntaxhighlight>		</syntaxhighlight>

	==See Also==		==See Also==
	{{Client_element_functions}}		{{Client_element_functions}}

ChrML at 08:17, 17 January 2008

2008-01-17T08:17:33Z

← Older revision		Revision as of 08:17, 17 January 2008
Line 22:		Line 22:

	==See Also==		==See Also==
	{{~~Element_functions~~}}		{{Client_element_functions}}

ChrML at 08:12, 17 January 2008

2008-01-17T08:12:15Z

← Older revision		Revision as of 08:12, 17 January 2008
Line 1:		Line 1:
	{{Client function}}		{{Client function}}
	__NOTOC__		__NOTOC__
	This function can be used to disable streaming for an element. This will make sure the element is not virtualized (streamed out from GTA) when the player moves far away from it. If the limit for that element type is reached, the furthest away elements that are streamable will be streamed out until it's below the limit.<br>		This function can be used to disable streaming for an element. This will make sure the element is not virtualized (streamed out from GTA) when the player moves far away from it. If the limit for that element type is reached, the furthest away elements that are streamable will be streamed out until it's below the limit.<br><br>
	'''Note:''' You shouldn't disable streaming on too many elements as there are limits for every GTA element type. Disabling streaming for some far-away elements will reduce number of elements that can be shown nearby.<br>		'''Note:''' You shouldn't disable streaming on too many elements as there are limits for every GTA element type. Disabling streaming for some far-away elements will reduce number of elements that can be shown nearby.<br>
	'''Note:''' Disabling streaming for extremely many vehicles (>80) can cause low FPS and unwanted effect when warping players into far away vehicles.		'''Note:''' Disabling streaming for extremely many vehicles (>80) can cause low FPS and unwanted effect when warping players into far away vehicles.

ChrML at 08:11, 17 January 2008

2008-01-17T08:11:57Z

← Older revision		Revision as of 08:11, 17 January 2008
Line 2:		Line 2:
	__NOTOC__		__NOTOC__
	This function can be used to disable streaming for an element. This will make sure the element is not virtualized (streamed out from GTA) when the player moves far away from it. If the limit for that element type is reached, the furthest away elements that are streamable will be streamed out until it's below the limit.<br>		This function can be used to disable streaming for an element. This will make sure the element is not virtualized (streamed out from GTA) when the player moves far away from it. If the limit for that element type is reached, the furthest away elements that are streamable will be streamed out until it's below the limit.<br>
	'''Note:''' You shouldn't disable streaming on too many elements as there are limits for every GTA element type. Disabling streaming for some far-away elements will reduce number of elements that can be shown nearby. Disabling streaming for extremely many vehicles can cause low FPS and unwanted effect when warping players into far away vehicles.		'''Note:''' You shouldn't disable streaming on too many elements as there are limits for every GTA element type. Disabling streaming for some far-away elements will reduce number of elements that can be shown nearby.<br>
			'''Note:''' Disabling streaming for extremely many vehicles (>80) can cause low FPS and unwanted effect when warping players into far away vehicles.

	==Syntax==		==Syntax==

ChrML: New page: {{Client function}} NOTOC This function can be used to disable streaming for an element. This will make sure the element is not virtualized (streamed out from GTA) when the player mo...

2008-01-17T08:10:15Z

New page: {{Client function}} __NOTOC__ This function can be used to disable streaming for an element. This will make sure the element is not virtualized (streamed out from GTA) when the player mo...

New page

{{Client function}}
__NOTOC__
This function can be used to disable streaming for an element. This will make sure the element is not virtualized (streamed out from GTA) when the player moves far away from it. If the limit for that element type is reached, the furthest away elements that are streamable will be streamed out until it's below the limit.<br>
'''Note:''' You shouldn't disable streaming on too many elements as there are limits for every GTA element type. Disabling streaming for some far-away elements will reduce number of elements that can be shown nearby. Disabling streaming for extremely many vehicles can cause low FPS and unwanted effect when warping players into far away vehicles.

==Syntax==
<syntaxhighlight lang="lua">
bool setElementStreamable ( element theElement, bool streamable )
</syntaxhighlight>

===Required Arguments===
*'''theElement:''' The element you wish to set the streaming of
*'''streamable:''' True if this element should stream in/out like normal, false if it should always be streamed in

===Returns===
Returns ''true'' if the element was streamed in successfully right now, ''false'' if it could not be streamed in for some reason, for example limit reached, or invalid element.

==Example==
<syntaxhighlight lang="lua">
</syntaxhighlight>

==See Also==
{{Element_functions}}