Class
StarterGear
If the game allows gear, StarterGear is a container automatically inserted
into each Player object when the player joins the game. Whenever the
player's character spawns, the contents of that player's StarterGear are
copied into the player's Backpack.
When a player spawns, the contents of that player's StarterGear is copied
into the player's Backpack. Additionally, if the game allows gear, all
of the appropriate gear Tools that the player owns are inserted
into that player's StarterGear.
Unlike StarterPack, StarterGear isn't a service but rather a child
of each Player object, so its contents are player‑specific. Whether or
not gear can be permitted is determined in a place's Permissions settings.
You can enable gear by its genre or choose specific types to allow. To disable
gear, ensure all the gear types are unselected.
Listening to the Players.PlayerAdded event from a server
Script is useful for accessing StarterGear:
local Players = game:GetService("Players")
local toolPrefab = Instance.new("Tool")
toolPrefab.Name = "Example Tool"
local function onPlayerAdded(player)
-- Wait for StarterGear to be added
local starterGear = player:WaitForChild("StarterGear")
-- Clone prefab tool to StarterGear
local toolClone = toolPrefab:Clone()
toolClone.Parent = starterGear
end
Players.PlayerAdded:Connect(onPlayerAdded)Gameplay Considerations#
Always test experiences after adding gear to them to check that users can't
easily abuse them there. Gear may include Script objects which allow
the player to perform actions that you might not consider; for example,
navigational gear might allow the player to access a part of the map that you
don't want them to, and weapon gear may allow the holder to damage other
players, possibly without retribution or retaliation.
Inherited members#
Inherited from Instance 58
Properties (10)
Archivable, archivable, Capabilities, IsInSandbox, Name, Parent, PredictionMode, RobloxLocked, Sandboxed, UniqueId
Methods (39)
AddTag, children, ClearAllChildren, Clone, clone, Destroy, destroy, FindFirstAncestor, FindFirstAncestorOfClass, FindFirstAncestorWhichIsA, FindFirstChild, findFirstChild, FindFirstChildOfClass, FindFirstChildWhichIsA, FindFirstDescendant, GetActor, GetAttribute, GetAttributeChangedSignal, GetAttributes, GetChildren, getChildren, GetDebugId, GetDescendants, GetFullName, GetStyled, GetStyledPropertyChangedSignal, GetTags, HasTag, IsAncestorOf, IsDescendantOf, isDescendantOf, IsPropertyModified, QueryDescendants, Remove, remove, RemoveTag, ResetPropertyToDefault, SetAttribute, WaitForChild