Barotrauma Client Doc
|
Public Member Functions | |
Projectile (Item item, ContentXElement element) | |
override void | OnItemLoaded () |
Called when all the components of the item have been loaded. Use to initialize connections between components and such. More... | |
float | GetSpreadFromPool () |
void | Shoot (Character user, Vector2 weaponPos, Vector2 spawnPos, float rotation, List< Body > ignoredBodies, bool createNetworkEvent, float damageMultiplier=1f, float launchImpulseModifier=0f) |
bool | Use (Character character=null, float launchImpulseModifier=0f) |
override bool | Use (float deltaTime, Character character=null) |
override void | Drop (Character dropper, bool setTransform=true) |
a Character has dropped the item More... | |
override void | Update (float deltaTime, Camera cam) |
bool | ShouldIgnoreSubmarineCollision (Fixture target, Contact contact) |
Should the collision with the target submarine be ignored (e.g. did the projectile collide with the wall behind the turret when being launched) More... | |
bool | IsAttachedTo (PhysicsBody body) |
void | Unstick () |
void | ClientEventRead (IReadMessage msg, float sendingTime) |
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 | Pick (Character picker) |
a Character has picked the item More... | |
virtual bool | Select (Character character) |
virtual bool | CrewAIOperate (float deltaTime, Character character, AIObjectiveOperateItem objective) |
| |
virtual void | UpdateBroken (float deltaTime, Camera cam) |
virtual bool | SecondaryUse (float deltaTime, Character character=null) |
virtual void | Equip (Character character) |
virtual void | Unequip (Character character) |
virtual void | ReceiveSignal (Signal signal, Connection connection) |
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 | 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) |
Static Public Member Functions | |
static void | ResetSpreadCounter () |
Static Public Member Functions inherited from Barotrauma.Items.Components.ItemComponent | |
static ItemComponent | Load (ContentXElement element, Item item, bool errorMessages=true) |
Public Attributes | |
Submarine | LaunchSub |
List< Body > | IgnoredBodies |
Item | Launcher |
The item that launched this projectile (if any) More... | |
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 Public Attributes | |
const float | WaterDragCoefficient = 0.1f |
Protected Member Functions | |
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 () |
Properties | |
static byte | SpreadCounter [get] |
Attack | Attack [get] |
Character? | User [get, set] |
Character | Attacker [get, set] |
IEnumerable< Body > | Hits [get] |
float | LaunchImpulse [get, set] |
float | ImpulseSpread [get, set] |
float | LaunchRotation [get, set] |
float | LaunchRotationRadians [get] |
bool | DoesStick [get, set] |
bool | StickToCharacters [get, set] |
bool | StickToStructures [get, set] |
bool | StickToItems [get, set] |
bool | StickToDoors [get, set] |
bool | StickToDeflective [get, set] |
bool | StickToLightTargets [get, set] |
bool | Hitscan [get, set] |
int | HitScanCount [get, set] |
int | MaxTargetsToHit [get, set] |
bool | RemoveOnHit [get, set] |
float | Spread [get, set] |
bool | StaticSpread [get, set] |
bool | FriendlyFire [get, set] |
float | DeactivationTime [get, set] |
float | StickDuration [get, set] |
float | MaxJointTranslation [get, set] |
bool | Prismatic [get, set] |
bool | IgnoreProjectilesWhileActive [get, set] |
Body | StickTarget [get] |
bool | DamageDoors [get, set] |
bool | IsStuckToTarget [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] |
Additional Inherited Members | |
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 |
Static Protected Attributes inherited from Barotrauma.Items.Components.ItemComponent | |
const float | CorrectionDelay = 1.0f |
const float | AIUpdateInterval = 0.2f |
Definition at line 15 of file BarotraumaShared/SharedSource/Items/Components/Projectile.cs.
Barotrauma.Items.Components.Projectile.Projectile | ( | Item | item, |
ContentXElement | element | ||
) |
Definition at line 296 of file BarotraumaShared/SharedSource/Items/Components/Projectile.cs.
void Barotrauma.Items.Components.Projectile.ClientEventRead | ( | IReadMessage | msg, |
float | sendingTime | ||
) |
Implements Barotrauma.Networking.IServerSerializable.
Definition at line 14 of file BarotraumaClient/ClientSource/Items/Components/Projectile.cs.
|
virtual |
a Character has dropped the item
Reimplemented from Barotrauma.Items.Components.ItemComponent.
Definition at line 749 of file BarotraumaShared/SharedSource/Items/Components/Projectile.cs.
float Barotrauma.Items.Components.Projectile.GetSpreadFromPool | ( | ) |
Definition at line 344 of file BarotraumaShared/SharedSource/Items/Components/Projectile.cs.
bool Barotrauma.Items.Components.Projectile.IsAttachedTo | ( | PhysicsBody | body | ) |
Definition at line 1237 of file BarotraumaShared/SharedSource/Items/Components/Projectile.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 321 of file BarotraumaShared/SharedSource/Items/Components/Projectile.cs.
|
protectedvirtual |
Reimplemented from Barotrauma.Items.Components.ItemComponent.
Definition at line 1313 of file BarotraumaShared/SharedSource/Items/Components/Projectile.cs.
|
static |
Definition at line 26 of file BarotraumaShared/SharedSource/Items/Components/Projectile.cs.
void Barotrauma.Items.Components.Projectile.Shoot | ( | Character | user, |
Vector2 | weaponPos, | ||
Vector2 | spawnPos, | ||
float | rotation, | ||
List< Body > | ignoredBodies, | ||
bool | createNetworkEvent, | ||
float | damageMultiplier = 1f , |
||
float | launchImpulseModifier = 0f |
||
) |
Definition at line 376 of file BarotraumaShared/SharedSource/Items/Components/Projectile.cs.
bool Barotrauma.Items.Components.Projectile.ShouldIgnoreSubmarineCollision | ( | Fixture | target, |
Contact | contact | ||
) |
Should the collision with the target submarine be ignored (e.g. did the projectile collide with the wall behind the turret when being launched)
target | Fixture the projectile hit |
contact | Contact between the projectile and the target |
Definition at line 910 of file BarotraumaShared/SharedSource/Items/Components/Projectile.cs.
void Barotrauma.Items.Components.Projectile.Unstick | ( | ) |
Definition at line 1286 of file BarotraumaShared/SharedSource/Items/Components/Projectile.cs.
|
virtual |
Reimplemented from Barotrauma.Items.Components.ItemComponent.
Definition at line 760 of file BarotraumaShared/SharedSource/Items/Components/Projectile.cs.
bool Barotrauma.Items.Components.Projectile.Use | ( | Character | character = null , |
float | launchImpulseModifier = 0f |
||
) |
Definition at line 408 of file BarotraumaShared/SharedSource/Items/Components/Projectile.cs.
|
virtual |
Reimplemented from Barotrauma.Items.Components.ItemComponent.
List<Body> Barotrauma.Items.Components.Projectile.IgnoredBodies |
Definition at line 90 of file BarotraumaShared/SharedSource/Items/Components/Projectile.cs.
Item Barotrauma.Items.Components.Projectile.Launcher |
The item that launched this projectile (if any)
Definition at line 95 of file BarotraumaShared/SharedSource/Items/Components/Projectile.cs.
Submarine Barotrauma.Items.Components.Projectile.LaunchSub |
Definition at line 86 of file BarotraumaShared/SharedSource/Items/Components/Projectile.cs.
|
static |
Definition at line 69 of file BarotraumaShared/SharedSource/Items/Components/Projectile.cs.
|
get |
Definition at line 83 of file BarotraumaShared/SharedSource/Items/Components/Projectile.cs.
|
getset |
Definition at line 110 of file BarotraumaShared/SharedSource/Items/Components/Projectile.cs.
|
getset |
Definition at line 285 of file BarotraumaShared/SharedSource/Items/Components/Projectile.cs.
|
getset |
Definition at line 242 of file BarotraumaShared/SharedSource/Items/Components/Projectile.cs.
|
getset |
Definition at line 139 of file BarotraumaShared/SharedSource/Items/Components/Projectile.cs.
|
getset |
Definition at line 233 of file BarotraumaShared/SharedSource/Items/Components/Projectile.cs.
|
get |
Definition at line 112 of file BarotraumaShared/SharedSource/Items/Components/Projectile.cs.
|
getset |
Definition at line 189 of file BarotraumaShared/SharedSource/Items/Components/Projectile.cs.
|
getset |
Definition at line 198 of file BarotraumaShared/SharedSource/Items/Components/Projectile.cs.
|
getset |
Definition at line 272 of file BarotraumaShared/SharedSource/Items/Components/Projectile.cs.
|
getset |
Definition at line 121 of file BarotraumaShared/SharedSource/Items/Components/Projectile.cs.
|
get |
Definition at line 291 of file BarotraumaShared/SharedSource/Items/Components/Projectile.cs.
|
getset |
Definition at line 118 of file BarotraumaShared/SharedSource/Items/Components/Projectile.cs.
|
getset |
Definition at line 125 of file BarotraumaShared/SharedSource/Items/Components/Projectile.cs.
|
get |
Definition at line 131 of file BarotraumaShared/SharedSource/Items/Components/Projectile.cs.
|
getset |
Definition at line 257 of file BarotraumaShared/SharedSource/Items/Components/Projectile.cs.
|
getset |
Definition at line 205 of file BarotraumaShared/SharedSource/Items/Components/Projectile.cs.
|
getset |
Definition at line 265 of file BarotraumaShared/SharedSource/Items/Components/Projectile.cs.
|
getset |
Definition at line 212 of file BarotraumaShared/SharedSource/Items/Components/Projectile.cs.
|
getset |
Definition at line 219 of file BarotraumaShared/SharedSource/Items/Components/Projectile.cs.
|
staticget |
Definition at line 24 of file BarotraumaShared/SharedSource/Items/Components/Projectile.cs.
|
getset |
Definition at line 226 of file BarotraumaShared/SharedSource/Items/Components/Projectile.cs.
|
getset |
Definition at line 250 of file BarotraumaShared/SharedSource/Items/Components/Projectile.cs.
|
get |
Definition at line 278 of file BarotraumaShared/SharedSource/Items/Components/Projectile.cs.
|
getset |
Definition at line 146 of file BarotraumaShared/SharedSource/Items/Components/Projectile.cs.
|
getset |
Definition at line 174 of file BarotraumaShared/SharedSource/Items/Components/Projectile.cs.
|
getset |
Definition at line 167 of file BarotraumaShared/SharedSource/Items/Components/Projectile.cs.
|
getset |
Definition at line 160 of file BarotraumaShared/SharedSource/Items/Components/Projectile.cs.
|
getset |
Definition at line 181 of file BarotraumaShared/SharedSource/Items/Components/Projectile.cs.
|
getset |
Definition at line 153 of file BarotraumaShared/SharedSource/Items/Components/Projectile.cs.
|
getset |
Definition at line 100 of file BarotraumaShared/SharedSource/Items/Components/Projectile.cs.