Template:API member

From TeamSpec Wiki
Revision as of 03:48, 20 October 2026 by TeamSpecBot (talk | contribs) (Template: scripting reference member block)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

One member of a gamemode scripting class: its signature, what it does, its parameters and what it returns. Put the member's own heading (its exact name) just above it, so links can point at Page#member_name.

Usage

=== respawn_in ===
{{API member
|name=respawn_in
|kind=Method
|signature=respawn_in(entity_id: int, seconds: float) -> void
|scripts=<code>server.gd</code>, <code>bot.gd</code>
|params=* <code>entity_id</code>: <code>int</code>
* <code>seconds</code>: <code>float</code>
|returns=<code>void</code>
|description=Brings the player back after the given time.
}}

Parameters

  • name: the member's name.
  • kind: Method, Hook, Property or Constant.
  • signature: the full signature, shown in code style. Write &#124; for a pipe.
  • scripts: which scripts may use it (optional).
  • params: a bullet list of parameters (optional).
  • returns: the return type (optional).
  • description: what it does.