Data

Data is not creatable, there's only one instance of it. It can only be accessed through its globally exposed variable.

Data is used to transfer raw pieces of information.
It is possible to access any byte of a Data instance by indexing databyteIndex.

How to read a specific byte of a Data instance?

File:OpenAndReadAll(function(success, result)
  local data = result
  -- get the value of the 5th byte as a number
  local val = data[5]
end)

How to display an image data in a quad? (see [Quad](reference/quad).[Image](reference/quad#property-image) for more options)

File:OpenAndReadAll(function(success, result)
  quad.Image = result
end)

Functions

Data FromBundle ( string filepath )

Opens and returns data of an asset in the app bundle.

-- display the Cubzh logo from the app bundle
quad.Image = {
  data=Data:FromBundle("images/logo.png"),
  alpha=true
}
integer ReadByte ( )

Reads a byte (represented by an integer between 0 and 255) at current cursor, and advances it.

Color ReadColor ( )

Reads a Color at current cursor, and advances it.

number ReadDouble ( )

Reads a double-precision float (represented by a number) at current cursor, and advances it.

number ReadFloat ( )

Reads a single-precision float (represented by a number) at current cursor, and advances it.

integer ReadInt16 ( )

Reads a 16-bits integer (represented by an integer between -32768 and 32767) at current cursor, and advances it.

integer ReadInt32 ( )

Reads a 32-bits integer (represented by an integer between -2147483648 and 2147483647) at current cursor, and advances it.

integer ReadInt8 ( )

Reads an 8-bits integer (represented by an integer between -128 and 127) at current cursor, and advances it.

integer ReadInteger ( )

Reads an integer at current cursor, and advances it.

number ReadNumber ( )

Reads a number at current cursor, and advances it.

Number3 ReadNumber3 ( )

Reads a Number3 at current cursor, and advances it.

PhysicsMode ReadPhysicsMode ( )

Reads a PhysicsMode at current cursor, and advances it.

Rotation ReadRotation ( )

Reads a Rotation at current cursor, and advances it.

string ReadString ( )

Reads a string at current cursor, and advances it.

integer ReadUInt16 ( )

Reads an unsigned 16-bits integer (represented by an integer between 0 and 65535) at current cursor, and advances it.

integer ReadUInt32 ( )

Reads an unsigned 32-bits integer (represented by an integer between 0 and 4294967295) at current cursor, and advances it.

integer ReadUInt8 ( )

Reads an unsigned 8-bits integer (represented by an integer between 0 and 255) at current cursor, and advances it.

string ToString ( )

Returns the data as a string.

File:OpenAndReadAll(function(success, result)
  -- result type is Data
  local data = result
  local str = data:ToString()
  if string.sub(str, 1, 6) == "CUBZH!" then
    print("It's a Cubzh file!")
  end
end)
table ToTable ( )

Returns the data as a table.

nil WriteByte ( integer value )

Writes the given byte (represented by an integer between 0 and 255) at current cursor, and advances it.

nil WriteColor ( Color value )

Writes the given Color at current cursor, and advances it.

nil WriteDouble ( number value )

Writes the given double-precision float (represented by a number) at current cursor, and advances it.

nil WriteFloat ( number value )

Writes the given single-precision float (represented by a number) at current cursor, and advances it.

nil WriteInt16 ( integer value )

Writes the given 16-bits integer (represented by an integer between -32768 and 32767) at current cursor, and advances it.

nil WriteInt32 ( integer value )

Writes the given 32-bits integer (represented by an integer between -2147483648 and 2147483647) at current cursor, and advances it.

nil WriteInt8 ( integer value )

Writes the given 8-bits integer (represented by an integer between -128 and 127) at current cursor, and advances it.

nil WriteInteger ( integer value )

Writes the given integer at current cursor, and advances it.

nil WriteNumber ( number value )

Writes the given number at current cursor, and advances it.

nil WriteNumber3 ( Number3 value )

Writes the given Number3 at current cursor, and advances it.

nil WritePhysicsMode ( PhysicsMode value )

Writes the given PhysicsMode at current cursor, and advances it.

nil WriteRotation ( Rotation value )

Writes the given Rotation at current cursor, and advances it.

nil WriteString ( string value )

Writes the given string at current cursor, and advances it.

nil WriteUInt16 ( integer value )

Writes the given unsigned 16-bits integer (represented by an integer between 0 and 65535) at current cursor, and advances it.

nil WriteUInt32 ( integer value )

Writes the given unsigned 32-bits integer (represented by an integer between 0 and 4294967295) at current cursor, and advances it.

nil WriteUInt8 ( integer value )

Writes the given unsigned 8-bits integer (represented by an integer between 0 and 255) at current cursor, and advances it.

Properties

integer Cursor

Current cursor index inside Data. The cursor advances whenever one of the read/write functions is used. It can also be set directly beforehand.

number Length

Number of bytes the Data contains.

HTTP:Get("cu.bzh", function(result)
-- result type is Data
  for i = 1, result.Length do
    -- goes through every byte of the provided Data
  end
end)