Documentation for T-Engine 4 - version 1.4.0
View the Manual | T-Engine Git Repository
Scripts
| engine.colors | Implements string->Color functionality, and allows the definition of colors Defines numerous colors by default |
| init.lua | |
| engine.resolvers | |
| engine.utils | Utility functionality used by a lot of the base classes |
| engine.version | In the format {1,4,0,"te4",17} Where values are {major, minor, patch, enginename, ccore} |
Classes
| engine.Actor | Base Actor class used by NPCs, Players, Enemies, etc |
| engine.ActorsSeenDisplay | A display of the actors currently seen by the specified actor |
| engine.Astar | Pathfinding using A* |
| engine.Autolevel | Handles autoleveling schemes Used mainly for NPCS, although it could also be used for player allies or players themselves for lazy players/modules |
| engine.BSP | Abstract binary space partitioning Can be used to generator levels and so on |
| engine.Birther | Allows you to create characters using a GUI |
| engine.Module | Handles dialog windows |
| engine.Calendar | Defines calendars for factions |
| engine.CharacterBallSave | Handles a local characters charball saves |
| engine.CharacterVaultSave | Handles a local characters vault saves |
| engine.Chat | Handle chats between the player and NPCs |
| engine.DamageType | Defines damage types used by actors |
| engine.DebugConsole | Debug Console |
| engine.Dialog | Handles dialog windows |
| engine.DirectPath | Computes a direct line path from start to end |
| engine.Emote | Emotes for actors |
| engine.Entity | An entity is anything that goes on a map, terrain features, objects, monsters, player, ... |
| engine.Faction | Factions for actors Defines 2 factions by default: "Players", "Enemies" |
| engine.FlyingText | Flying Text |
| engine.FontPackage | Define and load fonts |
| engine.Game | Represents a game A module should subclass it and initialize anything it needs to play inside |
| engine.GameEnergyBased | A game type that gives each entities energy When an entity reaches an energy level it is allowed to act (it calls the entity"s "act" method) |
| engine.GameTurnBased | Defines a turn based game. |
| engine.Generator | Genric generator |
| engine.Grid | Grid |
| engine.Heightmap | Heightmap fractal generator This can be used to create rooms, levels, world maps, whatever |
| engine.HighScores | Define high score table support This will eventually actually generate a GUI table and handle filtering etc but for now it just generates a text string which represents the list of high scores. |
| engine.HotkeysDisplay | Hotkeys Display |
| engine.HotkeysIconsDisplay | Display of hotkeys with icons |
| engine.Key | Basic keypress handler The engine calls receiveKey when a key is pressed |
| engine.KeyBind | Handles key binds to "virtual" actions |
| engine.KeyCommand | Receives keypresses and acts upon them |
| engine.Level | Define a level |
| engine.LogDisplay | Module that handles message history in a mouse wheel scrollable zone |
| engine.LogFlasher | Module that handles a single message line, with pausing and flashing |
| engine.Map | Represents a level map, handles display and various low level map work |
| engine.MapEffect | Describes a trap |
| engine.Mouse | Basic mousepress handler The engine calls receiveMouse when a mouse is clicked |
| engine.NameGenerator | Creates a random name generator with a set of rules |
| engine.NameGenerator2 | Alternate Name Generator |
| engine.Object | Object |
| engine.Particles | Handles a particles system Used by engine.Map |
| engine.PlayerProfile | Handles the player profile, possibly online |
| engine.Projectile | Projectile |
| engine.Quadratic | Handles a 3D "quadratic" object It's mostly undeed, it simply allows quadratic to be serialized |
| engine.Quest | Handle quests |
| engine.Savefile | Savefile code
T-Engine4 savefiles are direct serialization of in game objects
Basically the engine is told to save your Game instance and then it will recursively save all that it contains: level, map, entities, your own objects, ... |
| engine.SavefilePipe | Savefile code
Creates a savefile pipe, savefiles requests can be pushed into it, it will execute them
in order and, as much as possible, as a background process, thus not preventing the game from running. There can only be one pipe! DO NOT TRY TO MAKE MORE |
| engine.Shader | Handles a particles system Used by engine.Map |
| engine.Store | Store |
| engine.Target | handles targetting |
| engine.Tiles | Handles tiles Used by engine.Map to reduce processing needed. |
| engine.Tooltip | A generic tooltip |
| engine.Trap | Describes a trap |
| engine.UserChat | Module that handles multiplayer chats |
| engine.World | Represents a game world, that is persistent across characters |
| engine.Zone | Defines a zone: a set of levels, with depth, npcs, objects, level generator, ... |
| engine.ai.simple | Defines a simple AI building blocks Target nearest and move/attack it |
| engine.ai.special_movements | Defines some special movement AIs |
| engine.ai.talented | Defines AIs that can use talents, either smartly or "dumbly" |
| engine.class | Base class used by pretty much everything |
| engine.dialogs.Achievement | A sub dialog for defining an achievement |
| engine.dialogs.AudioOptions | Shows audio options |
| engine.dialogs.Chat | Controls chat between players and npcs |
| engine.dialogs.ChatChannels | Player to player chat |
| engine.dialogs.ChatFilter | Chat filters |
| engine.dialogs.ChatIgnores | Chat Ignores |
| engine.dialogs.DisplayResolution | Controls what resoultion the window is set to |
| engine.dialogs.Downloader | A web browser |
| engine.dialogs.GameMenu | Main game menu |
| engine.dialogs.GetQuantity | Generic popup for getting quantity |
| engine.dialogs.GetText | Generic popup for getting text |
| engine.dialogs.KeyBinder | Bind your keys! |
| engine.dialogs.ShowAchievements | Dialog for showing achievements |
| engine.dialogs.ShowEquipInven | Show Equip Iventory |
| engine.dialogs.ShowEquipment | Show Equipment |
| engine.dialogs.ShowErrorStack | Show Error Stack |
| engine.dialogs.ShowInventory | Show Inventory |
| engine.dialogs.ShowLog | Show Log |
| engine.dialogs.ShowPickupFloor | ShowPickupFloor |
| engine.dialogs.ShowQuests | Show Quests |
| engine.dialogs.ShowStore | Show Store |
| engine.dialogs.ShowText | Show Text |
| engine.dialogs.SteamOptions | Steam Options |
| engine.dialogs.Talkbox | player to player chatbox |
| engine.dialogs.UseTalents | Use Talents |
| engine.dialogs.UserInfo | User Info for player to player chatbox |
| engine.dialogs.VideoOptions | Video Options |
| engine.dialogs.ViewHighScores | View Highscores |
| engine.generator.actor.OnSpots | |
| engine.generator.actor.Random | |
| engine.generator.map.Building | |
| engine.generator.map.Cavern | |
| engine.generator.map.CavernousTunnel | |
| engine.generator.map.Empty | |
| engine.generator.map.Filled | |
| engine.generator.map.Forest | |
| engine.generator.map.GOL | |
| engine.generator.map.Heightmap | |
| engine.generator.map.Hexacle | |
| engine.generator.map.Maze | |
| engine.generator.map.Octopus | |
| engine.generator.map.Roomer | |
| engine.generator.map.Rooms | Generator that makes a map |
| engine.generator.map.RoomsLoader | Generator interface that can use rooms |
| engine.generator.map.Static | |
| engine.generator.map.TileSet | |
| engine.generator.map.Town | |
| engine.generator.object.OnSpots | |
| engine.generator.object.Random | |
| engine.generator.trap.Random | |
| engine.generator.interface.ActorAI | Handles actors artificial intelligence (or dumbness ... |
| engine.generator.interface.ActorFOV | Handles actors field of view
When an actor moves it computes a field of view and stores it in self.fov When an other actor moves it can update the fov of seen actors |
| engine.generator.interface.ActorInventory | Handles actors stats |
| engine.generator.interface.ActorLevel | Interface to add leveling capabilities to actors Defines the exp property, which is the current experience, level which is the current level and exp_worth which is a multiplier to the monster level default exp |
| engine.generator.interface.ActorLife | Handles actors life and death |
| engine.generator.interface.ActorProject | Handles actors projecting damage to zones/targets |
| engine.generator.interface.ActorQuest | Handles actors quests |
| engine.generator.interface.ActorResource | Handles actors life and death |
| engine.generator.interface.ActorStats | Handles actors stats |
| engine.generator.interface.ActorTalents | Handles actors stats |
| engine.generator.interface.ActorTemporaryEffects | Handles actors temporary effects (temporary boost of a stat, ...) |
| engine.generator.interface.BloodyDeath | Interface to add a bloodyDeath() method to actors When this method is called, the floor or walls around the late actor is covered in blood |
| engine.generator.interface.ControlCursorSupport | Handles control Cursor This should work for anything that has a surface and x,y,w,h,font properties. |
| engine.generator.interface.GameMusic | Handles music in the game |
| engine.generator.interface.GameSound | Handles sounds in the game |
| engine.generator.interface.GameTargeting | Handles default targeting interface & display |
| engine.generator.interface.ObjectActivatable | Handles activable objects, much more simple than actor's resource It can define simple activations, complex ones that use power and it can also activate talent (ActorTalents interface must also be used on the Object class in this case) |
| engine.generator.interface.ObjectIdentify | Handles unidentified objects, and their identification |
| engine.generator.interface.PlayerDumpJSON | Handles player json "char dump" This is used for auto uploads to te4.org, could be for other stuff too |
| engine.generator.interface.PlayerExplore | This file implements a simple auto-explore whereby a single command can explore unseen tiles and objects. |
| engine.generator.interface.PlayerHotkeys | Handles player hotkey interface
This provides methods to bind and manage hotkeys as well as using them This interface is designed to work with the engine.HotkeysDisplay class to display current hotkeys to the player |
| engine.generator.interface.PlayerMouse | Handles player default mouse actions Defines some methods to help use the mouse in an uniform way in all modules |
| engine.generator.interface.PlayerRest | Handles player resting |
| engine.generator.interface.PlayerRun | Handles player running
This should work for running inside tunnel, alongside walls, in open spaces. |
| engine.generator.interface.PlayerSlide | Makes the player "slide" along walls when possible Simply call x, y = self:tryPlayerSlide(x, y, force) in your player's move() method |
| engine.generator.interface.WorldAchievements | Handles achievements in a world |
| engine.ui.ActorFrame | |
| engine.ui.base | A generic UI element |
| engine.ui.Button | A generic UI button |
| engine.ui.ButtonImage | A generic UI button image |
| engine.ui.Checkbox | A generic UI checkbox |
| engine.ui.Dialog | A generic UI Dialog |
| engine.ui.Dropdown | A generic UI list dropdown box |
| engine.ui.Empty | An empty space |
| engine.ui.EntityDisplay | A generic entity display |
| engine.ui.EquipDoll | Equipment doll preview |
| engine.ui.EquipDollFrame | Equipment Doll preview frame |
| engine.ui.Focusable | Make a UI element clickable |
| engine.ui.GenericContainer | An empty space that contains other elements |
| engine.ui.Gestures | |
| engine.ui.Image | A generic UI image |
| engine.ui.ImageList | A generic UI image list |
| engine.ui.Inventory | A generic inventory, with possible tabs |
| engine.ui.List | A generic UI list |
| engine.ui.ListColumns | A generic UI multi columns list |
| engine.ui.Numberbox | A generic UI number textbox |
| engine.ui.Separator | A generic UI separator |
| engine.ui.Slider | A generic UI slider, usualy used by other UI elements |
| engine.ui.SubDialog | A generic UI button |
| engine.ui.SurfaceZone | A generic UI surface zone |
| engine.ui.Tab | A generic UI tab |
| engine.ui.Tabs | A tab container |
| engine.ui.Textbox | A generic UI textbox |
| engine.ui.Textzone | A generic UI text zone |
| engine.ui.TextzoneList | A generic UI textzone list |
| engine.ui.TreeList | A generic UI tree list |
| engine.ui.UIContainer | A generic UI Container |
| engine.ui.UIGroup | A generic UI group |
| engine.ui.VariableList | A generic UI variable list |
| engine.ui.WaitBar | A generic waiter bar |
| engine.ui.Waiter | A generic waiter |
| engine.ui.Webview | A web browser |
| engine.ui.WithTitle | Helper for "title" parameter for UI elements |
| engine.webcore |
Manual
| colors.md | |
| getting_started.md | |
| index.md |