Developer Documentation
Technical API reference for ACE. Function signatures, parameters, return values, and usage examples.
Help verify documentation by checking if function descriptions match the actual behavior.
Recently Updated
View all →SF.acfReloadProgress
Starfall
Returns number between 0 and 1 which represents reloading progress of an ACF weapon. Useful for progress bars
Entity:acfReloadProgress()ACE_IsValidSound
ACE
Returns whether or not a sound actually exists, fixes client timeout issues
function ACE_IsValidSound( path )ACE.SRicochet
ACE
Handles ricochet sounds
function ACE.SRicochet( HitPos, Caliber, Velocity, HitWorld, Material )SF.acfShiftTime
Starfall
Returns the time in ms an ACF gearbox takes to change gears
Entity:acfShiftTime()SF.acfSteerRate
Starfall
Sets the steer ratio for an ACF gearbox
Entity:acfSteerRate(rate)SF.acfShiftDown
Starfall
Cause an ACF gearbox to shift down
Entity:acfShiftDown()Browse by Namespace
ACE
CArmored Combat Extended API — the ACE additions on top of ACF, covering crew, sustainability, networking, and gameplay systems. Includes `ACE.*` methods and `ACE_*` globals.
ACFM
S**Legacy.** The older ACF Missiles (`ACFM`) helpers. Largely deprecated — prefer the missile functionality exposed through `ACE`/`ACF`. Kept for reference.
E2
S**Expression 2** bindings ACE registers for Wiremod's E2 chips. Called from E2 code as `Entity:acfName()` etc.; these run server-side.
Starfall
SThe **Starfall** `acf` library and entity methods ACE registers for the Starfall processor. Accessed in Starfall as `acf.getGunSpecs(...)` and `Entity:acfName()`.
ACF
SCore Armored Combat Framework API — guns, ammo, armor, and the damage model. Includes both the `ACF.*` table methods and the classic `ACF_*` global functions.
_G (Global)
SGlobal functions that are not part of any namespace
External References
Documentation mirrored from partner projects. Maintained upstream — not included in ACE's function or verification counts.
Project Documentation
Reference for the other codebases the ACE team maintains.
