QuakeServer.Args (quake_server v0.1.0)

Copy Markdown View Source

A builtin's arguments and result: argument i (from 0) sits in the program's parameter slots at 4 + 3 * i, and the result goes to slot 1.

QuakeServer.Args.num(server, 0)
QuakeServer.Args.return(server, 1.0)

Summary

Functions

Argument i as an integer: an entity, an integer or a float cut to one.

Argument i as a float.

Argument i as a float, or default when the call passed fewer than i + 1 arguments.

Write the builtin's result; a vector fills three slots, a boolean becomes 1.0 or 0.0.

The value of global self, an entity number.

Argument i as it is held.

Argument i as text.

Argument i as text, or default when the call passed fewer than i + 1 arguments.

Argument i as a vector.

Argument i's three slots as they are held, for a value of any type.

Functions

int(host, i)

@spec int(map(), non_neg_integer()) :: integer()

Argument i as an integer: an entity, an integer or a float cut to one.

num(host, i)

@spec num(map(), non_neg_integer()) :: float()

Argument i as a float.

num(host, i, argc, default)

@spec num(map(), non_neg_integer(), non_neg_integer(), float()) :: float()

Argument i as a float, or default when the call passed fewer than i + 1 arguments.

return(host, value)

@spec return(map(), QuakeC.value() | QuakeC.vector() | boolean()) :: map()

Write the builtin's result; a vector fills three slots, a boolean becomes 1.0 or 0.0.

self(host)

@spec self(map()) :: non_neg_integer()

The value of global self, an entity number.

slot(host, i)

@spec slot(map(), non_neg_integer()) :: QuakeC.value()

Argument i as it is held.

str(host, i)

@spec str(map(), non_neg_integer()) :: String.t()

Argument i as text.

str(host, i, argc, default)

@spec str(map(), non_neg_integer(), non_neg_integer(), String.t()) :: String.t()

Argument i as text, or default when the call passed fewer than i + 1 arguments.

vec(host, i)

@spec vec(map(), non_neg_integer()) :: QuakeC.vector()

Argument i as a vector.

vec_raw(host, i)

@spec vec_raw(map(), non_neg_integer()) ::
  {QuakeC.value(), QuakeC.value(), QuakeC.value()}

Argument i's three slots as they are held, for a value of any type.