GetBlipOrdering: Difference between revisions
Jump to navigation
Jump to search
(New page: This gets the Z ordering of blips, i.e. which blips appear on top of which others. ==Syntax== <syntaxhighlight lang="lua">int getBlipOrdering ( blip theBlip )</syntaxhighlight>) |
m (Link to the Romanian translation of this page added.) |
||
| (15 intermediate revisions by 8 users not shown) | |||
| Line 1: | Line 1: | ||
This gets the Z ordering of blips | __NOTOC__ | ||
{{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== | ==Syntax== | ||
<syntaxhighlight lang="lua">int getBlipOrdering ( blip theBlip )</syntaxhighlight> | <syntaxhighlight lang="lua">int getBlipOrdering ( blip theBlip )</syntaxhighlight> | ||
{{OOP||[[blip]]:getOrdering|ordering|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== | |||
<syntaxhighlight lang="lua"> | |||
function getMyBlip(theBlip) | |||
local ordering = getBlipOrdering ( theBlip ) | |||
if (ordering) then | |||
outputChatBox("The following blip has a ordering of "..ordering) | |||
end | |||
end | |||
</syntaxhighlight> | |||
==See Also== | |||
{{Blip functions}} | |||
[[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