Skip to main content
Dynamically registers a new stash and creates its server inventory during runtime.

Parameters

Return value

Notes

options fields:
  • id (string, optional): Unique ID for the stash. If not provided, one will be autogenerated
  • label (string, required): Display name for the stash
  • coords (vector3 | table, optional): Location where the stash can be accessed via interaction point
  • maxWeight (number, optional): Maximum weight capacity. Default: 100
  • maxSlots (number, optional): Maximum number of slots. Default: 100
  • radius (number, optional): Distance from which players can access the stash. Default: 3.0
  • isPrivate (boolean, optional): If true, creates a separate inventory for each player. Default: false
  • allowedJobs (table, optional): Table of job names that can access the stash. If nil, stash is public
  • temporary (boolean, optional): If true, stash won’t be saved to database and lost on script restart. Default: false
  • startingItems (table, optional): Items to add when the stash is first created. Format: {{itemName, amount, metadata}, ...}
  • runtimeOnly (boolean, optional): If true (default), stash can only be opened programmatically. If false and coords are provided, creates client-side interaction points. Default: true