Frontend Documentation

Scripting Homepage

Search

Search frontend only




Game Areas

• Campaign Index
• Battle Index
• > Frontend Index

On this page

Key

Loaded in Battle
Loaded in Campaign
Loaded in Frontend

• Frontend Index
•   Script File Locations
•   Frontend script interface
•   Uses for Frontend Script

Frontend Topics

• > Frontend Index
• Lua Language
• Scripted Events

Game Code Pages

• Effect
• Frontend
• ScriptedValueRegistry
• UIComponents

Script Pages

• Core
• Campaign Interface
• Global
• Script Messager
• Text Pointers
• Timer Manager

Frontend Index

Welcome to the homepage for frontend scripting in Total War. Here you can find resources and guidance for the creation of scripts that will run in the frontend.

Relevant in Frontend

Not much script tends to run in the frontend. The game automatically loads the file script\frontend_scripted.lua when the frontend is started. Any intended frontend scripts can be placed in, or loaded from, this file.

The frontend script environments provides an interface object, frontend, on which a number of functions may be called. See the frontend page for more information.

Historic uses for scripting in the frontend:

• Powering animation sequences made in UI to be shown prior to launching a historic battle (Fall of the Samurai/Rome2).
• Opting player in to tutorial if they've never played the game (Warhammer).
• Setting up an initial loading screen for the player (Warhammer).