wiremod/wire
1
0
Fork 0
mirror of https://github.com/wiremod/wire.git synced 2025-03-04 03:03:04 -05:00
Code Issues Packages Projects Releases Wiki Activity
Page: E2: Learning and getting help
Pages
Creating an E2 Core Developer Style Guide Developer: E2 Checklist E2 Guide: EGP Basics E2 Guide: File Extension E2 Guide: Lambda Timers E2 Guide: Lambdas E2 Guide: Ops E2: Chat Commands E2: EGP Objects E2: EGP E2: Find Functions E2: Learning and getting help E2: Physics E2: Tips and Tricks E2: Triggers Expression 2 Core Expression 2 Directives Expression 2 Editor Expression 2 Events Expression 2 Self Aware Expression 2 Syntax Expression 2 Gates Angle Gates Arithmetic Gates Array Gates Bitwise Gates Comparison Gates Entity Gates Logic Gates Memory Home Legacy Guides & Expression 2 Tooling Misc: Wiki Contribution Guide Prop core Quaternions Guide by Fizyk Tool: Cam Controller Tool: Freezer Tool: Gates Tool: Prop Spawner Tool: Turret Tool: User Tool: Wiring Tool: ZCPU Tool: ZGPU Tools Wire Map Interface Wiremod Folder Structure e2 docs angle e2 docs array e2 docs bitwise e2 docs bone e2 docs chat e2 docs color e2 docs compat e2 docs complex e2 docs console e2 docs constraint e2 docs core e2 docs custom camera e2 docs custom constraintcore e2 docs custom effects e2 docs custom ftrace e2 docs custom holoanim e2 docs custom light e2 docs custom prop e2 docs custom remoteupload e2 docs custom stcontrol e2 docs custom tracesystem e2 docs custom wiring e2 docs datasignal e2 docs debug e2 docs egpfunctions e2 docs entity e2 docs files e2 docs find e2 docs globalvars e2 docs hologram e2 docs http e2 docs matrix e2 docs npc e2 docs number e2 docs player e2 docs quaternion e2 docs ranger e2 docs selfaware e2 docs serialization e2 docs serverinfo e2 docs signal e2 docs sound e2 docs string e2 docs table e2 docs timer e2 docs toc e2 docs unitconv e2 docs vector e2 docs vector2 e2 docs weapon e2 docs wirelink
0 E2: Learning and getting help
Denneisk edited this page 2023-11-17 18:32:41 +00:00
Table of Contents

Table of Contents

E2Helper

The E2Helper is a quite powerful tool to find functions. Unlike the Wiki it automatically contains every function, and is synced with the server, so you can also see any extensions the server has installed (and only those, if a extension is disabled, the functions will not show up).

You can open the E2Helper by clicking the button near the top right corner of the E2 Editor

Interface

The top bar is for searching. In the left box you can search for functions by name, the other are for searching by parameter and return value respectively. All boxes can be used at the same time.

In the center you see function name, their "signature" (parameters and return value) as well as ops cost.
Note: certain functions have a variable ops cost based on input size (usually those dealing with tables, arrays, strings), so do not overly rely on these numbers and rather use them as a rough value.

The bottom fields show how to use the currently selected function and usually contain a short descriptions

Searching by Parameters

If you are learning E2 you might ask yourself "How do i get the size of a array" or similar questions.
In this cases the parameter and return search boxes are exceptionally useful.

Just plug in what you think the function needs. Here we have an array (short type r) as input, and want a number (short type n) as result.
Don't be discouraged if you get many results, just scroll through the list and see if something fits your needs. You might even encounter some useful functions to keep in for later.

In our example we quickly see count, which is used as Size = Array:count().

Note: When searching for multiple inputs, try different orders and : placement.

Wiremod Wiki

Main article: Guides & Tooling: Wiki Guides

In addition to the dump of availiable functions (see the footer), this wiki contains quite a few Example, Tutorials and Info pages. Maybe someday there will be a nice Overview page...

Tutorials

There are many tutorials out there, but most aren't very good.
You will not learn much from copy-pasting code or typing what you see in YouTube video straight into the editor.

You probably know best how you like to learn, but here are a few general tips:

  • Try to understand what exactly the code is doing, section by section, line by line
  • Format your code correctly, especially use consistent indentation This lets you keep track of sections of code easier, such as what part is repeated.
    This not only helps you if you look back at old code, but also others, such as when asking for help.
    The E2 Editor will automatically try to indent by itself, but sometimes gets a bit confused.
  • Layout your code: You want to order and space code in a way that makes sense. You might want to throw in a empty line between certains sections here and there. I also recommend laying out your code as a elseif-chain as shown in E2: Triggers
  • Don't be afraid to ask questions. If you cannot find someone on your server to help you, stop by #help on the discord.

Asking for Help

If you want quick and useful help, try and explain your problem and context in a brief but easily understandable way.
Also explain what your current ideas are and what you tried, people are far more happy to help if they see you already put some effort into solving it yourself, instead of spoonfeeding you every single thing.

Bad Examples

  • "How to make a shield with E2? Help me plz"
  • "Why is my E2 not working? <full e2 code, unformatted>"
  • "How to find a string in an array?"

Good Examples

  • "I am trying to make a shield, and want it to stay between me and someone, and a certain distance from me, how can i calculate the position?"
  • "I have trouble with <line of code> inside my E2, it skips a turn every so often"
  • "How to find a string in an array? I am trying to check if a player name is on a list"

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 🔭

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