Player Wrist_attachments

scripts/vscripts/alyxlib/player/wrist_attachments.lua

Global variables

Name	Value
`WristAttachments`	`table`

Adds a new entity as a wrist attachment.

WristAttachments:Add(entity, hand, length, priority, offset, angles)

Parameters

entity
EntityHandle
The entity which will become a wrist attachment
hand (optional)
WristAttachmentHandType
The hand type to attach to initially
length
number
Physical length of the entity to make sure it will not overlap with other wrist attachments
priority
number?
Priority for the entity when there are other wrist attacments - lower number is higher priority, cannot specify a value lower than 0
offset
Vector?
Optional origin offset for the entity (x component is ignored)
angles
QAngle?
Optional angles offset for the entity

Sets the hand that the entity should be attached to.

WristAttachments:SetHand(entity, hand, offset, angles)

Parameters

entity
EntityHandle
The entity to change data for
hand
WristAttachmentHandType
The type of hand to attach to
offset (optional)
Vector
Optional origin offset for the entity (x component is ignored)
angles (optional)
QAngle
Optional angles offset for the entity

Gets the hand that the entity is attached to.

WristAttachments:GetHand(entity)

Parameters

Returns - CPropVRHand? The hand that the entity is attached to

Gets the attachment data related to an attach entity.

WristAttachments:GetEntityAttachment(entity)

Parameters

Returns - WristAttachmentData? The attachment data for the entity, or nil if not found

Checks if an entity is attached to a wrist using this system.

WristAttachments:IsEntityAttached(entity)

Parameters

Returns - boolean true if attached, false otherwise.

Updates the attachments.

This is called automatically when an attachment is added or removed or when the player's primary hand changes.

WristAttachments:Update()