GetBlipOrdering: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (Added OOP syntax)
Line 5: Line 5:
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">int getBlipOrdering ( blip theBlip )</syntaxhighlight>
<syntaxhighlight lang="lua">int getBlipOrdering ( blip theBlip )</syntaxhighlight>
{{OOP||getOrdering|ordering|setBlipOrdering}}
{{OOP|The element type of this class is [[Blip]].|[[Blip]]:getOrdering||}}
===Required Arguments===
===Required Arguments===
*'''theBlip:''' the blip to retrieve the Z ordering value of.
*'''theBlip:''' the blip to retrieve the Z ordering value of.

Revision as of 21:22, 5 December 2014

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!

Note: The element type of this class is Blip.
Method: Blip:getOrdering(...)


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