core.libraries.thirdparty.niknaks.modules.sh_bitbuffer

(no description)

Functions

Clear()

 View source »

Clears all data from the BitBuffer.

Returns

Debug()

 View source »

Debug print function for the bitbuffer.

EndOfData()

 View source »

Returns true if we've reached the end of the bitbuffer.

Returns

  • boolean

IsBigEndian()

 View source »

Returns true if the bitbuffer is big-endian.

Returns

  • boolean

IsLittleEndian()

 View source »

Returns true if the bitbuffer is little-endian.

Returns

  • boolean

NikNaks.BitBuffer.IntToString(int)

 View source »

Takes an Little-Endian number and converts it into a 4 char-string

Parameters

  • int number

Returns

NikNaks.BitBuffer.OpenFile(fileName, gamePath, lzma, little_endian)

 View source »

Same as file.Open, but returns it as a bitbuffer. little_endian is true by default.

Parameters

  • lzma boolean optional

  • little_endian boolean optional

Returns

NikNaks.BitBuffer.StringToInt(str)

 View source »

Takes a string of 1-4 charectors and converts it into a Little-Endian int

Parameters

Returns

  • number

Read(bytes)

 View source »

Reads raw string-data. Default bytes are the length of the bitbuffer.

Parameters

  • bytes number

Returns

ReadAngle()

 View source »

Reads an Angle.

Returns

  • Angle

ReadBoolean()

 View source »

Reads a boolean.

Returns

  • boolean

ReadByte()

 View source »

Reads a byte. ( 0 - 255 )

Returns

  • number

ReadColor()

 View source »

Reads a 32bit color.

Returns

  • Color

ReadDouble()

 View source »

Reads an IEEE 754 little-endian double.

Returns

  • number

ReadFloat()

 View source »

Reads an IEEE 754 little-endian float.

Returns

  • number

ReadInt(bits)

 View source »

Reads an int.

Parameters

  • bits number

Returns

  • number

ReadLong()

 View source »

Reads a 4 byte number. ( -2147483648 - 2147483647 )

Returns

  • number

ReadNibble()

 View source »

Reads a 4 bit unsigned number. ( 0 - 15 )

Returns

  • number

ReadShort()

 View source »

Reads an 2 byte number. ( -32768 - 32767 )

Returns

  • number

ReadSignedByte()

 View source »

Writes a signed byte. ( -128 - 127 )

Returns

  • number

ReadSnort()

 View source »

Reads a 2 bit unsigned number. ( 0 - 3 )

Returns

  • number

ReadString()

 View source »

Reads a string. Max string length: 65535

Returns

ReadStringNull(maxLength)

 View source »

Reads a string using a nullbyte at the end. Note: ReadStringNull is a bit slower than ReadString.

Parameters

  • maxLength number optional

Returns

ReadTable(maxValues)

 View source »

Reads a table. Default maxValues is 150

Parameters

  • maxValues number optional

Returns

ReadType()

 View source »

Reads a type using a byte as TYPE_ID.

Returns

  • any

ReadUInt(bits)

 View source »

Reads an unsigned int.

Parameters

  • bits number

Returns

  • number

ReadULong()

 View source »

Reads an unsigned 4 byte number ( 0 - 4294967295 )

Returns

  • number

ReadUShort()

 View source »

Reads an unsigned 2 byte number. ( 0 - 65535 )

Returns

  • number

ReadVector()

 View source »

Reads a Vector.

Returns

  • Vector

SaveToFile(fileName, lzma)

 View source »

Saves the bitbuffer to a file within the data folder. Returns true if it got saved.

Parameters

  • lzma boolean optional

Returns

  • boolean

Seek(num)

 View source »

Sets the tell to a position.

Parameters

  • num number

Returns

  • self

SetBigEndian()

 View source »

Sets the bitbuffer to be big-endian.

Returns

  • self BitBuffer The BitBuffer that was modified

SetLittleEndian()

 View source »

Sets the bitbuffer to be little-endian.

Returns

  • self BitBuffer The BitBuffer that was modified

View source »

Skips x bits ahead.

Parameters

  • num number

Returns

Tell()

 View source »

Returns where we're reading/writing from.

Returns

  • number

Write(str)

 View source »

Writes raw string-data.

Parameters

Returns

WriteAngle(angle)

 View source »

Writes an Angle.

Parameters

  • angle Angle

Returns

WriteBoolean(b)

 View source »

Writes a boolean.

Parameters

  • b boolean

Returns

  • self BitBuffer

WriteByte(byte)

 View source »

Writes a byte. ( 0 - 255 )

Parameters

  • byte number

Returns

WriteColor(color)

 View source »

Writes a 32bit Color.

Parameters

  • color Color

Returns

  • self BitBuffer

WriteDouble(num)

 View source »

Writes an IEEE 754 little-endian double.

Parameters

  • num number

Returns

WriteFloat(num)

 View source »

Writes an IEEE 754 little-endian float.

Parameters

  • num number

Returns

  • self BitBuffer

WriteLong(num)

 View source »

Writes a 4 byte number. ( -2147483648 - 2147483647 )

Parameters

  • num number

Returns

WriteNibble(num)

 View source »

Writes a 4 bit unsigned number. ( 0 - 15 )

Parameters

  • num number

Returns

WriteShort(num)

 View source »

Writes a 2 byte number. ( -32768 - 32767 )

Parameters

  • num number

Returns

WriteSignedByte(byte)

 View source »

Writes a signed byte. ( -128 - 127 )

Parameters

  • byte number

Returns

WriteSnort(num)

 View source »

Writes a 2 bit unsigned number. ( 0 - 3 )

Parameters

  • num number

Returns

WriteString(str)

 View source »

Writes a string. Max string length: 65535

Parameters

Returns

WriteStringNull(str)

 View source »

Writes a string using a nullbyte at the end. Note: Will remove all nullbytes given.

Parameters

Returns

WriteTable(tab)

 View source »

Writes a table

Parameters

Returns

  • self BitBuffer

WriteType(obj)

 View source »

Writes a type using a byte as TYPE_ID.

Parameters

  • obj any

Returns

WriteULong(num)

 View source »

Writes an unsigned 4 byte number. ( 0 - 4294967295 )

Parameters

  • num number

Returns

  • self BitBuffer

WriteUShort(num)

 View source »

Writes an unsigned 2 byte number. ( 0 - 65535 )

Parameters

  • num number

Returns

WriteVector(vector)

 View source »

Writes a Vector.

Parameters

  • vector Vector

Returns

__call(data, little_endian)

 View source »

Creates a new BitBuffer

Parameters

  • little_endian optional

Returns

__len()

 View source »

Returns lengh of the BitBuffer.

Returns

  • number

readraw(self, bits)

 View source »
Incomplete

Documentation for this section is incomplete and needs expanding.

Parameters

  • bits number

Returns

  • number

    The read data

writeraw(self, int, bits)

 View source »
Incomplete

Documentation for this section is incomplete and needs expanding.

Parameters

  • int number

  • bits number

Returns

  • self BitBuffer The BitBuffer that was modified

Tables

BitBuffer

 View source »
Incomplete

Documentation for this section is incomplete and needs expanding.

Fields

  • _tell number

  • _len number

  • _little_endian boolean

Fields

meta._writeraw

 View source »

Add raw (debug) functions