GetBlipOrdering: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Learn to indent and now have blatant grammatical errors in examples)
m (Link to the Romanian translation of this page added.)
 
(9 intermediate revisions by 4 users not shown)
Line 5: Line 5:
==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===
===Required Arguments===
*'''theBlip:''' the blip to retrieve the Z ordering value of.
*'''theBlip:''' the blip to retrieve the Z ordering value of.
Line 24: Line 24:
==See Also==
==See Also==
{{Blip functions}}
{{Blip functions}}
[[Category:Needs Example]]
 
[[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

See Also