Skip to content
Alt:SA
DownloadWikiGodfather APIChangelogRoadmapCommunity
Get Alt:SA
/
Start here
  • Introduction
  • Install guide
  • Buy GTA San Andreas
  • How it fits together
  • Build the engine
  • Help & FAQ
Getting started
  • Server
  • Development
  • Events
  • Commands
  • Client-side
Godfather API
  • Overview
  • UI kit
  • API reference
  • Gamemode
  • Player
  • Camera
  • Storage
  • HUD and wanted level
  • UI
  • Loading and versions
Agent-Toolkit
  • Overview
  • Tools
  • Skills
  • project-site
  • release-and-changelog
  • repo-handover
  • roadmap-upkeep
  • unity-autotest
  • unity-dev-build
  • Playbooks
  • Start a new project
  • Ship a change
  • Contribute back
  • Knowledge
  • Shell and git
  • Unity
  • Web and static sites
  • Windows dev machine
Changelogs
  • Engine
  • Godfather-API
  • Agent-Toolkit
  • Website
Roadmaps
  • Platform
  • Godfather-API
  • Agent-Toolkit
Community
  • Community
  • Discord ↗
  • Forum
  • NG-RP ↗
Wiki/Godfather API/API reference

API reference

API reference: every page in this part of the Godfather API docs.

  • GamemodeThe base class for a gamemode. The server creates one instance and calls its events on the main thread.
  • PlayerA connected player. Methods run on the server; the player's game follows.
  • CameraPer-player camera control, reached through player.Camera: fly-overs, a flight down to a point, and the normal camera.
  • StorageKey-value data kept on the server between restarts, and player accounts with salted, slow password hashes.
  • HUD and wanted levelDrive the player's GTA V-style HUD from the server (money, strips, timers, GPS, stats, sights, hiding pieces) and give them a wanted level with a police search area.
  • UIServer-driven screens in the black-glass style. The server describes the screen; the player's game draws it and sends back input.
  • Loading and versionsHow the dedicated server finds and starts gamemodes, and how Godfather versions work.
NextIntroduction
Alt:SA

San Andreas Multiplayer. A Knot Vector project.

PlatformDownloadChangelogRoadmap
WikiIntroductionGetting startedGodfather APIAgent-Toolkit
CommunityDiscordForumNG-RPSource (private)

Not affiliated with or endorsed by Rockstar Games or Take-Two Interactive. Grand Theft Auto and San Andreas are their trademarks. You need your own copy of GTA San Andreas to play. Screenshots are from the Alt:SA engine.