SetBlipOrdering: 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">bool setBlipOrdering ( blip theBlip, int ordering )</syntaxhighlight>
<syntaxhighlight lang="lua">bool setBlipOrdering ( blip theBlip, int ordering )</syntaxhighlight>
{{OOP||setOrdering|ordering|getBlipOrdering}}
{{OOP|The element type of this class is [[Blip]].|[[Blip]]:setOrdering||getBlipOrdering|}}
===Required Arguments===
===Required Arguments===
*'''theBlip:''' the blip whose Z ordering to change.
*'''theBlip:''' the blip whose Z ordering to change.

Revision as of 21:26, 5 December 2014

This function sets the Z ordering of a blip. It allows you to make a blip appear on top of or below other blips.

Syntax

bool setBlipOrdering ( blip theBlip, int ordering )

OOP Syntax Help! I don't understand this!

Note: The element type of this class is Blip.
Method: Blip:setOrdering(...)
Counterpart: getBlipOrdering


Required Arguments

  • theBlip: the blip whose Z ordering to change.
  • ordering: the new Z ordering value. Blips with higher values will appear on top of blips with lower values. Possible range: -32767 to 32767. Default: 0.

Returns

Returns true if the blip ordering was changed successfully, false otherwise.

Example

This example will create a blip and make your blip on top of all other blip's.

Click to collapse [-]
Server
function makeBlipHigher(thePlayer)
    local setmeup = createBlipAttachedTo ( thePlayer, 3, 3, 255, 0,0,255,0,99999.0, root)
    setBlipOrdering(setmeup, getBlipOrdering(setmeup) + 1)
    outputChatBox("*INFO: #ffff00Your blip is now on top of others!", thePlayer, 255,0,0,true)
    for i,v in ipairs(getElementsByType"player") do
          if v ~= thePlayer then
                  outputChatBox("*INFO: #ffff00" .. getPlayerName(thePlayer) .. "'s blip is now on top of your blip!",v,255,0,0,true)
          end
    end
end
addCommandHandler("incrementBlip", makeBlipHigher, false, false)

See Also