CollectionsUsed = { 10, 16 }

Players[0]._favorite_flavor = "chocolate"

Colors

Colors

Colors are standard Lua tables; you don't need to call a new() method to create them. Colors have four fields, accessed by name or number. If a field is missing, it is assumed to be 1, which allows you to write opaque colors as {r, g, b}.

.r
.red
[1]

red component, from 0 to 1

.g
.green
[2]

green component, from 0 to 1

.b
.blue
[3]

blue component, from 0 to 1

.a
.alpha
[4]

alpha component (opacity), from 0 to 1

Fonts

Fonts.new{ [file=] [, size=] [, style=]}

• file: the path to a TTF file, for the standard variant of the font (the special path "mono" indicates the default Mono Sans font) [default: "mono"]
• size: the font size to use [default: 12]
• style: a number indicating the sum of any font styles to use (1 - bold; 2 - italic; 4 - underline) [default: 0]

Fonts.new{id= [, size=] [, style=]}

• id: a resource ID from the Fonts file (for the default Fonts file, valid values are 4 for Monaco and 22 for Courier)
• size: the font size to use [default: 12]
• style: a number indicating the sum of any font styles to use (1 - bold; 2 - italic; 4 - underline) [default: 0]

Fonts.new{interface=} 20140104

• interface: see InterfaceFonts for mnemonics

Fonts[index]

.id (read-only)

can be nil

.file (read-only)

can be nil

.size (read-only)

.style (read-only)

.line_height (read-only)

.scale 20140104

scale factor, for resizing specific bitmap font sizes

it's usually better to create a new font at the correct size instead

:measure_text(string)

returns the width and height of a string when drawn in this font

:draw_text(string, x, y, color)

draws a string to the screen

transparency only available in OpenGL renderer

Game

Game

all items in Game are read-only

.deserialize(s) git

deserializes s and returns the original Lua value

see Game.serialize (from the non-HUD scripter's guide)

.difficulty

the difficulty level

.kill_limit

the game kill limit, or nil if there is none

.time_remaining

the number of ticks until the game ends, or nil if there is no time limit

.scoring_mode

the current scoring mode (if the gametype is "custom")

.ticks

ticks since game started

.type

whether the game is EMFH, KOTH, etc.

.version

the date version of the local player's engine

for example, "20071103"

.players[index]

.active 20111201

true if this player's viewpoint is currently displayed

.color

color of player (shirt color, if teams are enabled)

.kills

player kills, not including suicides

.local_

true if this player is the local player

.name

.ranking

points or ticks, depending on game type

.team

player's team (pants color)

Images

Images.new{resource=}

• resource: a resource ID from the Images file

Images.new{path= [, mask=]}

• path: the path to the image file to use
• mask: the path to an image file to use as an opacity mask

Images[index]

.width (read-only)

width of the image in pixels

.height (read-only)

height of the image in pixels

.unscaled_width (read-only)

width of the image before any calls to :rescale()

.unscaled_height (read-only)

height of the image before any calls to :rescale()

.crop_rect

specifies a portion of the image to be drawn

.height

.width

.x

.y

.tint_color

scale the color and opacity by this value when drawing

default is (r=1, g=1, b=1, a=1)

only available in OpenGL renderer

.rotation

degrees to rotate the image when drawn

axis of rotation is about the center of the drawn area

only available in OpenGL renderer

:rescale(width, height)

resize image to specified width and height

:draw(x, y)

draw image (or cropped portion) to screen, with top left corner at specified position

Level

Level

all items in Level are read-only

.name 20150619

level name

.index 20150619

level index in the map file (starting from 0)

.map_checksum 20150619

checksum of map file

.stash[key] git

reads values from a stash shared between all running Lua scripts

keys/values must be strings

Lighting

Lighting

All items in Lighting are read-only

.ambient_light

light level in current location, from 0 to 1

.weapon_flash

current brightness of weapons fire, from 0 to 1

.liquid_fader
.damage_fader

faders only available in OpenGL, when "Color Effects" are enabled

.active

true if fade effect is being drawn

.color

color used for this fade effect

.type

which fade effect type is used

Player

Player

All items in Player are read-only

.color

color of player (shirt color, if teams are enabled)

.dead

whether player is dead

.direction
.yaw

direction player is facing, in degrees

0 is east, 90 is south

.elevation
.pitch

angle player is looking up or down

.velocity

.forward 20111201

player's forward/backward velocity, from internal and external forces

in WU per tick; positive values mean forward movement

.perpendicular 20111201

player's left/right velocity

in WU per tick; positive values mean rightward movement

.vertical 20111201

player's up/down velocity

in WU per tick; positive values mean upward movement

.energy
.life

amount of suit energy player has (150 is normal red health)

.microphone_active

true if netmic is on

.inventory_sections

.current

which section of the inventory to display

HUD themes can choose to display multiple sections simultaneously

.inventory_sections[section_type]

.name

.type

.items[item_type]

.count

how many of item the player is carrying

.inventory_section

which section of the inventory should display this item

.plural

label to use for more than 1 of the item

from stringset 150

.singular

label to use for 1 of the item

from stringset 150

.type

.valid 20140104

whether item is valid in the current environment (i.e. vacuum)

.compass

.ne
.northeast

whether north east compass quadrant is active

.nw
.northwest

whether north west compass quadrant is active

.se
.southeast

whether south east compass quadrant is active

.sw
.southwest

whether south west compass quadrant is active

.motion_sensor

.active

whether player can view his motion sensor

currently, this also indicates compass visibility

.blips[index]

.direction
.yaw

direction relative to player, in degrees

0 is to player's right, 90 is directly behind player

.distance

distance from player, in WU (maximum is 8)

.intensity

from 0 (strongest) to 5 (weakest)

.type

see "Sensor Blip Types" for mnemonics

.name

player's name

.oxygen

amount of oxygen player has (max is 10800)

.respawn_duration 20140104

ticks remaining before dead player can revive

nil until player is completely dead

.team

player's team (pants color)

.texture_palette

.highlight

number of slot to highlight

can be nil

.size

how many slots the palette is using

the texture palette is normally visible whenever the size is greater than 0

.slots[n]

.collection

collection of this slot

.texture_index

texture index of this slot

.type

texture type of this slot such as wall or sprite; see "Texture Types"

.weapons

.current

weapon the player is currently wielding

can be nil

.desired

weapon the player wants to switch to

can be nil

.weapons[weapon_type]

.name 20111201

label shown in classic HUD

from stringset 137; may differ from label in Player.items

.name_rect 20140104

position of label in classic HUD

.height

.width

.x

.y

.primary
.secondary

.ammo_type

.bullet_display 20140104

can be nil

.across

number of bullets in a single row

.down

number of bullet rows

.empty_texture_index

.height

height of a single bullet in classic HUD

.right_to_left

.texture_index

.width

width of a single bullet in classic HUD

.x

.y

.energy_display 20140104

can be nil

.color

the interface color for drawing the full region and border

.empty_color

the interface color for drawing the empty region

.height

.maximum

should usually match total_rounds

.width

.x

.y

.rounds

how many rounds are currently loaded into the weapon

.total_rounds

how many rounds can be loaded into the weapon

.weapon_drawn

.shape 20140104
.multiple_shape
.multiple_unused_shape

can be nil

.texture_index

frame in Interface collection

.x

.y

.type

.zoom_active

whether player's sniper zoom is active

Screen

Screen

.width (read-only)

width of the available screen area

.height (read-only)

height of the available screen area

.field_of_view

.fix_h_not_v

whether horizontal or vertical FOV is adjusted as aspect ratio changes

.horizontal

.vertical

.crosshairs

.active (read-only) 20111201

whether crosshairs are visible

.lua_hud 20111201

whether the Lua HUD script draws the crosshairs

.renderer (read-only)

which renderer is in use

.map_active (read-only)

whether the overhead map is currently displayed

.map_overlay_active (read-only) 20111201

whether the "Overlay Map" preference is enabled

.term_active (read-only)

whether a terminal is currently displayed

.hud_size_preference (read-only)

current preference setting for HUD size (normal, double, largest)

.term_size_preference (read-only)

current preference setting for terminal size (normal, double, largest)

.masking_mode

image-based masking; set to drawing mode to create visible areas and enabled to use the mask

masking only available in OpenGL renderer

.clip_rect

constrain drawing to the specified area of the screen

.height

.width

.x

.y

.world_rect

specifies the area of the screen for the 3D game view

.height

.width

.x

.y

.map_rect

specifies the area of the screen for the overhead map

.height

.width

.x

.y

.term_rect

specifies the area of the screen for displaying terminals

.height

.width

.x

.y

.text_margins git

specifies margins from the edges of the world_rect for drawing text such as Lua overlays, messages, and the input console

.bottom

.left

.right

.top

.clear_mask()

reset the image-based mask

.fill_rect(x, y, width, height, color)

draws a solid rectangle to the screen

.frame_rect(x, y, width, height, color, thickness)

draws an outlined rectangle to the screen

• thickness: outline size in pixels

the outline is drawn entirely inside the given bounds

Shapes

Shapes.new{collection=, texture_index= [, type=] [, color_table=]}

all arguments are passed by name; returns shape or nil

• collection: the shape collection
• texture_index: frame (not bitmap) index
• type: type such as wall or sprite; see "Texture Types"
• color_table: color table index

Shapes[index]

.width (read-only)

width of the shape in pixels

.height (read-only)

height of the shape in pixels

.unscaled_width (read-only)

width of the shape before any calls to :rescale()

.unscaled_height (read-only)

height of the shape before any calls to :rescale()

.crop_rect

specifies a portion of the shape to be drawn

.height

.width

.x

.y

.tint_color

scale the color and opacity by this value when drawing

default is (r=1, g=1, b=1, a=1)

only available in OpenGL renderer

.rotation

degrees to rotate the shape when drawn

axis of rotation is about the center of the drawn area

only available in OpenGL renderer

:rescale(width, height)

resize shape to specified width and height

:draw(x, y)

draw shape (or cropped portion) to screen, with top left corner at specified position

Collections

# Collections

Collections()

Collections[collection]

.bitmap_count

number of bitmaps in collection

Mnemonics

Difficulty

# DifficultyTypes

DifficultyTypes()

Mnemonics

• "kindergarten"
• "easy"
• "normal"
• "major damage"
• "total carnage"

Fade Effect Types

# FadeEffectTypes

FadeEffectTypes()

Mnemonics

• "tint"
• "randomize"
• "negate"
• "dodge"
• "burn"
• "soft tint"

Game Types

# GameTypes

GameTypes()

Mnemonics

Interface Colors 20140104

# InterfaceColors

InterfaceColors()

InterfaceColors[interface_color]

.r (read-only)
.red (read-only)

.g (read-only)
.green (read-only)

.b (read-only)
.blue (read-only)

.a (read-only)
.alpha (read-only)

alpha is always 1

Mnemonics

Interface Fonts 20140104

# InterfaceFonts

InterfaceFonts()

Mnemonics

• "interface"
• "weapon name"
• "player name"
• "interface item count"
• "terminal"
• "terminal title"
• "network statistics"

Interface Rectangles 20140104

# InterfaceRects

InterfaceRects()

InterfaceRects[interface_rect]

.x (read-only)

.y (read-only)

.width (read-only)

.height (read-only)

Mnemonics

Inventory Sections

# InventorySections

InventorySections()

Mnemonics

• "weapons"
• "ammunition"
• "powerups"
• "items"
• "weapon powerups"
• "balls"
• "network statistics"

Items

# ItemTypes

ItemTypes()

Mnemonics

Masking Modes

# MaskingModes

MaskingModes()

Mnemonics

• "disabled"
• "enabled"
• "drawing"
• "erasing"

Player and Team Colors

# PlayerColors

PlayerColors()

Mnemonics

• "slate"
• "red"
• "violet"
• "yellow"
• "white"
• "orange"
• "blue"
• "green"

Renderer Types

# RendererTypes

RendererTypes()

Mnemonics

• "software"
• "opengl"
• "shader"

Scoring Modes

# ScoringModes

ScoringModes()

Mnemonics

• "most points"
• "most time"
• "least points"
• "least time"

Sensor Blip Types

# SensorBlipTypes

SensorBlipTypes()

Mnemonics

• "friend"
• "alien"
• "hostile player"

Size Preferences

# SizePreferences

SizePreferences()

Mnemonics

• "normal"
• "double"
• "largest"

Texture Types

# TextureTypes

TextureTypes()

Mnemonics

• "wall"
• "landscape"
• "sprite"
• "weapon in hand"
• "interface"

Weapons

# WeaponTypes

WeaponTypes()

Mnemonics