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: Developer Style Guide
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
3 Developer Style Guide
Vurv edited this page 2023-10-04 13:51:00 -07:00
Table of Contents

In general, just fix any lints that appear from glualint in your PR.

✍️ Formatting

🔤 Casing

  • Constants should be in SCREAMING_SNAKE_CASE
  • Locals should be in camelCase or preferably snake_case
  • Globals should be in PascalCase
  • Files should be in snake_case.lua

⚪ Whitespace

  • Use tabs, not spaces
  • Add space after commas, around operators and inside { curly braces } but not (parentheses) or [square brackets]
  • Files should end with a newline

⚠️ Banned Features

  • DO NOT use Garry's C-style operators (!, continue, &&, ||), they're not native to Lua and break most editors.

👨‍💻 Behavior

Code that goes into wire proper cannot favor specific addons not managed by the @wiremod organization.

Adding hooks/callbacks/interfaces to support external addons is fine.

wire-extras is exempt from this.

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