API Reference

Complete API reference for the Parallax framework. Each page contains full inline documentation: descriptions, parameters, return values, realm, and usage examples.

Libraries: 35  ·  Other files: 19  ·  Documented functions: 547

Libraries

Library	Description	Functions	Realm(s)
ax.actionBar	Action bar system for displaying circular progress indicators with timers.	4	client
ax.animations	Animation library	4	shared
ax.bind	Advanced key binding system allowing registration of key combinations with press and release callbacks.	2	client
ax.character	Character management system for creating, storing, and retrieving character data.	13	server, shared
ax.chat	Chat system for registering chat types with commands, permissions, and custom formatting.	12	server, shared
ax.chatbox	Count visible characters (excluding markup tags)	2	client
ax.class	Class management system for creating, storing, and retrieving class data.	7	shared
ax.command	Command system for registering and executing chat/console commands.	13	client, server, shared
ax.currencies	Character-based currency system for managing multiple currencies in roleplay scenarios.	9	server, shared
ax.data	Simple data persistence helpers.	3	shared
ax.database	Database management system for handling connections, schema definitions, and table creation.	4	server
ax.ease	Easing functions for lerping values.	1	shared
ax.faction	Faction management system for creating, storing, and retrieving faction data.	6	shared
ax.flag	Flag management system for character permissions and abilities.	3	shared
ax.font	Font management system for creating and storing fonts used throughout the Parallax Framework.	3	client
ax.hook	Hook system for registering and managing custom hook types, internally handles Schema and Module hooks.	2	shared
ax.inventory	Inventory management system for creating, storing, and retrieving inventory data.	4	server
ax.item	Item management system for creating, storing, and managing game items.	1	shared
ax.localization	Localization system for multi-language support.	4	shared
ax.mapscene	Client-side map scene behavior.	48	client, server, shared
ax.module	Module management system for loading and retrieving modules.	5	shared
ax.motion	Advanced panel animation handler using easing for custom fields. Supports delays, per-field animation isolation, and cancelation.	3	client
ax.net	Enqueue a net job to prevent overlapping net.Start calls.	8	shared
ax.notification	Minimal stacked notifications rendered above all VGUI.	4	client, server, shared
ax.player	Player management system for creating, storing, and retrieving player data.	3	shared
ax.player.meta	Player meta functions	48	client, server, shared
ax.rank	Rank management system for creating, storing, and retrieving rank data.	7	shared
ax.recognition	Recognition system for tracking character familiarity, aliases, and name display.	8	server, shared
ax.reqwest	Thin wrapper around the reqwest binary module by William Venner.	5	shared
ax.schema	Schema management system for initializing and loading schemas.	1	shared
ax.theme	Client-side theme registry and glass UI rendering helpers.	9	client
ax.type	The type library provides utilities for type detection, sanitization, and formatting.	3	shared
ax.util	Utility helpers used across the Parallax framework (printing, file handling, text utilities, etc.).	72	client, server, shared
ax.viewstack	Viewstack library for managing camera and viewmodel modifications.	13	client
ax.zones	Get the client's zone tracking state.	22	client, server, shared

Other Files

File	Description	Functions	Realm(s)
ax.relay	Entity and global variable relay system for synchronized data storage.	4	shared
interface/cl_main_create		1	client
interface/cl_tab	Sorts section keys by sort order, then by name alphabetically.	8	client
libraries/cl_skin	--------------------------------------------------------]]	28	client
libraries/thirdparty/sh_cami	defines the charactaristics of a usergroup	13	shared
libraries/thirdparty/sh_utf8	Changes any upper-case letters in a string to lower-case letters.	2	shared
masks	Melon's Masks	5	client
meta/sh_character	Returns a human-readable string representation of the character.	19	server, shared
meta/sh_color	Returns true if the color is perceived as dark by a human viewer.	1	shared
meta/sh_entity	Returns true if the entity's model is a chair from the Vehicles list.	9	server, shared
meta/sh_inventory	Returns a human-readable string representation of the inventory.	20	server, shared
meta/sh_item	Returns a human-readable string representation of the item.	20	shared
meta/sh_tool	Creates and returns a new tool object instance from this metatable.	19	shared
outline		3	client
ax.player.meta	Player meta extensions for currency management.	10	shared
ax.zones	Validate a box zone specification.	14	shared
cl_intro	Registers a line in the intro sequence.	2	client
currencies/meta/sh_character	Get the amount of a specific currency this character has.	10	shared
doors/meta/sh_entity		3	server