Cauldron2D.Worlds.Table (Cauldron2D v0.2.2)

Copy Markdown View Source

The registered worlds, one record each, in an ETS table this process owns.

Cauldron2D.Worlds.Table.put(:pit, %{id: :pit, opts: [game: MyGame], listing: %{name: "The Pit"}})
Cauldron2D.Worlds.Table.all()
Cauldron2D.Worlds.Table.listings()

A record's listing is kept beside it so listings/0 reads the listings alone, leaving the records — a game's options can be large — where they are.

Summary

Functions

all()

Every world's record.

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

delete(id)

Forget world id.

get(id)

The record of world id, or nil.

listings()

Every world's id with its listing, copying nothing else of the records.

put(id, record)

Record world id; record.listing, when there is one, is what listings/0 returns for it.

Functions

all()

@spec all() :: [map()]

Every world's record.

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

See Supervisor.

delete(id)

@spec delete(term()) :: :ok

Forget world id.

get(id)

@spec get(term()) :: map() | nil

The record of world id, or nil.

listings()

@spec listings() :: [{term(), map()}]

Every world's id with its listing, copying nothing else of the records.

put(id, record)

@spec put(term(), map()) :: :ok

Record world id; record.listing, when there is one, is what listings/0 returns for it.