Introduction

This page provides detailed technical information about the Ambitions Library: its purpose, structure, and how to integrate it efficiently into your projects.

Purpose

The Ambitions Library centralizes reusable, optimized functions. It eliminates redundant code, ensuring high-quality standards, modularity, and a single source of truth across all your resources.

Use it whether you're developing within Ambitions or creating standalone scripts that adopt our logic standards.

---

Technical Structure

The library is organized into logical categories, each documented clearly:

• High-level categories: grouped by domain (e.g., callbacks, math, player utilities).

• Individual functions: clearly annotated with detailed examples.

Each function’s documentation includes:

• Purpose & use-case.

• Parameters & return values.

• Clear, executable examples.

---

Access & Naming Conventions

Every library function is explicitly loaded. Ambitions avoids traditional global namespaces (used in ESX, QBCore, vRP, QBox, etc.):

• Functions are accessed via clear imports.

• Naming follows module paths and usage purposes.

---

Integration With the Import System

All Ambitions utilities must be explicitly imported using our import system.

Include in your fxmanifest.lua:

shared_script '@Ambitions/importation.lua'

This does not inject any global variable

Instead, functions must be explicitly loaded using Import() or ImportJson().

This approach ensures:

• ✅ Scoped and isolated usage.

• ✅ Explicit code readability.

• ✅ Clear runtime validation.

For detailed internals and advanced usage:

→ Importation System Reference

Every function documented in the library includes a working example that shows how to import it using all relevant syntaxes.

---

Compatibility & Contexts

The Ambitions Library strictly uses Lua 5.4. All scripts must comply with this version.

Function contexts:

Context	Path
🌐 Shared	shared/lib/...
🖥️ Server-only	server/lib/...
🎮 Client-only	client/lib/...

---

Now that the foundation is clear, dive into the category list to start exploring what the Ambitions Library has to offer.