rojo/.cursor/rules/roblox/reference/engine/classes/HopperBin.yaml
2026-02-02 12:08:47 -06:00

94 lines
2.4 KiB
YAML

# This file is automatically generated. Please don't edit it manually.
# To submit a bug report on the content, see
# https://devforum.roblox.com/c/bug-reports/documentation-issues/72
name: HopperBin
type: class
memory_category: BaseParts
summary: ''
description: |
HopperBins are an outdated system for creating tools that can be used by a
player. In place of HopperBins, please use `Class.Tool` instead.
Historically, only HopperBins worked without a 'Handle' `Class.Part`, but this
is no longer the case thanks to the `Class.Tool.RequiresHandle` property of
Tools.
code_samples: []
inherits:
- BackpackItem
descendants: []
tags:
- Deprecated
deprecation_message: |
This deprecated class has been replaced by `Class.Tool`. Please use Tool for
new work instead.
properties:
- name: HopperBin.Active
summary: ''
description: ''
code_samples: []
type: boolean
tags: []
deprecation_message: |
The `Class.HopperBin` object has been superseded by the `Class.Tool`
object which should be used for all new work.
security:
read: None
write: None
thread_safety: ReadSafe
category: Data
serialization:
can_load: true
can_save: true
capabilities:
- Input
- name: HopperBin.BinType
summary: ''
description: ''
code_samples: []
type: BinType
tags: []
deprecation_message: |
The `Class.HopperBin` object has been superseded by the `Class.Tool`
object which should be used for all new work.
security:
read: None
write: None
thread_safety: ReadSafe
category: Data
serialization:
can_load: true
can_save: true
capabilities:
- Input
methods: []
events:
- name: HopperBin.Deselected
summary: ''
description: ''
code_samples: []
parameters: []
tags: []
deprecation_message: |
The `Class.HopperBin` object has been superseded by the `Class.Tool`
object which should be used for all new work.
security: None
capabilities:
- Input
- name: HopperBin.Selected
summary: ''
description: ''
code_samples: []
parameters:
- name: mouse
type: Instance
default:
summary: ''
tags: []
deprecation_message: |
The `Class.HopperBin` object has been superseded by the `Class.Tool`
object which should be used for all new work.
security: None
capabilities:
- Input
callbacks: []