IsElementStreamable: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Added OOP syntax introduced in r6987 and removed the "example" (it didn't make sense))
m (Removed "needs example")
 
(2 intermediate revisions by one other user not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Client function}}
{{Client function}}
{{Needs Example}}
This function checks whether an [[element]] is streamable as set by [[setElementStreamable]] or not.
This function checks whether an [[element]] is streamable as set by [[setElementStreamable]] or not.


Line 15: Line 14:
===Returns===
===Returns===
Returns ''true'' if the passed element is streamable like normal, ''false'' if this element must always be streamed in.
Returns ''true'' if the passed element is streamable like normal, ''false'' if this element must always be streamed in.
==Example==
<section name="Client" class="client" show="true">
Check if
<syntaxhighlight lang="lua">
function onClientColShapeHit(theElement, matchingDimension)
if(isElementStreamable(theElement)) then  -- Checks whether the element is streamable
outputChatBox( "Element is streamable")
else
outputChatBox( "Element not streamable")
end
end
addEventHandler("onClientColShapeHit", root, onClientColShapeHit)
</syntaxhighlight>
</section>


==See Also==
==See Also==
{{Client element functions}}
{{Client element functions}}

Latest revision as of 16:36, 31 May 2020

This function checks whether an element is streamable as set by setElementStreamable or not.

Syntax

bool isElementStreamable ( element theElement )

OOP Syntax Help! I don't understand this!

Method: element:isStreamable(...)
Variable: .streamable
Counterpart: setElementStreamable

Required Arguments

  • theElement: The element to check the streamability of.

Returns

Returns true if the passed element is streamable like normal, false if this element must always be streamed in.

Example

Click to collapse [-]
Client

Check if 

function onClientColShapeHit(theElement, matchingDimension)
	if(isElementStreamable(theElement)) then  -- Checks whether the element is streamable
		outputChatBox( "Element is streamable")
	else
		outputChatBox( "Element not streamable")
	end
end
addEventHandler("onClientColShapeHit", root, onClientColShapeHit)

See Also



Retrieved from "https://wiki.multitheftauto.com/wiki/IsElementStreamable?oldid=66719"