Inheritance diagram for Barotrauma.Items.Components.PowerContainer:

Public Member Functions
	PowerContainer (Item item, ContentXElement element)

override bool	Pick (Character picker)
	a Character has picked the item More...

override void	Update (float deltaTime, Camera cam)

override float	GetCurrentPowerConsumption (Connection connection=null)
	Returns the power consumption if checking the powerIn connection, or a negative value if the output can provide power when checking powerOut. Power consumption is proportional to set recharge speed and if there is less than max charge. More...

override PowerRange	MinMaxPowerOut (Connection connection, float load=0)
	Minimum and maximum output for the queried connection. Powerin min max equals CurrPowerConsumption as its abnormal for there to be power out. PowerOut min power out is zero and max is the maxout unless below 10% charge where the output is scaled relative to the 10% charge. More...

override float	GetConnectionPowerOut (Connection connection, float power, PowerRange minMaxPower, float load)
	Finalized power out from the container for the connection, provided the given grid information Output power based on the maxpower all batteries can output. So all batteries can equally share powerout based on their output capabilities. More...

override void	GridResolved (Connection conn)
	When the corresponding grid connection is resolved, adjust the container's charge. More...

override bool	CrewAIOperate (float deltaTime, Character character, AIObjectiveOperateItem objective)
	Returns true if the operation was completed More...

override void	ReceiveSignal (Signal signal, Connection connection)

float	GetCapacity ()

override void	OnItemLoaded ()
	Called when all the components of the item have been loaded. Use to initialize connections between components and such. More...

override void	UpdateHUDComponentSpecific (Character character, float deltaTime, Camera cam)

void	Draw (SpriteBatch spriteBatch, bool editing=false, float itemDepth=-1, Color? overrideColor=null)

void	ClientEventWrite (IWriteMessage msg, NetEntityEvent.IData extraData)

void	ClientEventRead (IReadMessage msg, float sendingTime)

Public Member Functions inherited from Barotrauma.Items.Components.Powered
	Powered (Item item, ContentXElement element)

override void	Update (float deltaTime, Camera cam)

Public Member Functions inherited from Barotrauma.Items.Components.ItemComponent
readonly record struct	ItemUseInfo (Item Item, Character User)

	ItemComponent (Item item, ContentXElement element)

void	SetRequiredItems (ContentXElement element, bool allowEmpty=false)

virtual void	Move (Vector2 amount, bool ignoreContacts=false)

virtual bool	Select (Character character)

virtual void	Drop (Character dropper, bool setTransform=true)
	a Character has dropped the item More...

virtual void	UpdateBroken (float deltaTime, Camera cam)

virtual bool	Use (float deltaTime, Character character=null)

virtual bool	SecondaryUse (float deltaTime, Character character=null)

virtual void	Equip (Character character)

virtual void	Unequip (Character character)

virtual bool	Combine (Item item, Character user)

void	Remove ()

void	ShallowRemove ()
	Remove the component so that it doesn't appear to exist in the game world (stop sounds, remove bodies etc) but don't reset anything that's required for cloning the item More...

bool	HasRequiredSkills (Character character)

bool	HasRequiredSkills (Character character, out Skill insufficientSkill)

virtual float	GetSkillMultiplier ()

float	DegreeOfSuccess (Character character)
	Returns 0.0f-1.0f based on how well the Character can use the itemcomponent More...

float	DegreeOfSuccess (Character character, List< Skill > requiredSkills)
	Returns 0.0f-1.0f based on how well the Character can use the itemcomponent More...

virtual void	FlipX (bool relativeToSub)

virtual void	FlipY (bool relativeToSub)

bool	IsEmpty (Character user)
	Shorthand for !HasRequiredContainedItems() More...

bool	HasRequiredContainedItems (Character user, bool addMessage, LocalizedString msg=null)

virtual bool	HasAccess (Character character)
	Only checks if any of the Picked requirements are matched (used for checking id card(s)). Much simpler and a bit different than HasRequiredItems. More...

virtual bool	HasRequiredItems (Character character, bool addMessage, LocalizedString msg=null)

void	ApplyStatusEffects (ActionType type, float deltaTime, Character character=null, Limb targetLimb=null, Entity useTarget=null, Character user=null, Vector2? worldPosition=null, float afflictionMultiplier=1.0f)

virtual void	Load (ContentXElement componentElement, bool usePrefabValues, IdRemap idRemap)

virtual void	OnMapLoaded ()
	Called when all items have been loaded. Use to initialize connections between items. More...

virtual void	OnScaleChanged ()

virtual void	OnInventoryChanged ()
	Called when the item has an ItemContainer and the contents inside of it changed. More...

virtual XElement	Save (XElement parentElement)

virtual void	Reset ()

virtual void	ParseMsg ()

virtual bool	ValidateEventData (NetEntityEvent.IData data)

ItemComponent	GetReplacementOrThis ()

bool	NeedsSoundUpdate ()

void	UpdateSounds ()

void	PlaySound (ActionType type, Character user=null)

void	StopLoopingSound ()

void	StopSounds (ActionType type)

virtual bool	ShouldDrawHUD (Character character)

ItemComponent	GetLinkUIToComponent ()

virtual void	DrawHUD (SpriteBatch spriteBatch, Character character)

virtual void	AddToGUIUpdateList (int order=0)

void	UpdateHUD (Character character, float deltaTime, Camera cam)

virtual void	UpdateEditing (float deltaTime)

virtual void	CreateEditingHUD (SerializableEntityEditor editor)

virtual void	OnPlayerSkillsChanged ()

virtual void	AddTooltipInfo (ref LocalizedString name, ref LocalizedString description)

Static Public Attributes
const float	aiRechargeTargetRatio = 0.5f

Static Public Attributes inherited from Barotrauma.Items.Components.Powered
static readonly HashSet< Connection >	ChangedConnections = new HashSet<Connection>()

static readonly Dictionary< int, GridInfo >	Grids = new Dictionary<int, GridInfo>()

Protected Attributes
Vector2	indicatorPosition

bool	isHorizontal

Protected Attributes inherited from Barotrauma.Items.Components.Powered
float	currPowerConsumption
	The amount of power currently consumed by the item. Negative values mean that the item is providing power to connected items More...

float	powerConsumption
	The maximum amount of power the item can draw from connected items More...

Connection	powerIn

Protected Attributes inherited from Barotrauma.Items.Components.ItemComponent
Item	item

string	name

bool	characterUsable

bool	canBePicked

bool	canBeSelected

bool	canBeCombined

bool	removeOnCombined

CoroutineHandle	delayedCorrectionCoroutine

float	aiUpdateTimer

float	correctionTimer

Properties
override PowerPriority	Priority `[get]`

float	CurrPowerOutput `[get]`

Vector2	IndicatorPosition `[get, set]`

Vector2	IndicatorSize `[get, set]`

bool	IsHorizontal `[get, set]`

float	MaxOutPut `[get, set]`

float	Capacity `[get, set]`

float	Charge `[get, set]`

float	ChargePercentage `[get]`

float	MaxRechargeSpeed `[get, set]`

float	RechargeSpeed `[get, set]`

bool	ExponentialRechargeSpeed `[get, set]`

float	Efficiency `[get, set]`

bool	FlipIndicator `[get, set]`

bool	OutputDisabled `[get]`

float	RechargeRatio `[get]`

bool	HasBeenTuned `[get]`

float	RechargeWarningIndicatorLow `[get, set]`

float	RechargeWarningIndicatorHigh `[get, set]`

Vector2	DrawSize `[get]`

Properties inherited from Barotrauma.Items.Components.Powered
static IEnumerable< Powered >	PoweredList `[get]`

virtual PowerPriority	Priority `[get]`

float?	MinVoltage `[get, set]`

float	PowerConsumption `[get, set]`

override bool	IsActive `[get, set]`

float	CurrPowerConsumption `[get, set]`

float???	Voltage `[get, set]`

float	RelativeVoltage `[get]`
	Essentially Voltage / MinVoltage (= how much of the minimum required voltage has been satisfied), clamped between 0 and 1. Can be used by status effects or sounds to check if the item has enough power to run More...

bool	PoweredByTinkering `[get, set]`

bool	VulnerableToEMP `[get, set]`

Properties inherited from Barotrauma.Items.Components.ItemComponent
ItemComponent	Parent `[get, set]`

bool	InheritParentIsActive `[get, set]`

virtual bool	DontTransferInventoryBetweenSubs `[get]`
	If enabled, the contents of the item are not transferred when the player transfers items between subs. Use this if this component uses item containers in a way where removing the item from the container via external means would cause problems. More...

virtual bool	DisallowSellingItemsFromContainer `[get]`
	If enabled, the items inside any of the item containers on this item cannot be sold at an outpost. Use in similar cases as DontTransferInventoryBetweenSubs. More...

float	PickingTime `[get, set]`

string	PickingMsg `[get, set]`

Dictionary< Identifier, SerializableProperty >	SerializableProperties `[get, protected set]`

virtual bool?	IsActive `[get, set]`

PropertyConditional.LogicalOperatorType	IsActiveConditionalComparison `[get, set]`

bool	Drawable `[get, set]`

bool	CanBePicked `[get, set]`

bool	DrawHudWhenEquipped `[get, protected set]`

bool	LockGuiFramePosition `[get, set]`

Point	GuiFrameOffset `[get, set]`

bool	CanBeSelected `[get, set]`

bool	CanBeCombined `[get, set]`

bool	RemoveOnCombined `[get, set]`

bool	CharacterUsable `[get, set]`

bool	AllowInGameEditing `[get, set]`

InputType	PickKey `[get, protected set]`

InputType	SelectKey `[get, protected set]`

bool	DeleteOnUse `[get, set]`

Item	Item `[get]`

string	Name `[get]`

string	Msg `[get, set]`

LocalizedString	DisplayMsg `[get, set]`

float	CombatPriority `[get]`

int	ManuallySelectedSound `[get]`
	Which sound should be played when manual sound selection type is selected? Not [Editable] because we don't want this visible in the editor for every component. More...

float	Speed `[get]`
	Can be used by status effects or conditionals to the speed of the item More...

virtual bool	UpdateWhenInactive `[get]`

bool	HasSounds `[get]`

bool[]	HasSoundsOfType `[get]`

virtual bool	RecreateGUIOnResolutionChange `[get]`

GUILayoutSettings	DefaultLayout `[get, protected set]`

GUILayoutSettings	AlternativeLayout `[get, protected set]`

GUIFrame	GuiFrame `[get, set]`

bool	AllowUIOverlap `[get, set]`

string	LinkUIToComponent `[get, set]`

int	HudPriority `[get]`

int	HudLayer `[get]`

bool??	UseAlternativeLayout `[get, set]`

Properties inherited from Barotrauma.ISerializableEntity
string	Name `[get]`

Dictionary< Identifier, SerializableProperty >	SerializableProperties `[get]`

Properties inherited from Barotrauma.Items.Components.IDrawableComponent
Vector2	DrawSize `[get]`
	The extents of the sprites or other graphics this component needs to draw. Used to determine which items are visible on the screen. More...

Additional Inherited Members
Static Public Member Functions inherited from Barotrauma.Items.Components.Powered
static void	UpdateGrids (bool useCache=true)
	Allocate electrical devices into their grids based on connections More...

static void	UpdatePower (float deltaTime)
	Update the power calculations of all devices and grids Updates grids in the order of ConnCurrConsumption - Get load of device/ flag it as an outputting connection – If outputting power – MinMaxPower - Minimum and Maximum power output of the connection for devices to coordinate ConnPowerOut - Final power output based on the sum of the MinMaxPower – Finally – GridResolved - Indicate that a connection's grid has been finished being calculated More...

static bool	ValidPowerConnection (Connection conn1, Connection conn2)

Static Public Member Functions inherited from Barotrauma.Items.Components.ItemComponent
static ItemComponent	Load (ContentXElement element, Item item, bool errorMessages=true)

Public Attributes inherited from Barotrauma.Items.Components.ItemComponent
bool	WasUsed

readonly Dictionary< ActionType, List< StatusEffect > >	statusEffectLists

Dictionary< RelatedItem.RelationType, List< RelatedItem > >	requiredItems

readonly List< RelatedItem >	DisabledRequiredItems = new List<RelatedItem>()

List< Skill >	requiredSkills

readonly ContentXElement	originalElement

Action< bool >	OnActiveStateChanged

List< PropertyConditional >	IsActiveConditionals

readonly NamedEvent< ItemUseInfo >	OnUsed = new()

readonly bool	InheritStatusEffects

float	IsActiveTimer

ItemComponent	ReplacedBy

Protected Member Functions inherited from Barotrauma.Items.Components.Powered
void	UpdateOnActiveEffects (float deltaTime)

float	GetAvailableInstantaneousBatteryPower ()
	Returns the amount of power that can be supplied by batteries directly connected to the item More...

IEnumerable< PowerContainer >	GetDirectlyConnectedBatteries ()

override void	RemoveComponentSpecific ()

Protected Member Functions inherited from Barotrauma.Items.Components.ItemComponent
virtual void	ShallowRemoveComponentSpecific ()

string	GetTextureDirectory (ContentXElement subElement)

T	ExtractEventData< T > (NetEntityEvent.IData data)

bool	TryExtractEventData< T > (NetEntityEvent.IData data, out T componentData)

AIObjectiveContainItem	AIContainItems< T > (ItemContainer container, Character character, AIObjective currentObjective, int itemCount, bool equip, bool removeEmpty, bool spawnItemIfNotFound=false, bool dropItemOnDeselected=false)

void	ReleaseGuiFrame ()

void	ReloadGuiFrame ()

void	TryCreateDragHandle ()

virtual void	CreateGUI ()
	Overload this method and implement. The method is automatically called when the resolution changes. More...

void	StartDelayedCorrection (IReadMessage buffer, float sendingTime, bool waitForMidRoundSync=false)

void	OnGUIParentChanged (RectTransform newParent)
	Launches when the parent of the GuiFrame is changed. More...

virtual void	OnResolutionChanged ()

Static Protected Attributes inherited from Barotrauma.Items.Components.Powered
const float	UpdateInterval = (float)Timing.Step

const float	MaxOverVoltageFactor = 2.0f
	Maximum voltage factor when the device is being overvolted. I.e. how many times more effectively the device can function when it's being overvolted More...

Static Protected Attributes inherited from Barotrauma.Items.Components.ItemComponent
const float	CorrectionDelay = 1.0f

const float	AIUpdateInterval = 0.2f

Detailed Description

Definition at line 8 of file BarotraumaShared/SharedSource/Items/Components/Power/PowerContainer.cs.

Constructor & Destructor Documentation

◆ PowerContainer()

Barotrauma.Items.Components.PowerContainer.PowerContainer	(	Item	item,
		ContentXElement	element
	)

Definition at line 150 of file BarotraumaShared/SharedSource/Items/Components/Power/PowerContainer.cs.

Member Function Documentation

◆ ClientEventRead()

void Barotrauma.Items.Components.PowerContainer.ClientEventRead	(	IReadMessage	msg,
		float	sendingTime
	)

Implements Barotrauma.Networking.IServerSerializable.

Definition at line 180 of file BarotraumaClient/ClientSource/Items/Components/Power/PowerContainer.cs.

◆ ClientEventWrite()

void Barotrauma.Items.Components.PowerContainer.ClientEventWrite	(	IWriteMessage	msg,
		NetEntityEvent.IData	extraData
	)

Implements Barotrauma.Networking.IClientSerializable.

Definition at line 175 of file BarotraumaClient/ClientSource/Items/Components/Power/PowerContainer.cs.

◆ CrewAIOperate()

override bool Barotrauma.Items.Components.PowerContainer.CrewAIOperate	(	float	deltaTime,
		Character	character,
		AIObjectiveOperateItem	objective
	)

virtual

Returns: true if the operation was completed

Reimplemented from Barotrauma.Items.Components.ItemComponent.

Definition at line 310 of file BarotraumaShared/SharedSource/Items/Components/Power/PowerContainer.cs.

◆ Draw()

void Barotrauma.Items.Components.PowerContainer.Draw	(	SpriteBatch	spriteBatch,
		bool	editing = `false`,
		float	itemDepth = `-1`,
		Color?	overrideColor = `null`
	)

Implements Barotrauma.Items.Components.IDrawableComponent.

Definition at line 134 of file BarotraumaClient/ClientSource/Items/Components/Power/PowerContainer.cs.

◆ GetCapacity()

float Barotrauma.Items.Components.PowerContainer.GetCapacity ( )

◆ GetConnectionPowerOut()

override float Barotrauma.Items.Components.PowerContainer.GetConnectionPowerOut	(	Connection	connection,
		float	power,
		PowerRange	minMaxPower,
		float	load
	)

virtual

Finalized power out from the container for the connection, provided the given grid information Output power based on the maxpower all batteries can output. So all batteries can equally share powerout based on their output capabilities.

Parameters

connection
power
minMaxPower
load

Returns

Reimplemented from Barotrauma.Items.Components.Powered.

Definition at line 279 of file BarotraumaShared/SharedSource/Items/Components/Power/PowerContainer.cs.

◆ GetCurrentPowerConsumption()

override float Barotrauma.Items.Components.PowerContainer.GetCurrentPowerConsumption ( Connection connection = null )

virtual

Returns the power consumption if checking the powerIn connection, or a negative value if the output can provide power when checking powerOut. Power consumption is proportional to set recharge speed and if there is less than max charge.

Reimplemented from Barotrauma.Items.Components.Powered.

Definition at line 199 of file BarotraumaShared/SharedSource/Items/Components/Power/PowerContainer.cs.

◆ GridResolved()

override void Barotrauma.Items.Components.PowerContainer.GridResolved ( Connection conn )

virtual

When the corresponding grid connection is resolved, adjust the container's charge.

Reimplemented from Barotrauma.Items.Components.Powered.

Definition at line 295 of file BarotraumaShared/SharedSource/Items/Components/Power/PowerContainer.cs.

◆ MinMaxPowerOut()

override PowerRange Barotrauma.Items.Components.PowerContainer.MinMaxPowerOut	(	Connection	connection,
		float	load = `0`
	)

virtual

Minimum and maximum output for the queried connection. Powerin min max equals CurrPowerConsumption as its abnormal for there to be power out. PowerOut min power out is zero and max is the maxout unless below 10% charge where the output is scaled relative to the 10% charge.

Parameters