GetBlipOrdering: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
m (Link to the Romanian translation of this page added.) |
||
| (2 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Server client function}} | {{Server client function}} | ||
This function gets the Z ordering value of a blip. The Z ordering determines if a blip appears on top of or below other blips. Blips with a higher Z ordering value appear on top of blips with a lower value. The default value for all blips is 0. | |||
== | ==Syntax== | ||
<syntaxhighlight lang="lua">int getBlipOrdering ( blip theBlip )</syntaxhighlight> | <syntaxhighlight lang="lua">int getBlipOrdering ( blip theBlip )</syntaxhighlight> | ||
{{OOP||[[blip]]:getOrdering|ordering|setBlipOrdering}} | {{OOP||[[blip]]:getOrdering|ordering|setBlipOrdering}} | ||
=== | ===Required Arguments=== | ||
*'''theBlip:''' the blip to retrieve the Z ordering value of. | *'''theBlip:''' the blip to retrieve the Z ordering value of. | ||
=== | ===Returns=== | ||
Returns the Z ordering value of the blip if successful, ''false'' otherwise. | Returns the Z ordering value of the blip if successful, ''false'' otherwise. | ||
== | ==Example== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
function getMyBlip(theBlip) | function getMyBlip(theBlip) | ||
| Line 22: | Line 22: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
== | ==See Also== | ||
{{Blip functions}} | {{Blip functions}} | ||
[[hu:getBlipOrdering]] | [[hu:getBlipOrdering]] | ||
[[ro:getBlipOrdering]] | |||
Latest revision as of 20:29, 18 July 2019
This function gets the Z ordering value of a blip. The Z ordering determines if a blip appears on top of or below other blips. Blips with a higher Z ordering value appear on top of blips with a lower value. The default value for all blips is 0.
Syntax
int getBlipOrdering ( blip theBlip )
OOP Syntax Help! I don't understand this!
- Method: blip:getOrdering(...)
- Variable: .ordering
- Counterpart: setBlipOrdering
Required Arguments
- theBlip: the blip to retrieve the Z ordering value of.
Returns
Returns the Z ordering value of the blip if successful, false otherwise.
Example
function getMyBlip(theBlip)
local ordering = getBlipOrdering ( theBlip )
if (ordering) then
outputChatBox("The following blip has a ordering of "..ordering)
end
end