IsElementStreamable: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
(Added OOP syntax introduced in r6987 and removed the "example" (it didn't make sense))
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 7: Line 8:
bool isElementStreamable ( element theElement )
bool isElementStreamable ( element theElement )
</syntaxhighlight>
</syntaxhighlight>
{{New feature/item|3.0141|1.4.0|6987|{{OOP||[[element]]:isStreamable|streamable|setElementStreamable}}}}


===Required Arguments===
===Required Arguments===
Line 13: Line 15:
===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==
<syntaxhighlight lang="lua">for _,v in ipairs(getElementsByType("player"))do
    outputChatBox(v) --returns false if you are inside a vehicle
end
</syntaxhighlight>


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

Revision as of 13:23, 31 December 2014

Accessories-text-editor.png Script Example Missing Function IsElementStreamable needs a script example, help out by writing one.

Before submitting check out Editing Guidelines Script Examples.

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.

See Also