Scripting Equipment

Scripting: Equipment

Return to the Scripting Guide.

This object represents a single piece of Equipment or Equipment container.

The For column indicates whether the property or method is defined for a container (C), a leaf (L), or both.

For	Property	Type	Value	Availability
CL	id	string	The object ID.	GCS v5.36+
CL	parentID	string | undefined	The parent's object ID or undefined if there isn't one.	GCS v5.36+
CL	parent	object | undefined	The parent Equipment or undefined if there isn't one.	GCS v5.41+
CL	name	string	The name.	GCS v5.36+
CL	techLevel	string	The Tech Level.	GCS v5.36+
CL	legalityClass	string	The Legality Class.	GCS v5.36+
CL	quantity	number	The quantity.	GCS v5.36+
CL	level	number	The level.	GCS v5.36+
CL	uses	number	The current uses value.	GCS v5.36+
CL	maxUses	number	The maximum uses value.	GCS v5.36+
CL	value	number	The value of one of these items.	GCS v5.36+
CL	extendedValue	number	The value of this item (with its full quantity) and any items it contains.	GCS v5.36+
CL	weight	number	The weight in pounds of one of these items.	GCS v5.36+
CL	extendedWeight	number	The weight in pounds of this item (with its full quantity) and any items it contains.	GCS v5.36+
CL	weightIgnoredForSkills	boolean	True if this item's weight doesn't count against skill usage.	GCS v5.36+
CL	equipped	boolean	True if the item is equipped.	GCS v5.36+
CL	weapons	object[]	Returns a list of Weapons attached to this item.	GCS v5.41+
CL	notes	string	The notes.	GCS v5.39+
CL	tags	string[]	The associated tags.	GCS v5.36+
CL	container	boolean	True if this is a container.	GCS v5.36+
C	children	object[] | undefined	The contained child Equipments. Undefined if this isn't a container.	GCS v5.36+
CL	activeModifiers	object[]	Returns a flattened list of active Equipment Modifiers attached to this item.	GCS v5.41+

For	Method	Arguments	Result Type	Result	Availability
C	find	name: string, tag: string	object[]	Returns the Equipment within the hierarchy of this item that matches the given name and have the given tag, case-insensitively. When matching, an empty or undefined value passed in will match everything.	GCS v5.36+
CL	findActiveModifier	name: string	object | null	Returns the first active Equipment Modifier attached to this item with the given name, case-insensitively.	GCS v5.41+
CL	findWeapons	melee: boolean, name: string, usage: string	object[]	Returns the Weapons that match the given name and usage, case-insensitively. When matching, an empty or undefined value passed in will match everything.	GCS v5.41+

Return to the Scripting Guide.