Wiremod

https://github.com/wiremod/wire
Admin
Wiremod is a Garry's Mod addon that introduces entities communicating via wires, enabling the...
Tokens:158,987
Snippets:1,391
Trust Score:7.3
License:Apache-2.0
Update:2 months ago
Show doc for...
Tokens:
Raw
### Full file read and write example

Source: https://github.com/wiremod/wire/wiki/E2-Guide:-File-Extension

A complete script demonstrating writing to a file, waiting for the write event, and reading the file back.

```ruby
@name File Write and Read
@trigger none
@strict

fileWrite("test.txt", "Hello, World! " + curtime())

event fileWritten(Path:string, _:string) {
    fileLoad(Path)
}

event fileLoaded(Path:string, Data:string) {
    print(format("%s: %s \nTime: %f", Path, Data, curtime()))
}
```

--------------------------------

### Full File Queuing Example

Source: https://github.com/wiremod/wire/wiki/E2-Guide:-File-Extension

A complete script combining write, list, and load operations using E2 file queues.

```ruby
@name File Queues
@trigger none
@strict

for(I = 1, 10) {
    if(fileCanWrite()) {
        fileWrite(format("manyfiles/%d.txt", I), format("This is file #%d!", I))
    } else { break }
}

event fileWritten(_:string, _:string) {
    if(fileWriteQueued() == 0) {
        fileList("manyfiles/")
    }
}

event fileList(Path:string, Contents:array) {
    foreach(_:number, Name:string = Contents) {
        if(fileCanLoad()) {
            fileLoad(Path + Name)
        } else { break }
    }
}

event fileLoaded(Path:string, Data:string) {
    print(format("%s: %s", Path, Data))
}
```

--------------------------------

### Utility Functions

Source: https://github.com/wiremod/wire/blob/master/data_static/expression2/tests/runtime/base/stringcall/builtins.txt

Examples of using select, min, and max built-in functions.

```Expression2
assert( "select"(1, "test", "foo", "bar")[string] == "test" )
assert( "min"(1, 2)[number] == 1 )
assert( "max"(1, 2)[number] == 2 )
```

--------------------------------

### Do-While Loop Syntax Examples

Source: https://github.com/wiremod/wire/blob/master/data_static/expression2/tests/compiler/parser/while.txt

Do-while loop structures demonstrating loop bodies with assignments and control flow statements.

```expression2
do { A = 0 } while (1)
```

```expression2
do { break } while (2)
```

```expression2
do { continue } while (3)
```

--------------------------------

### Apply Launch Force

Source: https://github.com/wiremod/wire/wiki/E2:-Physics

Example of how to apply the calculated launch vector to a prop by accounting for current velocity and mass.

```golo
E:applyForce((LV-E:vel())*E:mass())
```

--------------------------------

### Foreach Loop with Tables and Entities

Source: https://github.com/wiremod/wire/blob/master/data_static/expression2/tests/compiler/parser/foreach.txt

Examples of iterating over tables using entity types and wildcard placeholders.

```expression2
foreach (K:number, _:entity = table()) {}
```

```expression2
foreach (_, _:entity = table()) {}
```

--------------------------------

### Formatted Foreach Loop

Source: https://github.com/wiremod/wire/blob/master/data_static/expression2/tests/compiler/parser/foreach.txt

A multi-line foreach loop example with explicit type annotations.

```expression2
foreach (K: number, V: number = array(1, 2, 3)) {
	continue
}
```

--------------------------------

### While Loop Syntax Examples

Source: https://github.com/wiremod/wire/blob/master/data_static/expression2/tests/compiler/parser/while.txt

Basic while loop structures including simple assignments and control flow statements.

```expression2
while (1) { A = 0 }
```

```expression2
while (1) { break }
```

```expression2
while (1) { continue }
```

--------------------------------

### ifndef Preprocessor Directive Examples

Source: https://github.com/wiremod/wire/blob/master/data_static/expression2/tests/compiler/preprocessor/commands/ifndef.txt

Demonstrates the usage of ifndef for conditional compilation checks.

```text
## SHOULD_PASS:COMPILE

#ifndef print(...)
	#error Uhh
#endif

#ifndef print(...)
	#error Uhh 2
#else
#endif
```

--------------------------------

### Example of strict mode behavior

Source: https://github.com/wiremod/wire/wiki/Expression-2-Directives

Demonstrates how strict mode handles invalid entity references compared to non-strict mode.

```golo
E = propSpawn("some/custom/model.mdl", entity():pos(), 1)
E:applyForce( vec(10000, 0, 0) )
```

--------------------------------

### Configure Circle Rendering

Source: https://github.com/wiremod/wire/blob/master/data_static/gpuchip/lib/drivers/drv_gl.txt

Sets the quality, start, and end parameters for circle drawing operations.

```C-like
void glCircleQuality( float n ) {
    mov #regCircleQuality,n;
}
void glCircleStart( float n ) {
    mov #regCircleStart,n;
}
void glCircleEnd( float n ) {
    mov #regCircleEnd,n;
}
```

--------------------------------

### Audio Channel Initialization

Source: https://github.com/wiremod/wire/blob/master/data_static/spuchip/examples/mario_theme.txt

Configures the audio channels for the track and bass lines by setting wave types, volumes, and starting playback.

```Wiremod
// Set track wave to channel 0 and start
wset 0,trackwave;
chwave 0,0;
chvolume 0,0.2;
chstart 0;

// Set track wave to channel 1 and start
wset 1,trackwave;
chwave 1,1;
chvolume 1,0.2;
chstart 1;

// Set bass wave to channel 2 and start
wset 2,basswave;
chwave 2,1;
chvolume 2,0.3;
chstart 2;
```

--------------------------------

### owner()

Source: https://github.com/wiremod/wire/wiki/e2-docs-selfaware

Gets the owner of the expression.

```APIDOC
## owner()

### Description
Gets the owner of the expression (same as entity():owner()).

### Returns
- **Entity** - The owner of the expression.
```

--------------------------------

### Defining Expression 2 Events

Source: https://github.com/wiremod/wire/wiki/Expression-2-Events

Examples of declaring chat and key press events. Events are compile-time constructs and should not be nested inside conditional statements.

```golo
event chat(Ply:entity, Said:string, Team:number) {
    print(Ply, " just said ", Said)
}

Owner = owner()
event keyPressed(Ply:entity, Key:string, Down:number, Bind:string) {
    if (Ply == Owner & !Down) {
        print("Owner released key " + Key)
    }
}
```

--------------------------------

### entity()

Source: https://github.com/wiremod/wire/wiki/e2-docs-selfaware

Gets the entity of the expression.

```APIDOC
## entity()

### Description
Gets the entity of the expression.

### Returns
- **Entity** - The entity associated with the expression.
```

--------------------------------

### Sample Code Syntax Highlighting

Source: https://github.com/wiremod/wire/wiki/Misc:-Wiki-Contribution-Guide

Recommended syntax highlighting options for sample code in the wiki.

```golo
function myFunction(MyVar:string) { print("Hello " + MyVar) } # prints 'Hello' followed by MyVar, golo
```

```ts
function myFunction(MyVar:string) { print("Hello " + MyVar) } # prints 'Hello' followed by MyVar, ts
```

```ruby
function myFunction(MyVar:string) { print("Hello " + MyVar) } # prints 'Hello' followed by MyVar, ruby
```

--------------------------------

### holoAng

Source: https://github.com/wiremod/wire/wiki/e2-docs-hologram

Sets or gets the angle of a hologram.

```APIDOC
## holoAng(Number Index, Angle Ang)
## Angle = holoAng(Number Index)

### Description
Sets or retrieves the angle of the hologram.
```

--------------------------------

### holoPos

Source: https://github.com/wiremod/wire/wiki/e2-docs-hologram

Sets or gets the position of a hologram.

```APIDOC
## holoPos(Number Index, Vector Position)
## Vector = holoPos(Number Index)

### Description
Sets or retrieves the position of the hologram.
```

--------------------------------

### Initialize and use a persistent table

Source: https://github.com/wiremod/wire/wiki/E2:-Tips-and-Tricks

Demonstrates creating a table to store settings and timing information for a floating holo, including dynamic entry creation.

```golo
@name HoloBubble
@inputs Spawn
@persist P:table
if(first()){
  # default settings
  P=table(
    "speed"=2,
    "scale"=1,
    "alpha"=127,
    "material"="models/debug/debugwhite",
    "lifetime"=50 )
  runOnChat(1) # We'll need this later
}
elseif(~Spawn & Spawn){ # Button pressed
  holoCreate(1, entity():pos(), vec(P["scale",number]), ang())
  holoAlpha(1, P["alpha",number])
  holoMaterial(1, P["material",string])
  P["holo age",number]=0 # Just create new entries on the fly
  stoptimer("move") # stop any old timers
  timer("move", 100)
}
elseif(clk("move")){
  if(P["holo age",number]<P["lifetime",number]){
    holoPos(1, holoEntity(1):pos()+vec(0,0,P["speed",number]))
    timer("move", 100)
  }
  else{
    holoDelete(1) # delete holo after its too old
  }
}
```

--------------------------------

### Switch Statement Implementation

Source: https://github.com/wiremod/wire/wiki/E2:-Tips-and-Tricks

Demonstrates the syntax for switch statements, including multiple cases and fallthrough logic.

```golo
switch(Command){  # The variable to check
  case "print",   # do this when Command == "print"
    print("Hello")
    break         # end of this block
  case "reset",   # multiple cases are allowed
  case "restart", # do this when Command == "reset" or Command == "restart"
    reset()
    break
  case "save_and_exit",
    save_something() # notice the missing "break" here
  case "exit",       # if there is no break, it continues on with the next block
    exit()           # so exit() is ran in both cases, but save only in the top one
    break
  default,           # ran when no case matches, this is optional
    error("command not found")
}
```

--------------------------------

### Entity:ragdollGetPose

Source: https://github.com/wiremod/wire/wiki/e2-docs-custom-prop

Gets the pose of a ragdoll.

```APIDOC
## Table Entity:ragdollGetPose()

### Description
Gets a specially built table containing the pose of the ragdoll (150 ops).
```

--------------------------------

### Entity:ragdollGetAng

Source: https://github.com/wiremod/wire/wiki/e2-docs-custom-prop

Gets the angle of a ragdoll.

```APIDOC
## Angle Entity:ragdollGetAng()

### Description
Returns the angle of the ragdoll (5 ops).
```

--------------------------------

### Render 3D Letter A

Source: https://github.com/wiremod/wire/blob/master/data_static/gpuchip/examples/3d_letter_a.txt

Initializes the graphics pipeline, sets up the camera and lighting, and renders the vertex buffer.

```cpp
// Author: Drunkie
// Description: Draws a 3D model of the letter A

Main();

#include <drivers\drv_gl.txt>

void Main()
{
    glSleep( 40 ); // Sleep for 40 milliseconds (reduces fps lag)
    glClear( 100, 149, 237 ); // Clear screen

    glCoordPipe( GL_CPIPE_N1_1 ); // Set coordinate pipe to [-1 to 1] mode
    glVertexPipe( GL_VPIPE_XYZTRANSFORM ); // Set vertex pipe to xyz transformation

    glLightPos( 0, 0, -50 ); // Set the light position
    glLightColor( 255, 255, 255, 1 ); // Set the light color

    glLookAt(
        0, 0, -2.8, // Camera pos
        0, 0, 0, // Camera target
        0, 1, 0 // Camera up
    );

    // Create variable to hold curtime
    float time;
    timer time;

    // Create perspective and matrix transformations
    glPerspective( 30, 1, 1, 20 ); // FOV, ASPECT RATIO, ZNEAR, ZFAR
    glRotate( 0, 1, 0, time ); // AXIS X, Y, Z, ANGLE W
    glTranslate( 0, -0.1, 0, 0 ); // TRANSLATION X, Y, Z
    glScale( 1, 1, 1, 0 ); // SCALE X, Y, Z

    glEnable( GL_VERTEX_BUFFER ); // Enable vertex buffer
    glEnable( GL_VERTEX_ZSORT ); // Enable Z sorting
    glEnable( GL_VERTEX_LIGHTING ); // Enable vertex lighting
    glEnable( GL_VERTEX_CULLING ); // Enable face culling

    // Solid 3D polygon
    glFillMode( GL_FILL_SOLID ); // Set fillmode as solid
    glColor4( 255, 255, 255, 255 ); // Set draw color with alpha
    glPoly3D( vertexBuffer, 30 ); // Draw 3D polygon
    glFlush(); // Flush the vertex buffer to the screen

    glExit(); // Exit
}
```

--------------------------------

### Initialize Audio Channels

Source: https://github.com/wiremod/wire/blob/master/data_static/spuchip/examples/beatbox.txt

Sets up initial channel configurations including wave types, pitch, and file assignments.

```Wiremod
wset 4,inst1;
chwave 1,4;
chpitch 1,2.55;

chwave 2,0;
chvolume 2,0.5;
chstart 2;
chpitch 2,0;
```

--------------------------------

### Entity:pos()

Source: https://github.com/wiremod/wire/wiki/e2-docs-entity

Gets the position of the entity.

```APIDOC
## Entity:pos()

### Description
Gets the position of the entity.
```

--------------------------------

### height

Source: https://github.com/wiremod/wire/wiki/e2-docs-compat

Gets the height of a player or npc.

```APIDOC
## Number:height()

### Description
Gets the height of a player or npc.
```

--------------------------------

### Lookup Table Basics

Source: https://github.com/wiremod/wire/wiki/E2:-Tips-and-Tricks

Demonstrates creating, writing to, and reading from lookup tables with default value handling.

```golo
# Create table once, using numbers as values
Table = table("someKey" = 1, "someOtherKey" = 42, "STEAM_0:0:12345"=1)
# Write to table
Table[Key, number] = Value
# Example usecases
if(Table:exists(Key)){ ... # Check if entry exists
if(Table[Key, number]){ ... # Check if entry is !=0 (and exists)
Value = Table[Key, number] ?: 1337 # Read value from table or return a default value if entry doesn't exist
```

--------------------------------

### Entity:getSkinCount

Source: https://github.com/wiremod/wire/wiki/e2-docs-entity

Gets the number of skins for the entity.

```APIDOC
## Entity:getSkinCount()

### Description
Returns the number of skins available for the entity.

### Returns
- **Number** - The count of skins.
```

--------------------------------

### Implement E2 Triggers with first(), Inputs, and Timers

Source: https://github.com/wiremod/wire/wiki/E2:-Triggers

Demonstrates handling spawn events, input changes, and scheduled timer callbacks within a single E2 script.

```golo
@name TriggerExample
@inputs Start Delay
@output Done
@persist Counter # Keep this variable between executions
if( first() ) {
  print( "E2 was spawned!" )
}
elseif( ~Start ) {
  print( "Start input changed value!")
  if( Start ) {
	Counter = Delay
	stoptimer( "decrease_counter" ) # Stop any existing timers, to combat button-spam
	timer( "decrease_counter", 1000 ) # Schedule a execution in 1000ms (=1s)
  }
}
elseif( clk( "decrease_counter" ) ) {
  print( "Triggered by timer with name decrease_counter" )
  Counter--
  if( Counter > 0) {
	timer( "decrease_counter", 1000 ) # Schedule another execution
  }
  else { # Counter <= 0
	print("Time's up!")
	Done = 1
	timer( "reset_output", 500 ) # Schedule a different timer in 0.5s
  }
}
elseif( clk("reset_output") ) {
  print( "Triggered by timer with name reset_output" )
  Done = 0
}
```

--------------------------------

### Entity:id()

Source: https://github.com/wiremod/wire/wiki/e2-docs-entity

Gets the numeric id of an entity.

```APIDOC
## Entity:id()

### Description
Gets the numeric id of an entity.
```

--------------------------------

### Initialize Chat Command Table

Source: https://github.com/wiremod/wire/wiki/E2-Guide:-Lambdas

Sets up the command table and the chat event listener to detect the command prefix.

```ruby
@strict
const Functions = table()
const Keyword = "/"

event chat(Player:entity, Message:string, _:number) {
    if(Message[1] == Keyword) {

    }
}
```

--------------------------------

### signalGetGroup

Source: https://github.com/wiremod/wire/wiki/e2-docs-signal

Gets the E-2's current signal group.

```APIDOC
## String signalGetGroup()

### Description
Returns the E-2's current signal group name.
```

--------------------------------

### Initialize and manipulate vec4

Source: https://github.com/wiremod/wire/blob/master/data_static/expression2/tests/runtime/types/vector4.txt

Demonstrates basic initialization, component access via indexing and methods, and string conversion.

```lua
local Vec = vec4(1, 2, 3, 4)

assert(Vec == vec4(1, 2, 3, 4))
assert(Vec != vec4(2, 2, 1, 0))

assert(Vec[1] == 1)
assert(Vec[2] == 2)

assert(Vec:x() == Vec[1])
assert(Vec:y() == Vec[2])
assert(Vec:z() == Vec[3])
assert(Vec:w() == Vec[4])

assert(Vec:toString() == "[1,2,3,4]", Vec:toString())

Vec[1] = 78
Vec[2] = 33
Vec[3] = 21

assert(Vec[1] == 78)
assert(Vec[2] == 33)
assert(Vec[3] == 21)
assert(Vec[4] == 4)
```

--------------------------------

### Basic Foreach Loop Syntax

Source: https://github.com/wiremod/wire/blob/master/data_static/expression2/tests/compiler/parser/foreach.txt

Demonstrates standard foreach loop usage with break and continue statements.

```expression2
foreach(K,V:number=array(1, 2, 3)) { break }
```

```expression2
foreach (K:number,V:number=array(1, 2, 3)) { continue }
```

--------------------------------

### Entity:boxSize

Source: https://github.com/wiremod/wire/wiki/e2-docs-entity

Gets the dimensions of the entity's bounding box.

```APIDOC
## Entity:boxSize()

### Description
Gets the dimensions of the entity's bounding box as a vector (length, width, height).

### Returns
- **Vector** - The bounding box dimensions.
```

--------------------------------

### Iterate over mixed tables in Expression 2

Source: https://github.com/wiremod/wire/blob/master/data_static/expression2/tests/regressions/2803.txt

Demonstrates table initialization and iteration using foreach loops to verify element counts based on type constraints.

```Expression 2
local TabMixedNonSeq = table(1 = 1, 2 = 2, 3 = 3, 10 = 10, 100 = 100, 2359 = 2359, # 6
                             4 = "4", 5 = "5", 6 = "6", 11 = "11", 123 = "123", # 5
                             "s" = "s", "foo" = "bar") # 2

local TabMixedSeq = table(1 = 1, 2 = 2, 3 = 3, 7 = 7, 9 = 9, 11 = 11, # 6
                          4 = "4", 5 = "5", 6 = "6", 8 = "8", 10 = "10", # 5
                          "s" = "s", "foo" = "bar") # 2


local I = 0
foreach(_:number, _:number = TabMixedNonSeq) {
    I = I + 1
}

assert(I == 6)

I = 0
foreach(_:number, _:string = TabMixedSeq) {
    I = I + 1
}

assert(I == 5)
```

--------------------------------

### Array:concat

Source: https://github.com/wiremod/wire/wiki/e2-docs-array

Concatenates values in the array starting from a specified index.

```APIDOC
## Array:concat

### Description
Concatenates all values in the array, starting at a provided index or range.

### Signature
- `String = Array:concat(Number Startindex)`
- `String = Array:concat(Number Startindex, Number Endindex)`
```

--------------------------------

### Table Iteration and Key-Value Access

Source: https://github.com/wiremod/wire/blob/master/data_static/expression2/tests/runtime/types/table.txt

Shows how to initialize a table with key-value pairs and iterate through them using a foreach loop.

```lua
local KV = table(
	"Foo" = 1,
	"Bar" = 2,
	"Baz" = 3,
	"Qux" = 4
)

local Looped = 0
foreach(K, V:number = KV) { # K should default to "string" on tables. (Dumb behavior I know.)
	Looped++
	assert(KV[K, number] == V)
}

assert(Looped == 4, Looped:toString())
```

--------------------------------

### Entity:getCollisionGroup / setCollisionGroup

Source: https://github.com/wiremod/wire/wiki/e2-docs-entity

Methods to get or set the collision group of an entity.

```APIDOC
## Number Entity:getCollisionGroup()
Returns the collision group of the entity.

## Entity:setCollisionGroup(Number Group)
Sets the collision group of the entity. Does not work on players. Use one of the _COLLISION_GROUP constants.
```

--------------------------------

### entity(Number Id)

Source: https://github.com/wiremod/wire/wiki/e2-docs-entity

Gets the entity associated with the specified numeric id.

```APIDOC
## entity(Number Id)

### Description
Gets the entity associated with the id.

### Parameters
- **Id** (Number) - Required - The numeric ID of the entity.
```

--------------------------------

### Initialize Interrupt System

Source: https://github.com/wiremod/wire/blob/master/data_static/cpuchip/examples/interrupts.txt

Sets up the interrupt table, configures the timer, and enters the main execution loop.

```ZASM
STEF // Set the EXTENDED FLAG on, this allows you to call interrupts without halting CPU
LIDTR my_interrupt_table // Load the interrupt table we have in memory
CPUSET 52,59 // Set number of interrupts in table (defaults to 256)
INT 33 // Call interrupt 33 to print to console screen.
// Note that you can also call external interrupts internally using EXTINT (number)
CPUSET 67,34 // Set timer interrupt(external interrupt #) to our timer interrupt
CPUSET 65,4  // Set delay on timer to 4 seconds.
CPUSET 64,1  // Set timer mode to seconds (it will read the 4 as 4 seconds, set to 2 to read as every 4 instructions)
// Timer will now be running from here on.

wait_forever:
INC R0
JMP wait_forever
// Use CLEF to disable the extended flag if you want to halt on error instead of handle
```

--------------------------------

### Initialize 3D Background Rendering

Source: https://github.com/wiremod/wire/blob/master/data_static/gpuchip/examples/mt3.txt

Sets up depth parameters, timing, and initial shading values before calling the background drawing routine.

```assembly
  dvxpipe 3;
  dcvxpipe 3;

  //Calc depth here
  mov #Background.MinDepth,  0.8; //Near distance
  mov #Background.MaxDepth,  6.0; //Far distance
  mov #Background.ShadeStart,1.0;
  mov #Background.DepthStep ,0.3; //Depth step. The lower, the higher quality is

  timer #Time; mul #Time,3;

  mov EAX,#Time; mod EAX,#Background.DepthStep;

  sub #Background.MinDepth,EAX;
  sub #Background.MaxDepth,EAX;

  //Initialize depth range
  mov  #Background.deltaDepth,#Background.MaxDepth;
  sub  #Background.deltaDepth,#Background.MinDepth;

  //Compute background stuff
  mov  #Background.ShadeStep,#Background.deltaDepth;
  div  #Background.ShadeStep,#Background.DepthStep;
  frnd #Background.ShadeStep;
  finv #Background.ShadeStep;
  mul  #Background.ShadeStep,#Background.ShadeStepMul;

  //Brightness too
  mov EAX,#Time; mod EAX,#Background.ShadeStep;
  sub #Background.ShadeStart,EAX;

  mov #_rect.color.r,200;
  mov #_rect.color.b,200;

// Uncomment this for trippy camera
//  timer EAX; div EAX,8; fsin EBX,EAX; mul EBX,2;
//  drotatescale EAX,EBX; mul EBX,2;

  dsetwidth 0.8;
  call Draw.Background;
dexit;

alloc Time;
```

--------------------------------

### Vector Rotation Calculation

Source: https://github.com/wiremod/wire/wiki/Quaternions-Guide-by-Fizyk

Example calculations for rotating a vector using quaternions.

```text
q = cos(45) + [1,0,0]*sin(45) = 0.707 + 0.707*i
1/q = 0.707 - 0.707*i
(0.707+0.707*i)(3i+5j-2k)(0.707-0.707*i) = (after many calculations) = 3i + 2j + 5k
```

--------------------------------

### systime()

Source: https://github.com/wiremod/wire/wiki/e2-docs-timer

Returns a highly accurate time since the server was started, ideal for benchmarking.

```APIDOC
## systime()

### Description
Returns a highly accurate time (also in seconds) since the server was started. Ideal for benchmarking.
```

--------------------------------

### Create an interactive EGP selection menu

Source: https://github.com/wiremod/wire/wiki/E2:-EGP

This script initializes an EGP screen with a list of selectable items and handles user clicks to update output values based on the selected entry.

```golo
@name Interactive Typelist
@inputs EGP:wirelink User:entity
@outputs Type:string Info:string
@persist List:table ListStart:vector2 BoxSize:vector2 ListSpacing CurrentlySelected
if ( (first() | ~EGP) & ->EGP ) { # Combining both ifs into one
  EGP:egpClear()

  # Now using a table with a table for each entry, containing name and info
  List = table(
    table("name"="Number"  , "info"="Just a plain number with decimals"),
    table("name"="String"  , "info"="Bit of text"),
    table("name"="Vector"  , "info"="3D Coordinates ie for a position"),
    table("name"="Entity"  , "info"="Describes objects, ie Props or Players"),
    table("name"="Wirelink", "info"="Used to interact with Wire objects, ie EGPs")
  )

  EGP:egpBox(1, vec2(256,25), vec2(380, 40))
  EGP:egpColor(1, vec(64,64,64))

  EGP:egpText(2, "Select a type to output info:", vec2(256, 25))
  EGP:egpSize(2, 40) 
  EGP:egpAlign(2, 1, 1)

  CurrentlySelected=0 # none

  # settings for our list, we use those later to detect clicks
  ListStart = vec2(256, 100) # position of the first box
  BoxSize = vec2(100,40) # size of each box
  ListSpacing = 80 # offset between center of two entries

  for (I=1, List:count()) { # loop over the list
    local CurrentEntryName = List[I, table]["name", string] # get the name from the entry data with our index
    local CurrentID = 8 + I*2 # the first Entry (I=1) will have index 10 for the box (and 11 for the text)
    local CurrentPos = ListStart + vec2(0, (I-1)*ListSpacing) # calculate vertical offset based on index-1 (so the first box is at the start pos
    
    EGP:egpBox(CurrentID, CurrentPos, BoxSize) # grey background
    EGP:egpColor(CurrentID, vec(127))
    
    EGP:egpText(CurrentID+1, CurrentEntryName, CurrentPos)
    EGP:egpSize(CurrentID+1, 28)
    EGP:egpAlign(CurrentID+1, 1, 1)
  }
}
elseif (~User & User) {
  local Cursor = EGP:egpCursor(User)
  # check if the position is roughly in the area occupied by the list
  if (inrange(Cursor, ListStart-BoxSize/2, # top left corner of first box
                     ListStart+vec2(0,ListSpacing*(List:count()-1))+BoxSize/2)) { # bottom right corner of the last box
    local VerticalPositionInListArea = Cursor:y()-ListStart:y()
    local ClosestListEntry = round(VerticalPositionInListArea/ListSpacing)+1 # just divide the vertical pos by the spacing to get which button we are closest to
    local RelativePosition = Cursor-(ListStart+vec2(0, (ClosestListEntry-1)*ListSpacing)) # get the position relative to the closest button
    
    if (inrange(RelativePosition, -BoxSize/2, BoxSize/2)) { # check if the cursor is inside that button
      # button was pressed, first update the outputs
      local CurrentEntry = List[ClosestListEntry, table] # add 1 since ClosestListEntry starts at 0, not 1
      Type = CurrentEntry["name", string]
      Info = CurrentEntry["info", string]
    
      if (CurrentlySelected!=0) { # if something was previously selected
        EGP:egpColor(8+CurrentlySelected*2, vec(127)) # reset color of that entry
      }
      EGP:egpColor(8+ClosestListEntry*2, vec(64,127,64)) # change color of now selected entry
      CurrentlySelected = ClosestListEntry
    }
  }
}
```

--------------------------------

### Define and execute a basic method

Source: https://github.com/wiremod/wire/blob/master/data_static/expression2/tests/runtime/base/userfunctions/methods.txt

Demonstrates defining a method on a number type and verifying its execution.

```expression2
Called = 0
function number:mymethod() {
	Called = 1
}

1:mymethod()

assert(Called)
```

--------------------------------

### Implement chat commands

Source: https://github.com/wiremod/wire/wiki/Expression-2-Events

Parses chat messages for commands starting with an exclamation mark.

```jsx
@persist Owner:entity
Owner = owner()

event chat(Player:entity, Message:string, _:number) {
    if (Player == Owner & Message[1] == "!") {
        const Rest = Message:sub(2)
        const Arguments = Rest:explode(" ")
        
        switch (Arguments[1, string]) {
            case "ping",
                print("pong!")
                break
            default,
                print("Unknown command: " + Arguments[1, string])
        }
    }
}
```

--------------------------------

### Full Chat Command Implementation

Source: https://github.com/wiremod/wire/wiki/E2-Guide:-Lambdas

The complete script combining initialization, command definitions, and the chat event handler.

```ruby
@strict
const Functions = table()
const Keyword = "/"

Functions["ping"] = function(_:array) {
    print("Pong!")
}

Functions["hurt"] = function(Args:array) {
    let Name = Args[1, string]
    let Player = findPlayerByName(Name)
    if(Player) {
        let Damage = Args[2, string]:toNumber()
        try {
            print("Trying to hurt")
            Player:takeDamage(Damage)
        } catch(_:string) {
            print("Damage is not allowed!")
        }
    } else {
        print(format("Couldn't find player %q", Name))
    }
}  

event chat(Player:entity, Message:string, _:number) {
    if(Message[1] == Keyword) {
        let Args = Message:sub(2):explode(" ") # Skip the first character ("/") and split the string into an array
        let Command = Args:shiftString():lower() # Removes and returns the first element, and shifts everything down to compensate
        if(Functions:exists(Command)) {
            print("Calling " + Command)
            Functions[Command, function](Args)
        } else {
            print("Unknown command: " + Command)
        }
    }
}
```

--------------------------------

### Queueing File Writes in E2

Source: https://github.com/wiremod/wire/wiki/E2-Guide:-File-Extension

Demonstrates how to programmatically write multiple files while checking queue capacity with fileCanWrite.

```ruby
@name File Queues
@persist List:array
@trigger none
@strict

for(I = 1, 10) {
    if(fileCanWrite()) {
        fileWrite(format("manyfiles/%d.txt", I), format("This is file #%d!", I))
    } else { break }
}
```

--------------------------------

### Vector2 Component Access and Modification

Source: https://github.com/wiremod/wire/wiki/e2-docs-vector2

Methods to get or set individual components of a 2D vector.

```APIDOC
## Component Access

- `x()`: Gets the X component.
- `y()`: Gets the Y component.
- `setX(Number X)`: Returns a copy with the X component replaced.
- `setY(Number Y)`: Returns a copy with the Y component replaced.
```

--------------------------------

### toString(Function Func)

Source: https://github.com/wiremod/wire/wiki/e2-docs-functions

Utility function to get the string representation of a provided Function object.

```APIDOC
## toString(Function Func)

### Description
Utility function to get the string representation of a provided Function object.

### Parameters
- **Func** (Function) - The function object to convert to a string.

### Returns
- **String** - The string representation of the function.
```

--------------------------------

### Render 3D Icosahedron

Source: https://github.com/wiremod/wire/blob/master/data_static/gpuchip/examples/3d_icosahedron.txt

Initializes the graphics pipeline, sets up camera and lighting, and renders the icosahedron model in both solid and wireframe modes.

```C-like
// Author: Drunkie
// Description: Draws a 3D icosahedron model (solid and wireframe)

Main();

#include <drivers\drv_gl.txt>

void Main()
{
    glSleep( 40 ); // Sleep for 40 milliseconds (Reduces fps lag)
    glClear( 0, 0, 0 ); // Clear screen

    glCoordPipe( GL_CPIPE_N1_1 ); // Set coordinate pipe to [-1 to 1] mode
    glVertexPipe( GL_VPIPE_XYZTRANSFORM ); // Set vertex pipe to xyz transformation

    glLightPos( 0, 0, -50 ); // Set the light position
    glLightColor( 255, 255, 255, 1 ); // Set the light color

    glLookAt(
        0, 0, -2.25, // Camera pos
        0, 0, 0, // Camera target
        0, 1, 0 // Camera up
    );

    // Create variable to hold curtime
    float time;
    timer time;

    // Create perspective and matrix transformations
    glPerspective( 30, 1, 1, 20 ); // FOV, ASPECT RATIO, ZNEAR, ZFAR
    glRotate( 1, 1, 0, time ); // AXIS X, Y, Z, ANGLE W
    glTranslate( 0, 0, 0 ); // TRANSLATION X, Y, Z
    glScale( 1, 1, 1, 0 ); // SCALE X, Y, Z

    glEnable( GL_VERTEX_BUFFER ); // Enable vertex buffer
    glEnable( GL_VERTEX_ZSORT ); // Enable Z sorting
    glEnable( GL_VERTEX_LIGHTING ); // Enable vertex lighting
    //glEnable( GL_VERTEX_CULLING ); // Enable face culling

    // Solid 3D polygon
    glFillMode( GL_FILL_SOLID ); // Set fillmode as solid
    glColor4( 100, 149, 237, 180 ); // Set the draw color with alpha
    glPoly3D( vertexBuffer, 20 ); // Draw 3D polygon
    glFlush(); // Flush the vertex buffer to the screen

    glDisable( GL_VERTEX_LIGHTING ); // Enable vertex lighting

    // Wireframe 3D polygon
    glLineWidth( 1 ); // Set line width of wireframe
    glFillMode( GL_FILL_WIREFRAME ); // Set fillmode as wireframe
    glColor4( 255, 255, 255, 255 ); // Set the draw color with alpha
    glPoly3D( vertexBuffer, 20 ); // Draw 3D polygon
    glFlush(); // Flush the vertex buffer to the screen

    glExit(); // Exit
}
```

```Data
vertexBuffer:
db 0,0,1; db 0,0.9,0.5; db 0.9,0.3,0.4;
db 0,0,1; db -0.9,0.3,0.4; db 0,0.9,0.5;
db 0,0,1; db -0.5,-0.7,0.4; db -0.9,0.3,0.4;
db 0,0,1; db 0.5,-0.7,0.4; db -0.5,-0.7,0.4;
db 0,0,1; db 0.9,0.3,0.4; db 0.5,-0.7,0.4;
db 0.9,-0.3,-0.4; db 0.9,0.3,0.4; db 0.5,0.7,-0.4;
db 0,0.9,0.5; db 0.5,0.7,-0.4; db 0.9,0.3,0.4;
db 0,0.9,0.5; db -0.5,0.7,-0.4; db 0.5,0.7,-0.4;
db 0,0.9,0.5; db -0.9,0.3,0.4; db -0.5,0.7,-0.4;
db -0.9,-0.3,-0.4; db -0.5,0.7,-0.4; db -0.9,0.3,0.4;
db -0.9,-0.3,-0.4; db -0.9,0.3,0.4; db -0.5,-0.7,0.4;
db -0.9,-0.3,-0.4; db -0.5,-0.7,0.4; db 0,-0.9,-0.5;
db 0.5,-0.7,0.4; db 0,-0.9,-0.5; db -0.5,-0.7,0.4;
db 0.5,-0.7,0.4; db 0.9,-0.3,-0.4; db 0,-0.9,-0.5;
db 0.5,-0.7,0.4; db 0.9,0.3,0.4; db 0.9,-0.3,-0.4;
db 0,0,-1; db 0,-0.9,-0.5; db 0.9,-0.3,-0.4;
db 0,0,-1; db 0.9,-0.3,-0.4; db 0.5,0.7,-0.4;
db 0,0,-1; db 0.5,0.7,-0.4 db -0.5,0.7,-0.4;
db 0,0,-1; db -0.5,0.7,-0.4; db -0.9,-0.3,-0.4;
db 0,0,-1; db -0.9,-0.3,-0.4; db 0,-0.9,-0.5;
```

--------------------------------

### Collision Tracking Management

Source: https://github.com/wiremod/wire/wiki/e2-docs-custom-prop

Functions to start, stop, and check the status of collision tracking for entities.

```APIDOC
## trackCollision(Entity Ent)
Starts tracking collisions for the entity. Fires event entityCollision when they occur. Returns 1 on success or 0 on error.

## trackCollision(Entity Ent, Function Cb)
Starts tracking collisions for the entity and calls the provided callback function. Callback signature: (entity, entity, collision).

## isTrackingCollision(Entity Ent)
Returns 1 if the entity's collisions are being tracked, 0 otherwise.

## stopTrackingCollision(Entity Ent)
Stops tracking collisions for the specified entity.
```

--------------------------------

### Use lambda functions

Source: https://github.com/wiremod/wire/wiki/Expression-2-Syntax

Syntax for creating and using first-class lambda functions.

```golo
let MyLambda = function(S:string) {
    print(S)
}

MyLambda("Hello, World!") # Prints "Hello, World!"
```

```golo
let Runs = 0
let GetRun = function() {
    Runs++
    return Runs
}

print(GetRun()[number])

print(GetRun()) # ERROR! GetRun is assumed to return void here
```

```golo
let Wrapper = function(Func:function) {
    return function() { # Create and return function literal
        print("Wrapped!")
        Func()
    }
}

let Wrapped = Wrapper(function() { # Create and pass a function literal
    print("Hello, World!")
})[function]

Wrapped() # Prints "Wrapped!" and "Hello, World!"
```

--------------------------------

### Initialize HUD Engine Display

Source: https://github.com/wiremod/wire/blob/master/data_static/gpuchip/examples/hud_engine.txt

Sets up the initial HUD environment, including circle quality and drawing the base gauge shapes.

```assembly
mov #65485,16; //set circle quality

dclrscr hud_border;

dcolor hud_text;
dcircle hud_engine1gauge,68;
dcircle hud_engine2gauge,68;
dcolor hud_border;
dcircle hud_engine1gauge,64;
dcircle hud_engine2gauge,64;

dcolor hud_text;
dsetwidth 1;
dline hud_engine1gauge_start,hud_engine1gauge;
dline hud_engine2gauge_start,hud_engine2gauge;

dsetwidth 2;
```

--------------------------------

### For Loop Syntax

Source: https://github.com/wiremod/wire/wiki/Expression-2-Syntax

Iterates a block of code based on a start, end, and optional step value.

```ruby
#This will call the code 5 times (1 - 5 inclusive). In this case, the third argument is redundant.
for (I = 1, 5, 1) {
    ...
}
```

--------------------------------

### Matrix Accessors and Mutators

Source: https://github.com/wiremod/wire/wiki/e2-docs-matrix

Methods to get or set specific rows, columns, or elements within a matrix.

```APIDOC
## Matrix:row(Number Rv2)
Returns the specified row as a vector.

## Matrix:column(Number Rv2)
Returns the specified column as a vector.

## Matrix:setRow(Number row, Number v1, Number v2, Number v3)
Sets the values of a row using individual numbers.

## Matrix:setRow(Number row, Vector v)
Sets the values of a row using a vector.

## Matrix:setColumn(Number col, Number v1, Number v2, Number v3)
Sets the values of a column using individual numbers.

## Matrix:setColumn(Number col, Vector v)
Sets the values of a column using a vector.

## Matrix:element(Number i, Number j)
Returns the element at indices (i,j).

## Matrix:setElement(Number i, Number j, Number value)
Sets an element's value at indices (i,j).

## Matrix:swapColumns(Number col1, Number col2)
Swaps the two specified columns.

## Matrix:swapElements(Number i1, Number j1, Number i2, Number j2)
Swaps two elements specified by indices.
```

--------------------------------

### Wiremod HUD Initialization and Rendering Loop

Source: https://github.com/wiremod/wire/blob/master/data_static/gpuchip/examples/verynice1.txt

Initializes display colors and rectangles, then iterates through 18 input ports to display their values on the HUD.

```Wiremod
dcolor c1;
drect p1,p2;
dcolor c2;
drect p3,p4;
dcolor c3;
drect p5,p6;

mov #textpos1.y,80;

dcolor c4;
dsetsize 12;
dwrite textpos1,text1;

mov ecx,0;
port_loop:
  add #textpos1.y,18;
  mov #textpos2.y,#textpos1.y;

  mov #textpos2.x,#textpos1.x;
  add #textpos2.x,90;
  dwrite textpos1,text2;
  dwritei textpos2,ecx;

  in eax,ecx;

  mov #textpos2.x,#textpos1.x;
  add #textpos2.x,192;
  dwritef textpos2,eax;

  inc ecx;
  cmp ecx,18;
  jl port_loop;

dexit;

string text1,'VERYNICE HUD SYSTEM INITIALIZED... VER 1.0';
string text2,'INPUT PORT        VALUE';

vec2f textpos1,80,80;
vec2f textpos2,80,80;

color c1,0,0,255;
color c2,0,0,127;
color c3,0,0,64;
color c4,255,255,255;

vec2f p1,50,50;
vec2f p2,450,450;

vec2f p3,60,60;
vec2f p4,430,430;

vec2f p5,70,70;
vec2f p6,440,440;
```

--------------------------------

### WireLink:readArray(Number Start, Number Size)

Source: https://github.com/wiremod/wire/wiki/e2-docs-wirelink

Reads an array's elements from a piece of memory.

```APIDOC
## WireLink:readArray(Number Start, Number Size)

### Description
Reads an array's elements from a piece of memory. Strings and sub-tables are written as pointers to the actual data.

### Parameters
- **Start** (Number) - The starting memory address.
- **Size** (Number) - The number of elements to read.
```
Tokens:
Raw