Cauldron2D.GameMaker.Room.Instance (Cauldron2D.GameMaker v0.2.1)

Copy Markdown View Source

An instance a room places: object object at {x, y}, with the id the game's code knows it by.

scale is {x, y}, negative to mirror; rotation is in degrees, counter-clockwise; colour is {r, g, b, a} blended over the sprite; image is {speed, index} from GameMaker Studio 2 files and {1.0, 0} from older ones. creation_code and pre_create_code are code entry indices, nil for none.

Summary

Functions

The instance at at, size bytes long: 36 or 40 in GameMaker Studio 1 files, 44 or 48 in GameMaker Studio 2 files, the longer of each carrying pre-create code.

Types

t()

@type t() :: %Cauldron2D.GameMaker.Room.Instance{
  colour: {byte(), byte(), byte(), byte()},
  creation_code: non_neg_integer() | nil,
  id: non_neg_integer(),
  image: {number(), integer()},
  object: integer(),
  position: {integer(), integer()},
  pre_create_code: non_neg_integer() | nil,
  rotation: number(),
  scale: {number(), number()}
}

Functions

read(data, at, size)

@spec read(binary(), non_neg_integer(), 36 | 40 | 44 | 48) :: t()

The instance at at, size bytes long: 36 or 40 in GameMaker Studio 1 files, 44 or 48 in GameMaker Studio 2 files, the longer of each carrying pre-create code.