BitExtract: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Created page with "{{Server client function}} {{Needs_Example}} __NOTOC__ {{New feature/item|3.0132|1.3.2|5340| This function returns the unsigned number formed by the bits field to field + width -...")
 
(added small example)
Line 21: Line 21:
==Example==
==Example==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
ToDo
function getColorAlpha(color)
  return bitExtract(color,24,8) -- return bits 24-32 ( the alpha, http://en.wikipedia.org/wiki/RGBA_color_space )
end
</syntaxhighlight>
</syntaxhighlight>


==See Also==
==See Also==
{{Bit_functions}}
{{Bit_functions}}

Revision as of 18:00, 5 September 2013

Accessories-text-editor.png Script Example Missing Function BitExtract needs a script example, help out by writing one.

Before submitting check out Editing Guidelines Script Examples.


This function returns the unsigned number formed by the bits field to field + width - 1 (range: 0-31).

Syntax

uint bitExtract ( uint var, int field, [int width = 1] )

Required arguments

  • var: The value
  • field: The field number
  • width: Number of bits to extract

Returns

Returns the extracted value/bit sequence.

Example

function getColorAlpha(color)
   return bitExtract(color,24,8) -- return bits 24-32 ( the alpha, http://en.wikipedia.org/wiki/RGBA_color_space ) 
end

See Also