Main Page
From ESOUI Wiki
ESOUI Add-on Wiki
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.
/
English
API Documentation (Unofficial)
Overview Tuk Tuk
- 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: 101034
- Current PTS: 101035
- API version history
Source
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
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
How-Tos, guides, code templates
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
- 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
Keybindings
ItemLinks
ESO vanilla code
Delayed/Sync/Async calls
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
- 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
Events
- Annotated collections of events
- Event & Update buffering
Skills
AvA/PvP
Collectibles
- Get a table of owned mounts [id]=name (via ZO_COLLECTIBLE_DATA_MANAGER)
- Check if collectible is known
Assistants/Companions
Ingame settings
Other
Templates
Complete addons
Bank
Provisioner
Libraries
LibAddonMenu-2.0
Utilities (AddOns, IDE, Functions)
Links
ESOUI Add-on Wiki
Elder Scrolls Online permet aux joueurs d'ajouter voire même de modifier l'interface originale du jeu au travers de modules complémentaires nommés add-ons. ESOUI est une communauté qui a pour but, d'une part, de fournir une large collection d'add-ons crées par nos talentueux membres, mais aussi, des tutoriels, des guides et des informations sur l'API afin de vous permettre de créer vos propres add-ons.
French (En Français)
Tutoriels, Guides et Templates de code
Structure
- Structure des add-ons - Pour comprendre comment structurer vos addons.
Traductions des Fonctions de l'API
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
Guides Français
Contributeur et Moddeur Français, n'hésitez pas à participer !
Russian (На Русском)
Документация по API (Не официальная)
Всем привет, здесь русская часть сообщества постарается публиковать переводы и материалы по аддонам к Elder Scrolls Online. Перед любыми действиями, в особенности перед созданием страниц, прочтите соглашение об именовании. Будем рады помощи! Пока все переводится skv1991...
Код:
- Функции - Что может делать ваш аддон
- События - Что может запускать ваши функции
- Глобальные константы и их значения
GUI (графический интерфейс):
Упаковка:
- Формат объявлений (.txt) в аддоне - Как ESO находит ваш аддон
Ссылки
- Lua. Справка по языку (не относится к ESO)
- ESOUI.com: Загрузки / Форумы / Библиотеки для аддонов