GetBlipOrdering: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
m (Needs example) |
||
| 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. | 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== | ||
| Line 12: | Line 12: | ||
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"> | |||
--TODO | |||
</syntaxhighlight> | |||
==See Also== | ==See Also== | ||
{{Blip functions}} | {{Blip functions}} | ||
[[Category:Needs Example]] | |||
Revision as of 17:58, 18 June 2009
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 )
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
--TODO