Lua & SCAR reference

Understand what every SCAR function is actually doing.

Type a function name like Player_GetAllEntities or UI_CreateMinimapBlip and get a human explanation with real examples from practical tools – not just a dry one-line description.

Substring search • Multiple matches • Example code aimed at real tool-building

Example: enemy TC minimap rings

SCAR snippet

Lua / SCAR

-- Draw a ring around enemy town centers
function MarkEnemyTownCenters()
    local enemies = Core_GetEnemyPlayers()
    for _, p in pairs(enemies) do
        local pos = GetTownCentrePosition(p)
        if pos then
            UI_CreateMinimapBlip(pos, 50.0, "general")
        end
    end
end

Functions documented –

Example snippets > 1 per function

Search type Substring / fuzzy-ish

Built for learning, not copy-paste cheating

Fan project – not affiliated with Relic / Microsoft.

Docs

Search SCAR functions by name.

🔍

Tips: try partial names like Player_, minimap, or SGroup.

Showing all functions.

Click a card to see full details & examples.

How to use this site

Think of it as a cheat-sheet for tool builders.

The goal of this site isn't to dump every single internal function – it's to give you mental models for the functions you actually touch when building HUD tools and QoL scripts.

Search a function by name or partial name.
Read what it does in simple English.
Look at examples that are inspired by real tooling: minimap rings, scout filters, enemy lists, etc.
Combine pieces into your own scripts.

Important disclaimer

This site is a fan-made educational resource. It is not affiliated with, endorsed by, or supported by Relic Entertainment, Microsoft, or any official Age of Empires team.

Use what you learn responsibly. Don't ruin other people's games. The focus here is understanding scripting, prototyping tools, and building your own skills – not selling cheats.

Contact

Get in touch.

Talk to Billy

Discord: Join the SCAR Toolkit Discord
Email: Contact us via email

Best way to reach out is Discord. If you're stuck on a function or want to suggest new entries for this reference, ping me there.

Roadmap

Planned additions:

More detailed AI behaviour examples.
Ready-to-paste mini-modules (econ-only AI, scout filters, HUD widgets).
Exportable snippets for different injection setups.