Revision as of 16:37, 16 May 2023 by Baertram (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Elder Scrolls Online allows us players to extend and even modify the default user interface via add-ons. ESOUI is a community dedicated to provide not only a large collection of add-ons created by many of our talented members, but also guides, tutorials and API information to help you create your own add-ons.

Overview

• ESOUI WIKI: categories

• API documentation
• ESOUI API Function - The lua file/function source code parsing reference that was split from the main API documentation page.
• API functions by category - Only contains the functions that wiki users have documented.
• Arguments, Returns and Data - Only contains information wiki users have documented.

API Versions

• Current Live: 101037
• Current PTS: 101038
• API version history

Source

• github
• ESOUI.com

Code

• Functions - What your add-on can do (same page as API documentation listed above)
• Events - What can trigger your functions
• Filter for Events - What can filter your functions
• Global constants & their values

String and Text Handling

• zo_strformat & ZO_CachedStrFormat for formatting localized text, player and NPC names, numbers, etc.
• In-game Text Formatting - color, padding, textures/icons, etc, in chat and labels.
• Creating and Understanding Links and Custom links
• Currency_Formatting Use ESO's built-in currency formatting

Localization/i18n/supported languages

• Available Strings, languages, how to add your own + localization

GUI

• UI XML - The UI layout language
• Fonts - The game's UI fonts
• Controls - Provide UI interactivity
  • Anchors & Offsets - Positioning and anchoring controls to each other
• Backdrops - Backdrops for windows (see also Virtuals windowtemplates.xml)
• Virtuals - Used as for templates & inheritance
• Keybindings - List of keybinding names in the vanilla UI
• Example.xml - a working xml file that you can use as template

Data

• UESP Data search UESP - ESO: Record Types
• Texture List - full and a list of Textures Textures useful for GUI building
• Sounds - how to play a sound, and an overview of the constants
• Maps - overview of maps
• Zones - overview of zones (ids and indices)
• Campaigns - PVP campaigns
• Keeps - keep IDs in Cyrodiil
• Collectibles - datamined collectible IDs and names
• Houses - a list of house ids
• Quests - a list of quest ids
• Wayshrines - a list of the wayshrines

Getting Started

• Lua GOTCHAs
• Creating addons - Links, IDE, AutoCompletion, Best practice & other info
• AddOn Quick Questions
• Everything is a table?? A brief introduction of how LUA does things
• What variables and functions do exist?
• Write/read to/from disk (SavedVariables), and including other files
• Variable types and how to check them
• Code Libraries - Reuseable code to make things easier

Packaging

• Add-on structure - Information about how to put together an add-on
• Add-on manifest (.txt) format - The way ESO interprets add-on metadata
• Libraries/Dependencies - Re-usable code / API functions etc. for your addons

Tutorials

• Video Tutorials
• Writing your first add-on
• MyFirstAddon tutorial by Zenimax Online
• sirinsidiator's Simple Notebook Tutorial
• Circonian's Tutorials: Stamina Bar - Saved Variables - Menu Settings
• Click Counter Lua Tutorial

HowTo

General addon related

• This will get your AddOn removed/What is your addon not supposed to do
• Add localization/multi language support
• Working with strings in ESO lua (zo_strformat)

Slash commands

• Add a slash command

Keybindings

• Add a button to the keybind strip

ItemLinks

• Create custom clickable links

ESO vanilla code

• Trigger things with ESO vanilla code
• Use Event handlers on controls (e.g. react on a mouse click)

Delayed/Sync/Async calls

• Run code before/after existing functions (PreHook/PostHook)
• Running LUA-Code asynchronously/delayed

UI elements, controls

• UI element X, e.g. parent, anchor, ScrollLists, Context menu
• Hide/Show controls as menu opens/closes
• Open a menu/Change UI mode (like via keybinds)
• Edit box, only numeric input
• Create/add to inventory context menu
• Create a text tooltip at controls
• Add info to game tooltips
• Need many controls? Reuse the controls of a "pool" (ZO_ObjectPool)
• How to animate textures

Scenes & Fragments

• Scene Manager: On scene change
• Fragments in a scene: On fragment state change (e.g. Hide control as menu opens)

Units

• Units and unitTags

Events

• Annotated collections of events
• Event & Update buffering

Skills

• Determine and get class skill lines

AvA/PvP

• PvP Zone Detection

Collectibles

• Get a table of owned mounts [id]=name (via ZO_COLLECTIBLE_DATA_MANAGER)
• Check if collectible is known

Assistants/Companions

• Hide your assistant

Ingame settings

• Change ingame settings

Other

• Show the announcements

Templates

Complete addons

• Collection of AddOn template with predefined structures/code

Bank

• Move backpack items to bank, based on criteria

Provisioner

• Select a recipe in recipe list

Libraries
LibAddonMenu-2.0

• React on panel controls been created
• How to detect panel Show/Hide & LibFeedback integration
• Change LAM controls/data
• Update dropdown box entries

LibFilters-3.0

• LibFilters3: Filter items / React on shown&hidden state of inventories - Examples

• Utility functions
• IDE/AutoCompletion for ESOUI addons
• AddOns helping addon creation

• Lua language reference (not ESO specific)
• ESO UI Source Code @GitHub / ESO UI Source Code @UESP
• Chat for add-on authors
• ESOUI.com: Downloads / Forums / Add-on Libraries / Tutorials
• Add-on Terms
• ESO mined data database (items, skills, NPCs, etc.)

• FAQ
• Mon Premier Addon
• Premiers Pas

Contributeur et Moddeur Français, n'hésitez pas à participer !

• Fonctions

J'ai repris simplement la liste des fonctions déjà créé dans la VO, afin de pouvoir ensuite créer une nouvelle page à chaque fonction mais cette fois ci en Français ! TODO liste FR ( Pour les contributeurs qui ne saurait quoi faire ) :

• Traduire en général ce qui a déjà était fait par nos amis Anglophones
• Traduire la FAQ
• Créer les Pages FR des fonctions listé ici : Liste FR des Fonctions

Всем привет, здесь русская часть сообщества постарается публиковать переводы и материалы по аддонам к Elder Scrolls Online. Перед любыми действиями, в особенности перед созданием страниц, прочтите соглашение об именовании. Будем рады помощи! Пока все переводится skv1991...

Код:

• Функции - Что может делать ваш аддон
• События - Что может запускать ваши функции
• Глобальные константы и их значения

GUI (графический интерфейс):

• UI XML - Язык разметки шаблонов интерфейса
• Controls - Добавляет в UI интерактивность

Упаковка:

• Формат объявлений (.txt) в аддоне - Как ESO находит ваш аддон

• FAQ по аддонам
• Учебник "Мой первый аддон"
• Как добавить слеш-команду

• Lua. Справка по языку (не относится к ESO)
• ESOUI.com: Загрузки / Форумы / Библиотеки для аддонов