Barotrauma.ItemPrefab Class Reference

Inheritance diagram for Barotrauma.ItemPrefab:

Classes
struct	CommonnessInfo
struct	FixedQuantityResourceInfo

Public Member Functions
int	GetMaxStackSize (Inventory inventory)
	ItemPrefab (ContentXElement element, ItemFile file)
CommonnessInfo?	GetCommonnessInfo (Level level)
float	GetTreatmentSuitability (Identifier treatmentIdentifier)
PriceInfo	GetPriceInfo (Location.StoreInfo store)
bool	CanBeBoughtFrom (Location.StoreInfo store, out PriceInfo priceInfo)
bool	CanBeBoughtFrom (Location location)
int?	GetMinPrice ()
ImmutableDictionary< Identifier, PriceInfo >	GetBuyPricesUnder (int maxCost=0)
ImmutableDictionary< Identifier, PriceInfo >	GetSellPricesOver (int minCost=0, bool sellingImportant=true)
bool	IsContainerPreferred (Item item, ItemContainer targetContainer, out bool isPreferencesDefined, out bool isSecondary, bool requireConditionRequirement=false, bool checkTransferConditions=false)
bool	IsContainerPreferred (Item item, Identifier[] identifiersOrTags, out bool isPreferencesDefined, out bool isSecondary)
override void	Dispose ()
void	InheritFrom (ItemPrefab parent)
ContentPackage	GetParentModPackageOrThisPackage ()
	If the base prefab this one is a variant of is defined in a non-vanilla package, returns that non-vanilla package. Otherwise returns the package of this prefab. Can be useful for logging errors that may have been caused by a mod overriding the base item.
override string	ToString ()
Public Member Functions inherited from Barotrauma.MapEntityPrefab
	MapEntityPrefab (ContentXElement element, ContentFile file)
string	GetItemNameTextId ()
string	GetHullNameTextId ()
IEnumerable< Identifier >	GetAllowedUpgrades ()
bool	HasSubCategory (string subcategory)
bool	NameMatches (string name, StringComparison comparisonType)
	Check if the name or any of the aliases of this prefab match the given name.
bool	NameMatches (IEnumerable< string > allowedNames, StringComparison comparisonType)
bool	IsLinkAllowed (MapEntityPrefab target)
Public Member Functions inherited from Barotrauma.Prefab
	Prefab (ContentFile file, Identifier identifier)
	Prefab (ContentFile file, ContentXElement element)
void	Dispose ()
Public Member Functions inherited from Barotrauma.IImplementsVariants< ItemPrefab >
void	InheritFrom (T parent)

Static Public Member Functions
static Identifier	GenerateLegacyIdentifier (string name)
static ItemPrefab	Find (string name, Identifier identifier)
static bool	IsContainerPreferred (IEnumerable< Identifier > preferences, ItemContainer c)
static bool	IsContainerPreferred (IEnumerable< Identifier > preferences, IEnumerable< Identifier > ids)
static ItemPrefab	GetItemPrefab (string itemNameOrId)
Static Public Member Functions inherited from Barotrauma.MapEntityPrefab
static bool	SelectPrefab (object selection)
static object	GetSelected ()
static MapEntityPrefab	Find (string name, string identifier=null, bool showErrorMessages=true)
	Find a matching map entity prefab.
static MapEntityPrefab	Find (string name, Identifier identifier, bool showErrorMessages=true)
static MapEntityPrefab	GetRandom (Predicate< MapEntityPrefab > predicate, Rand.RandSync sync)
static MapEntityPrefab	Find (Predicate< MapEntityPrefab > predicate)
	Find a matching map entity prefab.
static MapEntityPrefab	FindByName (string name)
static MapEntityPrefab	FindByIdentifier (Identifier identifier)
Static Public Member Functions inherited from Barotrauma.Prefab
static void	DisallowCallFromConstructor ()

Static Public Attributes
static readonly PrefabCollection< ItemPrefab >	Prefabs = new PrefabCollection<ItemPrefab>()
const float	DefaultInteractDistance = 120.0f
Static Public Attributes inherited from Barotrauma.Prefab
static readonly ImmutableHashSet< Type >	Types

Protected Member Functions
override Identifier	DetermineIdentifier (XElement element)
override void	CreateInstance (Rectangle rect)
Protected Member Functions inherited from Barotrauma.MapEntityPrefab
	MapEntityPrefab (Identifier identifier)
void	CreateInstance (Rectangle rect)
void	LoadDescription (ContentXElement element)
Protected Member Functions inherited from Barotrauma.PrefabWithUintIdentifier
	PrefabWithUintIdentifier (ContentFile file, Identifier identifier)
	PrefabWithUintIdentifier (ContentFile file, ContentXElement element)
Protected Member Functions inherited from Barotrauma.Prefab

Properties
Vector2	Size [get]
PriceInfo	DefaultPrice [get]
bool	CanBeBought [get]
bool	CanBeSold [get]
	Any item with a Price element in the definition can be sold everywhere.
ImmutableArray< Rectangle >	Triggers [get]
	Defines areas where the item can be interacted with. If RequireBodyInsideTrigger is set to true, the character has to be within the trigger to interact. If it's set to false, having the cursor within the trigger is enough.
bool	IsOverride [get]
	Is this prefab overriding a prefab in another content package.
ContentXElement	ConfigElement [get]
ImmutableArray< DeconstructItem >	DeconstructItems [get]
ImmutableDictionary< uint, FabricationRecipe >	FabricationRecipes [get]
float	DeconstructTime [get]
bool	AllowDeconstruct [get]
ImmutableArray< PreferredContainer >	PreferredContainers [get]
ImmutableArray< SkillRequirementHint >	SkillRequirementHints [get]
SwappableItem	SwappableItem [get]
ImmutableDictionary< Identifier, FixedQuantityResourceInfo >	LevelQuantity [get]
override bool	CanSpriteFlipX [get]
override bool	CanSpriteFlipY [get]
bool?	AllowAsExtraCargo [get]
	Can the item be chosen as extra cargo in multiplayer. If not set, the item is available if it can be bought from outposts in the campaign.
bool	RandomDeconstructionOutput [get]
int	RandomDeconstructionOutputAmount [get]
override Sprite	Sprite [get]
override string	OriginalName [get]
override LocalizedString	Name [get]
override ImmutableHashSet< Identifier >	Tags [get]
override ImmutableHashSet< Identifier >	AllowedLinks [get]
override MapEntityCategory	Category [get]
override ImmutableHashSet< string >	Aliases [get]
float	InteractDistance [get]
float	InteractPriority [get]
bool	InteractThroughWalls [get]
bool	HideConditionBar [get, set]
bool	HideConditionInTooltip [get, set]
bool	RequireBodyInsideTrigger [get]
bool	RequireCursorInsideTrigger [get]
bool	RequireCampaignInteract [get]
bool	FocusOnSelected [get]
float	OffsetOnSelected [get]
bool	GrabWhenSelected [get, set]
float	Health [get]
bool	AllowSellingWhenBroken [get]
bool	AllowStealingAlways [get]
bool	Indestructible [get]
bool	DamagedByExplosions [get]
float	ExplosionDamageMultiplier [get]
float	ItemDamageMultiplier [get]
bool	DamagedByProjectiles [get]
bool	DamagedByMeleeWeapons [get]
bool	DamagedByRepairTools [get]
bool	DamagedByMonsters [get]
float	ImpactTolerance [get, set]
float	OnDamagedThreshold [get, set]
float	SonarSize [get]
bool	UseInHealthInterface [get]
bool	DisableItemUsageWhenSelected [get]
string	CargoContainerIdentifier [get]
bool	UseContainedSpriteColor [get]
bool	UseContainedInventoryIconColor [get]
float	AddedRepairSpeedMultiplier [get]
float	AddedPickingSpeedMultiplier [get]
bool	CannotRepairFail [get]
string	EquipConfirmationText [get, set]
bool	AllowRotatingInEditor [get, set]
bool	ShowContentsInTooltip [get]
bool	CanFlipX [get]
bool	CanFlipY [get]
float	MinScale [get]
float	MaxScale [get]
bool	IsDangerous [get]
int	MaxStackSize [get]
int	MaxStackSizeCharacterInventory [get]
int	MaxStackSizeHoldableOrWearableInventory [get]
bool	AllowDroppingOnSwap [get]
ImmutableHashSet< Identifier >	AllowDroppingOnSwapWith [get]
bool	DontTransferBetweenSubs [get]
bool	ShowHealthBar [get]
float	BotPriority [get]
bool	ShowNameInHealthBar [get]
bool	IsAITurretTarget [get]
float	AITurretPriority [get]
float	AISlowTurretPriority [get]
float	AITurretTargetingMaxDistance [get]
bool	AllowStealingContainedItems [get]
Color	SignalComponentColor [get]
bool	DisableCommandMenuWhenSelected [get, set]
Identifier	VariantOf [get]
ItemPrefab	ParentPrefab [get, set]
Properties inherited from Barotrauma.MapEntityPrefab
static IEnumerable< MapEntityPrefab >	List [get]
static MapEntityPrefab	Selected [get, set]
Sprite	Sprite [get]
virtual bool	CanSpriteFlipX = false [get]
virtual bool	CanSpriteFlipY = false [get]
string	OriginalName [get]
LocalizedString	Name [get]
ImmutableHashSet< Identifier >	Tags [get]
ImmutableHashSet< Identifier >	AllowedLinks [get]
	Links defined to identifiers.
MapEntityCategory	Category [get]
ImmutableHashSet< string >	Aliases [get]
bool	ResizeHorizontal [get, protected set]
bool	ResizeVertical [get, protected set]
LocalizedString	Description [get, protected set]
string	AllowedUpgrades [get, protected set]
bool	HideInMenus [get, protected set]
bool	HideInEditors [get, protected set]
string	Subcategory [get, protected set]
bool	Linkable [get, protected set]
Color	SpriteColor [get, protected set]
float	Scale [get, protected set]
Properties inherited from Barotrauma.PrefabWithUintIdentifier
UInt32	UintIdentifier [get, set]
Properties inherited from Barotrauma.Prefab
ContentPackage?	ContentPackage [get]
ContentPath	FilePath [get]
Properties inherited from Barotrauma.IImplementsVariants< ItemPrefab >
Identifier	VariantOf [get]
T?	ParentPrefab [get, set]

Additional Inherited Members
Public Attributes inherited from Barotrauma.Prefab
readonly Identifier	Identifier
readonly ContentFile	ContentFile
Static Protected Attributes inherited from Barotrauma.MapEntityPrefab
static Vector2	placePosition

Constructor & Destructor Documentation

ItemPrefab()

Barotrauma.ItemPrefab.ItemPrefab	(	ContentXElement	element,
		ItemFile	file )

Member Function Documentation

CanBeBoughtFrom() [1/2]

bool Barotrauma.ItemPrefab.CanBeBoughtFrom

(

Location

location

)

CanBeBoughtFrom() [2/2]

bool Barotrauma.ItemPrefab.CanBeBoughtFrom	(	Location.StoreInfo	store,
		out PriceInfo	priceInfo )

CreateInstance()

override void Barotrauma.ItemPrefab.CreateInstance ( Rectangle rect )

protected

DetermineIdentifier()

override Identifier Barotrauma.ItemPrefab.DetermineIdentifier ( XElement element )

protectedvirtual

Reimplemented from Barotrauma.Prefab.

Dispose()

override void Barotrauma.ItemPrefab.Dispose

(

)

Find()

static ItemPrefab Barotrauma.ItemPrefab.Find ( string name, Identifier identifier )

static

GenerateLegacyIdentifier()

static Identifier Barotrauma.ItemPrefab.GenerateLegacyIdentifier ( string name )

static

GetBuyPricesUnder()

ImmutableDictionary< Identifier, PriceInfo > Barotrauma.ItemPrefab.GetBuyPricesUnder

(

int

maxCost = 0

)

GetCommonnessInfo()

CommonnessInfo? Barotrauma.ItemPrefab.GetCommonnessInfo

(

Level

level

)

GetItemPrefab()

static ItemPrefab Barotrauma.ItemPrefab.GetItemPrefab ( string itemNameOrId )

static

GetMaxStackSize()

int Barotrauma.ItemPrefab.GetMaxStackSize

(

Inventory

inventory

)

GetMinPrice()

int? Barotrauma.ItemPrefab.GetMinPrice

(

)

GetParentModPackageOrThisPackage()

ContentPackage Barotrauma.ItemPrefab.GetParentModPackageOrThisPackage

(

)

If the base prefab this one is a variant of is defined in a non-vanilla package, returns that non-vanilla package. Otherwise returns the package of this prefab. Can be useful for logging errors that may have been caused by a mod overriding the base item.

GetPriceInfo()

PriceInfo Barotrauma.ItemPrefab.GetPriceInfo

(

Location.StoreInfo

store

)

GetSellPricesOver()

ImmutableDictionary< Identifier, PriceInfo > Barotrauma.ItemPrefab.GetSellPricesOver	(	int	minCost = 0,
		bool	sellingImportant = true )

GetTreatmentSuitability()

float Barotrauma.ItemPrefab.GetTreatmentSuitability

(

Identifier

treatmentIdentifier

)

InheritFrom()

void Barotrauma.ItemPrefab.InheritFrom

(

ItemPrefab

parent

)

IsContainerPreferred() [1/4]

static bool Barotrauma.ItemPrefab.IsContainerPreferred ( IEnumerable< Identifier > preferences, IEnumerable< Identifier > ids )

static

IsContainerPreferred() [2/4]

static bool Barotrauma.ItemPrefab.IsContainerPreferred ( IEnumerable< Identifier > preferences, ItemContainer c )

static

IsContainerPreferred() [3/4]

bool Barotrauma.ItemPrefab.IsContainerPreferred	(	Item	item,
		Identifier[]	identifiersOrTags,
		out bool	isPreferencesDefined,
		out bool	isSecondary )

IsContainerPreferred() [4/4]

bool Barotrauma.ItemPrefab.IsContainerPreferred	(	Item	item,
		ItemContainer	targetContainer,
		out bool	isPreferencesDefined,
		out bool	isSecondary,
		bool	requireConditionRequirement = false,
		bool	checkTransferConditions = false )

ToString()

override string Barotrauma.ItemPrefab.ToString

(

)

Member Data Documentation

DefaultInteractDistance

const float Barotrauma.ItemPrefab.DefaultInteractDistance = 120.0f

static

Prefabs

readonly PrefabCollection<ItemPrefab> Barotrauma.ItemPrefab.Prefabs = new PrefabCollection<ItemPrefab>()

static

Property Documentation

AddedPickingSpeedMultiplier

float Barotrauma.ItemPrefab.AddedPickingSpeedMultiplier

get

AddedRepairSpeedMultiplier

float Barotrauma.ItemPrefab.AddedRepairSpeedMultiplier

get

AISlowTurretPriority

float Barotrauma.ItemPrefab.AISlowTurretPriority

get

AITurretPriority

float Barotrauma.ItemPrefab.AITurretPriority

get

AITurretTargetingMaxDistance

float Barotrauma.ItemPrefab.AITurretTargetingMaxDistance

get

Aliases

override ImmutableHashSet<string> Barotrauma.ItemPrefab.Aliases

get

AllowAsExtraCargo

bool? Barotrauma.ItemPrefab.AllowAsExtraCargo

get

Can the item be chosen as extra cargo in multiplayer. If not set, the item is available if it can be bought from outposts in the campaign.

AllowDeconstruct

bool Barotrauma.ItemPrefab.AllowDeconstruct

get

AllowDroppingOnSwap

bool Barotrauma.ItemPrefab.AllowDroppingOnSwap

get

AllowDroppingOnSwapWith

ImmutableHashSet<Identifier> Barotrauma.ItemPrefab.AllowDroppingOnSwapWith

get

AllowedLinks

override ImmutableHashSet<Identifier> Barotrauma.ItemPrefab.AllowedLinks

get

AllowRotatingInEditor

bool Barotrauma.ItemPrefab.AllowRotatingInEditor

getset

AllowSellingWhenBroken

bool Barotrauma.ItemPrefab.AllowSellingWhenBroken

get

AllowStealingAlways

bool Barotrauma.ItemPrefab.AllowStealingAlways

get

AllowStealingContainedItems

bool Barotrauma.ItemPrefab.AllowStealingContainedItems

get

BotPriority

float Barotrauma.ItemPrefab.BotPriority

get

CanBeBought

bool Barotrauma.ItemPrefab.CanBeBought

get

CanBeSold

bool Barotrauma.ItemPrefab.CanBeSold

get

Any item with a Price element in the definition can be sold everywhere.

CanFlipX

bool Barotrauma.ItemPrefab.CanFlipX

get

CanFlipY

bool Barotrauma.ItemPrefab.CanFlipY

get

CannotRepairFail

bool Barotrauma.ItemPrefab.CannotRepairFail

get

CanSpriteFlipX

override bool Barotrauma.ItemPrefab.CanSpriteFlipX

get

CanSpriteFlipY

override bool Barotrauma.ItemPrefab.CanSpriteFlipY

get

CargoContainerIdentifier

string Barotrauma.ItemPrefab.CargoContainerIdentifier

get

Category

override MapEntityCategory Barotrauma.ItemPrefab.Category

get

ConfigElement

ContentXElement Barotrauma.ItemPrefab.ConfigElement

get

DamagedByExplosions

bool Barotrauma.ItemPrefab.DamagedByExplosions

get

DamagedByMeleeWeapons

bool Barotrauma.ItemPrefab.DamagedByMeleeWeapons

get

DamagedByMonsters

bool Barotrauma.ItemPrefab.DamagedByMonsters

get

DamagedByProjectiles

bool Barotrauma.ItemPrefab.DamagedByProjectiles

get

DamagedByRepairTools

bool Barotrauma.ItemPrefab.DamagedByRepairTools

get

DeconstructItems

ImmutableArray<DeconstructItem> Barotrauma.ItemPrefab.DeconstructItems

get

DeconstructTime

float Barotrauma.ItemPrefab.DeconstructTime

get

DefaultPrice

PriceInfo Barotrauma.ItemPrefab.DefaultPrice

get

DisableCommandMenuWhenSelected

bool Barotrauma.ItemPrefab.DisableCommandMenuWhenSelected

getset

DisableItemUsageWhenSelected

bool Barotrauma.ItemPrefab.DisableItemUsageWhenSelected

get

DontTransferBetweenSubs

bool Barotrauma.ItemPrefab.DontTransferBetweenSubs

get

EquipConfirmationText

string Barotrauma.ItemPrefab.EquipConfirmationText

getset

ExplosionDamageMultiplier

float Barotrauma.ItemPrefab.ExplosionDamageMultiplier

get

FabricationRecipes

ImmutableDictionary<uint, FabricationRecipe> Barotrauma.ItemPrefab.FabricationRecipes

get

FocusOnSelected

bool Barotrauma.ItemPrefab.FocusOnSelected

get

GrabWhenSelected

bool Barotrauma.ItemPrefab.GrabWhenSelected

getset

Health

float Barotrauma.ItemPrefab.Health

get

HideConditionBar

bool Barotrauma.ItemPrefab.HideConditionBar

getset

HideConditionInTooltip

bool Barotrauma.ItemPrefab.HideConditionInTooltip

getset

ImpactTolerance

float Barotrauma.ItemPrefab.ImpactTolerance

getset

Indestructible

bool Barotrauma.ItemPrefab.Indestructible

get

InteractDistance

float Barotrauma.ItemPrefab.InteractDistance

get

InteractPriority

float Barotrauma.ItemPrefab.InteractPriority

get

InteractThroughWalls

bool Barotrauma.ItemPrefab.InteractThroughWalls

get

IsAITurretTarget

bool Barotrauma.ItemPrefab.IsAITurretTarget

get

IsDangerous

bool Barotrauma.ItemPrefab.IsDangerous

get

IsOverride

bool Barotrauma.ItemPrefab.IsOverride

get

Is this prefab overriding a prefab in another content package.

ItemDamageMultiplier

float Barotrauma.ItemPrefab.ItemDamageMultiplier

get

LevelQuantity

ImmutableDictionary<Identifier, FixedQuantityResourceInfo> Barotrauma.ItemPrefab.LevelQuantity

get

MaxScale

float Barotrauma.ItemPrefab.MaxScale

get

MaxStackSize

int Barotrauma.ItemPrefab.MaxStackSize

get

MaxStackSizeCharacterInventory

int Barotrauma.ItemPrefab.MaxStackSizeCharacterInventory

get

MaxStackSizeHoldableOrWearableInventory

int Barotrauma.ItemPrefab.MaxStackSizeHoldableOrWearableInventory

get

MinScale

float Barotrauma.ItemPrefab.MinScale

get

Name

override LocalizedString Barotrauma.ItemPrefab.Name

get

OffsetOnSelected

float Barotrauma.ItemPrefab.OffsetOnSelected

get

OnDamagedThreshold

float Barotrauma.ItemPrefab.OnDamagedThreshold

getset

OriginalName

override string Barotrauma.ItemPrefab.OriginalName

get

ParentPrefab

ItemPrefab Barotrauma.ItemPrefab.ParentPrefab

getset

PreferredContainers

ImmutableArray<PreferredContainer> Barotrauma.ItemPrefab.PreferredContainers

get

RandomDeconstructionOutput

bool Barotrauma.ItemPrefab.RandomDeconstructionOutput

get

RandomDeconstructionOutputAmount

int Barotrauma.ItemPrefab.RandomDeconstructionOutputAmount

get

RequireBodyInsideTrigger

bool Barotrauma.ItemPrefab.RequireBodyInsideTrigger

get

RequireCampaignInteract

bool Barotrauma.ItemPrefab.RequireCampaignInteract

get

RequireCursorInsideTrigger

bool Barotrauma.ItemPrefab.RequireCursorInsideTrigger

get

ShowContentsInTooltip

bool Barotrauma.ItemPrefab.ShowContentsInTooltip

get

ShowHealthBar

bool Barotrauma.ItemPrefab.ShowHealthBar

get

ShowNameInHealthBar

bool Barotrauma.ItemPrefab.ShowNameInHealthBar

get

SignalComponentColor

Color Barotrauma.ItemPrefab.SignalComponentColor

get

Size

Vector2 Barotrauma.ItemPrefab.Size

get

SkillRequirementHints

ImmutableArray<SkillRequirementHint> Barotrauma.ItemPrefab.SkillRequirementHints

get

SonarSize

float Barotrauma.ItemPrefab.SonarSize

get

Sprite

override Sprite Barotrauma.ItemPrefab.Sprite

get

SwappableItem

SwappableItem Barotrauma.ItemPrefab.SwappableItem

get

Tags

override ImmutableHashSet<Identifier> Barotrauma.ItemPrefab.Tags

get

Triggers

ImmutableArray<Rectangle> Barotrauma.ItemPrefab.Triggers

get

Defines areas where the item can be interacted with. If RequireBodyInsideTrigger is set to true, the character has to be within the trigger to interact. If it's set to false, having the cursor within the trigger is enough.

UseContainedInventoryIconColor

bool Barotrauma.ItemPrefab.UseContainedInventoryIconColor

get

UseContainedSpriteColor

bool Barotrauma.ItemPrefab.UseContainedSpriteColor

get

UseInHealthInterface

bool Barotrauma.ItemPrefab.UseInHealthInterface

get

VariantOf

Identifier Barotrauma.ItemPrefab.VariantOf

get

---

The documentation for this class was generated from the following files:

• /home/runner/work/Luatrauma.Docs/Luatrauma.Docs/libs/LuaCsForBarotrauma/Barotrauma/BarotraumaShared/SharedSource/Items/ItemPrefab.cs
• /home/runner/work/Luatrauma.Docs/Luatrauma.Docs/libs/LuaCsForBarotrauma/Barotrauma/BarotraumaShared/SharedSource/LuaCs/Lua/LuaBarotraumaAdditions.cs