Namespace S1API.Items
Namespaces
Classes
- AdditiveDefinition
Represents an additive item definition. Extends StorableItemDefinition with additive-specific properties.
- AdditiveDefinitionBuilder
Builder for composing additive definitions at runtime. Use fluent methods to configure additive properties before calling Build().
- AdditiveItemCreator
Provides convenient static methods for creating custom additive items. Use CreateBuilder() for creating additives from scratch, or CloneFrom(string) for variants.
- AvatarEquippablePaths
Provides constants for base game AvatarEquippable prefab paths. These paths can be used with WithAvatarEquippable(string, AvatarHand, string).
- AvatarEquippableRegistry
Manages registration and loading of AvatarEquippable prefabs from AssetBundles. Allows modders to load AvatarEquippable prefabs and register them so they can be used with equippable items.
- BuildableItemCreator
Provides convenient static methods for creating custom buildable items.
- BuildableItemDefinition
Represents a buildable item definition that can be placed in the game world. Extends StorableItemDefinition with building-specific properties.
- BuildableItemDefinitionBuilder
Builder for composing buildable item definitions at runtime. Use fluent methods to configure buildable item properties before calling Build().
- ClothingItemCreator
Provides convenient static methods for creating custom clothing items. Use CreateBuilder() for flexible configuration or CloneFrom(string) for variants.
- ClothingItemDefinition
Represents a clothing item definition that can be worn by the player. Extends StorableItemDefinition with clothing-specific properties.
- ClothingItemDefinitionBuilder
Builder for composing clothing item definitions at runtime. Use fluent methods to configure clothing properties before calling Build().
- ClothingItemInstance
Represents a clothing item instance in the game world (physical clothing you own). Extends ItemInstance with color information.
- Equippable
Represents an equippable component that can be attached to items. Provides a wrapper around the game's native equippable system.
- EquippableBuilder
Builder for creating equippable components that can be attached to items. Use this to create custom equippable behavior for items.
- ItemCreator
Provides convenient static methods for creating custom items. Use CreateBuilder() for flexible configuration or CreateItem(string, string, string, ItemCategory, int, float, float, LegalStatus, bool, FullRank?, Sprite, Equippable) for quick creation.
- ItemDefinition
Represents an item definition in-game. This is the base wrapper class for all item types.
- ItemInstance
Represents an item instance in the game world (physical item you own).
- ItemManager
Provides access to managing items across the game.
- ItemSlotInstance
Represents an item slot within the game. These are present within storage, the hot bar, etc.
- QualityItemCreator
Provides convenient static methods for creating custom quality items. Use CreateBuilder() for flexible configuration or CloneFrom(string) for quick variants based on existing items.
- QualityItemDefinition
Represents a quality item definition that can be consumed or used in recipes Extends StorableItemDefinition with quality-specific properties.
- QualityItemDefinitionBuilder
Builder for composing quality item definitions at runtime. Use fluent methods to configure item properties before calling Build()
- QualityItemInstance
Represents a quality item instance in the game world (usable item). Extends ItemInstance with quality information.
- StorableItemDefinition
Represents an item definition that can be purchased, sold, and stored in inventories. Extends ItemDefinition with economic properties.
- StorableItemDefinitionBuilder
Builder for composing item definitions at runtime. Use fluent methods to configure item properties before calling Build().
Enums
- AvatarHand
Represents which hand holds an equippable item in third-person view.
- BuildSoundType
Specifies the sound type played when a buildable item is placed.
- ClothingApplicationType
Represents how a clothing item is applied to the avatar. Mirrors ScheduleOne.Clothing.EClothingApplicationType.
- ClothingColor
Represents available clothing colors. Mirrors ScheduleOne.Clothing.EClothingColor.
- ClothingSlot
Represents the slot where a clothing item can be equipped. Mirrors ScheduleOne.Clothing.EClothingSlot.
- ItemCategory
A list of item categories available in-game.
- LegalStatus
Represents the legal status of an item (e.g., legal or illegal).