Component:ItemShelf

CollapseComponent image 

Item Shelf component as seen in the Scene Inspector

The Item Shelf component, often referred to as the tool shelf, is found on the wrists of avatars and is used to place items or tools onto the user's hands for later retrieval or use. It is sometimes used by creations to keep an item on the user's hand.

Fields

Fields Collapse

Name	Type	Description
persistent	Bool	Determines whether or not this item will be saved to the server.
UpdateOrder	Int	Controls the order in which this component is updated.
Enabled	Bool	Controls whether or not this component is enabled. Some components stop their functionality when this field is disabled, but some don't.
GrowDirection	ItemShelf.Direction	the direction the shelf should grow as the item area grows.
IgnoreGrabber	Grabber	The grabber that when items are released from it, the items should be ignored by this.
MinLength	Float	The minimum length the shelf visual can be.
Width	Float	The width of the shelf visual.
Thickness	Float	The thickness of the shelf visual.
MaxItemSize	Float	The maximum size before items will not stick to this shelf.
MaxPlaneDistance	Float	The max plane distance items can be before they will not stick to this shelf.
MaxHeightDistance	Float	The max height distance items can be before they will not stick to this shelf.
_targetLength	Float	The length this item shelf is tweening towards.
_visual	Slot	The root of the shelf visual.
_content	Slot	The slot containing items for this item shelf.
_material	PBS_RimMetallic	The material being used for the item shelf.
_visualOffset	field drive of Float3	The field being used to offset the visual position.
_shelfMesh	reference drive of BevelStripeMesh	The mesh being used for the shelf visual.
_collider	reference drive of BoxCollider	The collider being used to receive items for this shelf.

Direction

Values

Name	Value	Description
Left	0	Itemshelf should expand in the left direction.
Right	1	Itemshelf should expand in the right direction.

Usage

auto generated by the game.

Examples

The tool shelves the user has.