Skip to content

e2 docs egpobjects

Jump to bottom Edit New page
DerelictDrone edited this page May 28, 2025 · 1 revision

Jump to table of contents

Egpobjects

Egpobject = Egpobject:modify(Table Arguments)

Modifies an object with the provided arguments. (10 ops)

Egpobject:setOrder(Number Order)

Sets the order at which the object will be rendered. This is different from index (15 ops)

Number = Egpobject:getOrder()

Returns the order at which the object is rendered (15 ops)

Egpobject:setOrderAbove(Egpobject Abovethis)

Makes the object render above the object (15 ops)

Egpobject:setOrderBelow(Egpobject Belowthis)

Makes the object render below the object (15 ops)

Egpobject:setText(String Text)

Changes the text of the text object (7 ops)

Egpobject:setText(String Text, String Font, Number Size)

Changes the text, font, and text size of the text object (7 ops)

Egpobject:setAlign(Number Halign)

Changes the horizontal alignment. Works on: text and text layout. Number can be 0, 1 or 2 (7 ops)

Egpobject:setAlign(Number Halign, Number Valign)

Changes the horizontal and vertical alignment. Works on: text and text layout. Numbers can be 0, 1 or 2 (7 ops)

Egpobject:setFiltering(Number Filtering)

Changes the texture filter used to draw the object. Works on objects that draw a material. See _TEXFILTER constants (POINT=sharp, ANISOTROPIC=blurry/default) (7 ops)

Egpobject:setFont(String Font)

Changes the font of the text object (7 ops)

Egpobject:setFont(String Font, Number Size)

Changes the font and size of the text object (7 ops)

Egpobject:setPos(Vector Pos)

Changes the world position of the 3D tracker object (10 ops)

Egpobject:setSize(Vector2 Size)

Changes the width and height of an object (7 ops)

Egpobject:setSize(Number Width, Number Height)

Changes the width and height of an object (7 ops)

Egpobject:setSize(Number Size)

Changes the size of the text/line/outline object (7 ops)

Egpobject:setPos(Vector2 Pos)

Changes the position of the object (7 ops)

Egpobject:setPos(Number X, Number Y)

Changes the position of the object (7 ops)

Egpobject:setPos(Number X, Number Y, Number X2, Number Y2)

Changes the position of the start and end of a line object, otherwise acts normally. (7 ops)

Egpobject:setAngle(Number Angle)

Changes the angle of the object (7 ops)

Egpobject:setPos(Number X, Number Y, Number Angle)

Changes the position and angle of the object (7 ops)

Egpobject:rotateAroundAxis(Vector2 Worldpos, Vector2 Axispos, Number Angle)

Rotates the object around the first vec2 with the second vec2 as offset at angle N (7 ops)

Egpobject:setVertices(Array Verts)

(7 ops)

Egpobject:setVertices(...)

(7 ops)

Egpobject:setColor(Vector4 Color)

Changes the color and alpha of the object (7 ops)

Egpobject:setColor(Vector Color)

Changes the color of the object (7 ops)

Egpobject:setColor(Number R, Number G, Number B, Number A)

Changes the color and alpha of the object (7 ops)

Egpobject:setAlpha(Number A)

Changes the alpha (transparency) of an object (7 ops)

Egpobject:setMaterial(String Material)

Changes the material of the object (7 ops)

Egpobject:setMaterialFromScreen(Entity Gpu)

Sets the material of the object to a current snapshot of the target screen. Note that this only works for players which see both the egp as well the target screen at that time (7 ops)

Egpobject:setFidelity(Number Fidelity)

Changes the fidelity of the object (the number of vertices the circle will use) (7 ops)

Number = Egpobject:getFidelity()

Returns the fidelity of the object (7 ops)

Egpobject:parentTo(Egpobject Parent)

Parents the object to another object. Parented objects' positions are local to their parent (7 ops)

Egpobject:parentTo(Number Parentindex)

Parents the object to another object. Parented objects' positions are local to their parent (7 ops)

WireLink:egpParent(Egpobject Child, Egpobject Parent)

Parents the object to another object. Parented objects' positions are local to their parent (7 ops)

Egpobject:trackerParent(Entity Parent)

Parents the 3D tracker object to an entity (7 ops)

Entity = Egpobject:trackerParent()

Returns the parent entity of the 3D tracker object. (7 ops)

Egpobject:parentToCursor()

Parents the object to player's cursor (7 ops)

Egpobject:unparent()

Un-parents the object (7 ops)

Number = Egpobject:parentIndex()

Returns the index of the parent object (7 ops)

Egpobject = Egpobject:parent()

Returns the parent object (7 ops)

WireLink:egpRemove(Egpobject Obj)

(7 ops)

Egpobject:remove()

Removes the object from the screen (7 ops)

Egpobject:draw()

Shows a hidden EGP object. (7 ops)

Egpobject:hide()

Removes an object from the screen but keeps its data intact. (7 ops)

Number = Egpobject:isVisible()

Returns 1 if the object is visible. (7 ops)

Vector = Egpobject:globalPos()

Returns the "global" (= it takes the parents' positions into consideration) position as a 3D vector. X and Y being the 2D X,Y coordinates, while Z is the angle (20 ops)

Array = Egpobject:globalVertices()

Returns an array of 2D vectors with the "global" positions of the vertices in the object (20 ops)

Number = WireLink:egpHasObject(Egpobject Object)

Returns 1 if the object exists on the screen, 0 if not (20 ops)

Vector2 = Egpobject:getPos()

Returns the position of the object (3 ops)

Vector = Egpobject:getPosAng()

Returns the position (x, y) and angle (z) of the object (3 ops)

Vector2 = Egpobject:getSize()

Returns the size of the object (3 ops)

Number = Egpobject:getSizeNum()

Returns the size of the text/line/outline object (3 ops)

Vector4 = Egpobject:getColor4()

Returns the color of the object as a vector4 (3 ops)

Vector = Egpobject:getColor()

Returns the color of the object as a vector (3 ops)

Number = Egpobject:getAlpha()

Returns the alpha of the object (3 ops)

Number = Egpobject:getAngle()

Returns the angle of the object (3 ops)

String = Egpobject:getMaterial()

Returns the material of the object. Note this does not return anything when using a GPU material (3 ops)

Number = Egpobject:getRadius()

Returns the radius of the object (3 ops)

Array = Egpobject:getVertices()

Returns an array of the vertices of the object (10 ops)

String = Egpobject:getObjectType()

Returns the type of the object (4 ops)

Egpobject = WireLink:egpCopy(Number Index, Egpobject From)

(15 ops)

Egpobject:copyFrom(Egpobject From)

Copies the settings of the second object into the first. If the first object does not exist, it's created (15 ops)

Number = Egpobject:containsPoint(Vector2 Point)

Returns 1 if the object contains the specified point (10 ops)

Egpobject = WireLink:egpobject(Number Index)

Returns the EGPObject at the index (5 ops)

Egpobject = noegpobject()

(1 ops)

String = toString(Egpobject Egpo)

Returns a string representation of the EGPObject (1 ops)

String = Egpobject:toString()

Returns a string representation of the EGPObject (1 ops)

Egpobject = WireLink:egpTextLayout(Number Index, Table Args)

(10 ops)

Egpobject = WireLink:egpLineStrip(Number Index, Table Args)

(10 ops)

Egpobject = WireLink:egpCircleOutline(Number Index, Table Args)

(10 ops)

Egpobject = WireLink:egpLine(Number Index, Table Args)

(10 ops)

Egpobject = WireLink:egpBox(Number Index, Table Args)

(10 ops)

Egpobject = WireLink:egpBoxOutline(Number Index, Table Args)

(10 ops)

Egpobject = WireLink:egp3DTracker(Number Index, Table Args)

(10 ops)

Egpobject = WireLink:egpCircle(Number Index, Table Args)

(10 ops)

Egpobject = WireLink:egpRoundedBoxOutline(Number Index, Table Args)

(10 ops)

Egpobject = WireLink:egpPoly(Number Index, Table Args)

(10 ops)

Egpobject = WireLink:egpPolyOutline(Number Index, Table Args)

(10 ops)

Egpobject = WireLink:egpRoundedBox(Number Index, Table Args)

(10 ops)

Egpobject = WireLink:egpWedgeOutline(Number Index, Table Args)

(10 ops)

Egpobject = WireLink:egpWedge(Number Index, Table Args)

(10 ops)

Egpobject = WireLink:egpText(Number Index, Table Args)

(10 ops)

Please do not alter the e2 docs ... pages manually.
They are autogenerated from the E2Helper. In the future, this will hopefully be its own dedicated website or tool.

Default Extensions

Basic Features: core, debug, number, selfaware, string, timer
🌎 World: angle, color, find, ranger, sound,
🔣 Math: bitwise, complex, matrix, quaternion, vector, vector2/4
📦 Entities: bone, constraint, egp, entity, hologram, npc
👨 Players: chat, console, player, weapon
📊 Data storage: array, files, globalvars, serialization, table
💬 Communication: datasignal, http, signal, wirelink,
❓ Informational: gametick, serverinfo, steamidconv, unitconv

Additional Extensions

Disabled by default: constraintcore, effects, propcore, remoteupload, wiring
Wire-Extras (repo): camera, ftrace, holoanim, light, stcontrol, tracesystem

Developer resources

Expression 2 ⚙️

Getting Started 🕊

Guides (In learning order) 🎓

Tools 🛠️

Click To Expand

Advanced

Beacon 💡

Control 🎛️

Data 💿

Detection 👀

Display 💻

Render 🖌

I/O 🔌

Physics 🚀

Utilities 🛠️

RFID 💳

Wireless 🛜

Gates 🚥

Click To Expand

TBD

Extras 🔭

Clone this wiki locally