API Reference

GnomiumAPI v1.3.0

Browse all 88 GnomiumAPI classes organized into 9 categories. Each section has its own dedicated page with full method signatures, descriptions, and related class links.

9
Categories
88
Classes
648
Methods
428
Verified
experimental Some methods depend on components not yet verified in all game scenes. Look for the experimental badge.

Core Infrastructure

Type caching, singleton discovery, cached reflection, NetworkVariable helpers, assembly scanning, data types, and game enum constants (ItemType, RoomType, GameState, etc.).

GameReflectNetAssembliesInventorySlotGnomiumAPIModItemTypeDismemberPartEffectTypeRoomTypeGameStateGameEventItemCategoryAiUsageFlagsWeatherTypeDifficultyPlayerSoundFeedbackType
18 classes
🎮

Player & Character

Player discovery, health, inventory, status effects, movement, ragdoll physics, equipment, weapons, dismemberment, stamina, hands, gnomium currency, advanced movement (glider, ledge, wall climb), and extended networking properties.

PlayersHealthInventoryStatusMovementRagdollEquipmentWeaponsDismembermentPlayerStateStaminaHandsGnomiumResourcesHomeResourcesAdvancedMovementPlayerNetEx
17 classes
🌍

World & Game

World state, time of day, game flow control, respawn systems, house and room management, procedural map generation, game settings, and scene loading.

WorldGameFlowRespawnHouseRoomsMapGenGameSettingsScenes
8 classes
📦

Objects & Interactables

Spawning, destroying, and querying world objects. Doors, lighting, crafting stations, interactable discovery, task management, and item registry access.

ObjectsCustomObjectsWorldObjectsInteractablesDoorsLightingCraftingTasksItemsStealablesDroppedItems
11 classes
👾

AI & Enemies

Enemy discovery, AI behavior states, NPC management, and ghost entities. Control spawning, alertness, targets, and AI decision-making.

EnemiesAINPCsGhosts
4 classes
📡

Networking & Social

Netcode management, lobby controls, Steam integration, and voice chat. Host/client detection, RPC helpers, and multiplayer session management.

NetworkingLobbySteamVoiceChat
4 classes
🎵

Audio & Visuals

Audio playback, custom asset loading, texture replacement, camera control, visual effects, and weather. Load mod sounds, replace game textures, manage asset registries.

AudioCustomAssetsCustomAudioCustomTexturesAssetRegistryGameCameraCameraFXWeather
8 classes
🔧

Systems & Utilities

Event bus, timers, input keys, coroutines, physics helpers, field patching, pathfinding, notifications, HUD control, travel systems, vehicle driving, logging, and enum resolution.

EventsTimersKeysCoroutinesGamePhysicsFieldPatchPathfindingNotifyHUDTravelDrivingLogEnums
13 classes
🛒

Economy & Shop

Complete pre-lobby shop system. Buy and sell items with gnomium, manage stock, categories, discounts, flash sales, transaction history, and custom mod items.

ShopShop.ItemsShop.CategoriesShop.DiscountsShopCategory
5 classes

Data Types

Shared data structures and the mod entry point class.