GetAllItems

From the Fallout3 GECK Wiki
Jump to navigation Jump to search
< [[::Category:Functions|Category:Functions]]

A function added by the JIP NVSE Plugin.

Description

Returns an array_var containing the base forms of all the items in the calling reference's inventory.

Four optional parameters may be passed for filtering the result:

typeCode - Only include items of this type (a full list of type-codes can be found here). Passing 0 will include items of ANY type.

noNonPlayable - Do not include items that are non-playable (only applicable to clothing, weapons and ammo).

noQuestItems - Do not include quest items.

noEquipped - Do not include items that are currently equipped by the calling reference.

Syntax

[help]
(items:array_var) reference.GetAllItems typeCode:int noNonPlayable:0/1 noQuestItems:0/1 noEquipped:0/1

Example

let aItems := objectRef.GetAllItems

The returned array will include ALL the items in the calling reference's inventory.

let aItems := objectRef.GetAllItems 40 1 0 1

The returned array will include all the weapon-type items in the calling reference's inventory, excluding weapons that are non-playable or equipped.

See Also