Barotrauma Client Doc
|
Public Member Functions | |
Holdable (Item item, ContentXElement element) | |
override void | Load (ContentXElement componentElement, bool usePrefabValues, IdRemap idRemap) |
override void | Drop (Character dropper, bool setTransform=true) |
a Character has dropped the item More... | |
override void | Equip (Character character) |
override void | Unequip (Character character) |
bool | CanBeAttached (Character user) |
bool | CanBeDeattached () |
override bool | Pick (Character picker) |
a Character has picked the item More... | |
override bool | OnPicked (Character picker) |
void | AttachToWall () |
void | DeattachFromWall () |
override void | ParseMsg () |
override bool | Use (float deltaTime, Character character=null) |
override bool | SecondaryUse (float deltaTime, Character character=null) |
override void | UpdateBroken (float deltaTime, Camera cam) |
Rope | GetRope () |
override void | Update (float deltaTime, Camera cam) |
void | UpdateSwingPos (float deltaTime, out Vector2 swingPos) |
override void | ReceiveSignal (Signal signal, Connection connection) |
override void | FlipX (bool relativeToSub) |
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 | OnMapLoaded () |
Called when all items have been loaded. Use to initialize connections between items. More... | |
override XElement | Save (XElement parentElement) |
void | Draw (SpriteBatch spriteBatch, bool editing, float itemDepth=-1, Color? overrideColor=null) |
override bool | ValidateEventData (NetEntityEvent.IData data) |
void | ClientEventWrite (IWriteMessage msg, NetEntityEvent.IData extraData=null) |
override void | ClientEventRead (IReadMessage msg, float sendingTime) |
Public Member Functions inherited from Barotrauma.Items.Components.Pickable | |
Pickable (Item item, ContentXElement element) | |
override bool | Pick (Character picker) |
a Character has picked the item More... | |
virtual bool | OnPicked (Character picker, bool pickDroppedStack) |
override void | Drop (Character dropper, bool setTransform=true) |
a Character has dropped the item More... | |
virtual void | ServerEventWrite (IWriteMessage msg, Client c, NetEntityEvent.IData extraData=null) |
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 bool | CrewAIOperate (float deltaTime, Character character, AIObjectiveOperateItem objective) |
| |
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 | 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 | OnScaleChanged () |
virtual void | OnInventoryChanged () |
Called when the item has an ItemContainer and the contents inside of it changed. More... | |
virtual void | Reset () |
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 | UpdateHUDComponentSpecific (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) |
Protected Member Functions | |
bool | UsageDisabledByRangedWeapon (Character character) |
override void | RemoveComponentSpecific () |
Protected Member Functions inherited from Barotrauma.Items.Components.Pickable | |
void | StopPicking (Character picker) |
void | DropConnectedWires (Character character) |
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 () |
Protected Attributes | |
Vector2[] | handlePos |
Vector2 | holdPos |
Vector2 | aimPos |
float | holdAngle |
float | aimAngle |
Protected Attributes inherited from Barotrauma.Items.Components.Pickable | |
Character | picker |
List< InvSlotType > | allowedSlots |
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 bool | IsAttached [get] |
PhysicsBody | Pusher [get] |
bool | CanPush [get, set] |
PhysicsBody?? | Body [get] |
bool | Attached [get, set] |
bool | Aimable [get, set] |
bool | ControlPose [get, set] |
bool | UseHandRotationForHoldAngle [get, set] |
bool | Attachable [get, set] |
bool | Reattachable [get, set] |
bool | LimitedAttachable [get, set] |
bool | AttachedByDefault [get, set] |
Vector2 | HoldPos [get, set] |
Vector2 | AimPos [get, set] |
float | HoldAngle [get, set] |
float | AimAngle [get, set] |
Vector2 | SwingAmount [get, set] |
float | SwingSpeed [get, set] |
bool | SwingWhenHolding [get, set] |
bool | SwingWhenAiming [get, set] |
bool | SwingWhenUsing [get, set] |
bool | DisableHeadRotation [get, set] |
bool | DisableWhenRangedWeaponEquipped [get, set] |
float | SpriteDepthWhenDropped [get, set] |
Vector2 | DrawSize [get] |
Properties inherited from Barotrauma.Items.Components.Pickable | |
virtual bool | IsAttached [get] |
List< InvSlotType > | AllowedSlots [get] |
bool | PickingDone [get] |
Character | Picker [get] |
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.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 |
Static Protected Attributes inherited from Barotrauma.Items.Components.ItemComponent | |
const float | CorrectionDelay = 1.0f |
const float | AIUpdateInterval = 0.2f |
Definition at line 13 of file BarotraumaShared/SharedSource/Items/Components/Holdable/Holdable.cs.
Barotrauma.Items.Components.Holdable.Holdable | ( | Item | item, |
ContentXElement | element | ||
) |
Definition at line 224 of file BarotraumaShared/SharedSource/Items/Components/Holdable/Holdable.cs.
void Barotrauma.Items.Components.Holdable.AttachToWall | ( | ) |
Definition at line 597 of file BarotraumaShared/SharedSource/Items/Components/Holdable/Holdable.cs.
bool Barotrauma.Items.Components.Holdable.CanBeAttached | ( | Character | user | ) |
Definition at line 494 of file BarotraumaShared/SharedSource/Items/Components/Holdable/Holdable.cs.
bool Barotrauma.Items.Components.Holdable.CanBeDeattached | ( | ) |
Definition at line 509 of file BarotraumaShared/SharedSource/Items/Components/Holdable/Holdable.cs.
|
virtual |
Reimplemented from Barotrauma.Items.Components.Pickable.
Definition at line 86 of file BarotraumaClient/ClientSource/Items/Components/Holdable/Holdable.cs.
void Barotrauma.Items.Components.Holdable.ClientEventWrite | ( | IWriteMessage | msg, |
NetEntityEvent.IData | extraData = null |
||
) |
Implements Barotrauma.Networking.IClientSerializable.
Definition at line 75 of file BarotraumaClient/ClientSource/Items/Components/Holdable/Holdable.cs.
void Barotrauma.Items.Components.Holdable.DeattachFromWall | ( | ) |
Definition at line 660 of file BarotraumaShared/SharedSource/Items/Components/Holdable/Holdable.cs.
void Barotrauma.Items.Components.Holdable.Draw | ( | SpriteBatch | spriteBatch, |
bool | editing, | ||
float | itemDepth = -1 , |
||
Color? | overrideColor = null |
||
) |
Implements Barotrauma.Items.Components.IDrawableComponent.
Definition at line 16 of file BarotraumaClient/ClientSource/Items/Components/Holdable/Holdable.cs.
|
virtual |
a Character has dropped the item
Reimplemented from Barotrauma.Items.Components.ItemComponent.
Reimplemented in Barotrauma.Items.Components.Throwable, and Barotrauma.Items.Components.MeleeWeapon.
Definition at line 327 of file BarotraumaShared/SharedSource/Items/Components/Holdable/Holdable.cs.
|
virtual |
Reimplemented from Barotrauma.Items.Components.ItemComponent.
Reimplemented in Barotrauma.Items.Components.MeleeWeapon.
Definition at line 405 of file BarotraumaShared/SharedSource/Items/Components/Holdable/Holdable.cs.
|
virtual |
Reimplemented from Barotrauma.Items.Components.ItemComponent.
Definition at line 990 of file BarotraumaShared/SharedSource/Items/Components/Holdable/Holdable.cs.
Rope Barotrauma.Items.Components.Holdable.GetRope | ( | ) |
Definition at line 867 of file BarotraumaShared/SharedSource/Items/Components/Holdable/Holdable.cs.
|
virtual |
Reimplemented from Barotrauma.Items.Components.ItemComponent.
Definition at line 308 of file BarotraumaShared/SharedSource/Items/Components/Holdable/Holdable.cs.
|
virtual |
Called when all the components of the item have been loaded. Use to initialize connections between components and such.
Reimplemented from Barotrauma.Items.Components.ItemComponent.
Definition at line 1000 of file BarotraumaShared/SharedSource/Items/Components/Holdable/Holdable.cs.
|
virtual |
Called when all items have been loaded. Use to initialize connections between items.
Reimplemented from Barotrauma.Items.Components.ItemComponent.
Definition at line 1007 of file BarotraumaShared/SharedSource/Items/Components/Holdable/Holdable.cs.
|
virtual |
Reimplemented from Barotrauma.Items.Components.Pickable.
Definition at line 564 of file BarotraumaShared/SharedSource/Items/Components/Holdable/Holdable.cs.
|
virtual |
Reimplemented from Barotrauma.Items.Components.ItemComponent.
Definition at line 682 of file BarotraumaShared/SharedSource/Items/Components/Holdable/Holdable.cs.
|
virtual |
a Character has picked the item
Reimplemented from Barotrauma.Items.Components.ItemComponent.
Definition at line 537 of file BarotraumaShared/SharedSource/Items/Components/Holdable/Holdable.cs.
|
virtual |
Reimplemented from Barotrauma.Items.Components.ItemComponent.
Definition at line 985 of file BarotraumaShared/SharedSource/Items/Components/Holdable/Holdable.cs.
|
protectedvirtual |
Reimplemented from Barotrauma.Items.Components.ItemComponent.
Definition at line 1037 of file BarotraumaShared/SharedSource/Items/Components/Holdable/Holdable.cs.
|
virtual |
Reimplemented from Barotrauma.Items.Components.ItemComponent.
Definition at line 1049 of file BarotraumaShared/SharedSource/Items/Components/Holdable/Holdable.cs.
|
virtual |
Reimplemented from Barotrauma.Items.Components.ItemComponent.
Reimplemented in Barotrauma.Items.Components.Throwable, and Barotrauma.Items.Components.MeleeWeapon.
Definition at line 783 of file BarotraumaShared/SharedSource/Items/Components/Holdable/Holdable.cs.
|
virtual |
Reimplemented from Barotrauma.Items.Components.ItemComponent.
Definition at line 479 of file BarotraumaShared/SharedSource/Items/Components/Holdable/Holdable.cs.
|
virtual |
Reimplemented from Barotrauma.Items.Components.ItemComponent.
Reimplemented in Barotrauma.Items.Components.Throwable, and Barotrauma.Items.Components.MeleeWeapon.
Definition at line 881 of file BarotraumaShared/SharedSource/Items/Components/Holdable/Holdable.cs.
|
virtual |
Reimplemented from Barotrauma.Items.Components.ItemComponent.
Reimplemented in Barotrauma.Items.Components.Throwable, and Barotrauma.Items.Components.MeleeWeapon.
Definition at line 862 of file BarotraumaShared/SharedSource/Items/Components/Holdable/Holdable.cs.
void Barotrauma.Items.Components.Holdable.UpdateSwingPos | ( | float | deltaTime, |
out Vector2 | swingPos | ||
) |
Definition at line 958 of file BarotraumaShared/SharedSource/Items/Components/Holdable/Holdable.cs.
|
protected |
Definition at line 976 of file BarotraumaShared/SharedSource/Items/Components/Holdable/Holdable.cs.
|
virtual |
Reimplemented from Barotrauma.Items.Components.ItemComponent.
Reimplemented in Barotrauma.Items.Components.Throwable, and Barotrauma.Items.Components.MeleeWeapon.
Definition at line 691 of file BarotraumaShared/SharedSource/Items/Components/Holdable/Holdable.cs.
|
virtual |
Reimplemented from Barotrauma.Items.Components.ItemComponent.
|
protected |
Definition at line 155 of file BarotraumaShared/SharedSource/Items/Components/Holdable/Holdable.cs.
|
protected |
Definition at line 38 of file BarotraumaShared/SharedSource/Items/Components/Holdable/Holdable.cs.
|
protected |
Definition at line 28 of file BarotraumaShared/SharedSource/Items/Components/Holdable/Holdable.cs.
|
protected |
Definition at line 143 of file BarotraumaShared/SharedSource/Items/Components/Holdable/Holdable.cs.
|
protected |
Definition at line 36 of file BarotraumaShared/SharedSource/Items/Components/Holdable/Holdable.cs.
|
getset |
Definition at line 79 of file BarotraumaShared/SharedSource/Items/Components/Holdable/Holdable.cs.
|
getset |
Definition at line 161 of file BarotraumaShared/SharedSource/Items/Components/Holdable/Holdable.cs.
|
getset |
Definition at line 137 of file BarotraumaShared/SharedSource/Items/Components/Holdable/Holdable.cs.
|
getset |
Definition at line 100 of file BarotraumaShared/SharedSource/Items/Components/Holdable/Holdable.cs.
|
getset |
Definition at line 67 of file BarotraumaShared/SharedSource/Items/Components/Holdable/Holdable.cs.
|
getset |
Definition at line 121 of file BarotraumaShared/SharedSource/Items/Components/Holdable/Holdable.cs.
|
get |
Definition at line 61 of file BarotraumaShared/SharedSource/Items/Components/Holdable/Holdable.cs.
|
getset |
Definition at line 55 of file BarotraumaShared/SharedSource/Items/Components/Holdable/Holdable.cs.
|
getset |
Definition at line 86 of file BarotraumaShared/SharedSource/Items/Components/Holdable/Holdable.cs.
|
getset |
Definition at line 212 of file BarotraumaShared/SharedSource/Items/Components/Holdable/Holdable.cs.
|
getset |
Definition at line 215 of file BarotraumaShared/SharedSource/Items/Components/Holdable/Holdable.cs.
|
get |
Definition at line 11 of file BarotraumaClient/ClientSource/Items/Components/Holdable/Holdable.cs.
|
getset |
Definition at line 149 of file BarotraumaShared/SharedSource/Items/Components/Holdable/Holdable.cs.
|
getset |
Definition at line 129 of file BarotraumaShared/SharedSource/Items/Components/Holdable/Holdable.cs.
|
get |
Definition at line 44 of file BarotraumaShared/SharedSource/Items/Components/Holdable/Holdable.cs.
|
getset |
Definition at line 114 of file BarotraumaShared/SharedSource/Items/Components/Holdable/Holdable.cs.
|
get |
Definition at line 49 of file BarotraumaShared/SharedSource/Items/Components/Holdable/Holdable.cs.
|
getset |
Definition at line 107 of file BarotraumaShared/SharedSource/Items/Components/Holdable/Holdable.cs.
|
getset |
Definition at line 218 of file BarotraumaShared/SharedSource/Items/Components/Holdable/Holdable.cs.
|
getset |
Definition at line 173 of file BarotraumaShared/SharedSource/Items/Components/Holdable/Holdable.cs.
|
getset |
Definition at line 184 of file BarotraumaShared/SharedSource/Items/Components/Holdable/Holdable.cs.
|
getset |
Definition at line 198 of file BarotraumaShared/SharedSource/Items/Components/Holdable/Holdable.cs.
|
getset |
Definition at line 191 of file BarotraumaShared/SharedSource/Items/Components/Holdable/Holdable.cs.
|
getset |
Definition at line 205 of file BarotraumaShared/SharedSource/Items/Components/Holdable/Holdable.cs.
|
getset |
Definition at line 93 of file BarotraumaShared/SharedSource/Items/Components/Holdable/Holdable.cs.