Skip to content

StarterKit

Inherits HiddenBase

StarterKit is a container for Tools that should be given to every player. Any Tool placed inside StarterKit is automatically copied into each player's backpack when they spawn, similar to a starter pack. The Tools themselves stay in StarterKit as templates and are never removed.

StarterKit lives between ServerHidden and PlayerDefaults in the explorer. Its contents are not rendered in the world.

Example: drop a Tool into StarterKit and every player will spawn holding a copy of it in their inventory. Use the Enabled and GiveOnRespawn properties to control when the tools are handed out.

Static Class

This object is a static class. It can be accessed like this: StarterKit.

Additionally, it cannot be created in the creator menu or with Instance.New().

Not newable

This object cannot be created by scripts using Instance.New().

Properties

Enabled : boolean

When true (the default), the Tools in StarterKit are given to players on spawn. Set to false to disable StarterKit entirely without removing its Tools.

GiveOnRespawn : boolean

When true (the default), the Tools are given again every time the player respawns. When false, the Tools are only given on the player's first spawn after joining, so they are not returned after death.

Methods

GetTools → { Tool }

Parameters: ``

Returns all the Tools currently inside StarterKit.