Barotrauma Client Doc
Barotrauma.Items.Components.Projectile Class Reference
Inheritance diagram for Barotrauma.Items.Components.Projectile:
Barotrauma.Items.Components.ItemComponent Barotrauma.Networking.IServerSerializable Barotrauma.Items.Components.ItemComponent Barotrauma.ISerializableEntity Barotrauma.ISerializableEntity Barotrauma.Networking.INetSerializable Barotrauma.ISerializableEntity Barotrauma.ISerializableEntity

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)
 
Returns
true if the operation was completed
More...
 
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< RelatedItemDisabledRequiredItems = new List<RelatedItem>()
 
List< SkillrequiredSkills
 
readonly ContentXElement originalElement
 
Action< bool > OnActiveStateChanged
 
List< PropertyConditionalIsActiveConditionals
 
readonly NamedEvent< ItemUseInfoOnUsed = 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)
 
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]
 
CharacterUser [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, SerializablePropertySerializableProperties [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, SerializablePropertySerializableProperties [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
 

Detailed Description

Constructor & Destructor Documentation

◆ Projectile()

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

Member Function Documentation

◆ ClientEventRead()

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

◆ Drop()

override void Barotrauma.Items.Components.Projectile.Drop ( Character  dropper,
bool  setTransform = true 
)
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.

◆ GetSpreadFromPool()

float Barotrauma.Items.Components.Projectile.GetSpreadFromPool ( )

◆ IsAttachedTo()

bool Barotrauma.Items.Components.Projectile.IsAttachedTo ( PhysicsBody  body)

◆ OnItemLoaded()

override void Barotrauma.Items.Components.Projectile.OnItemLoaded ( )
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.

◆ RemoveComponentSpecific()

override void Barotrauma.Items.Components.Projectile.RemoveComponentSpecific ( )
protectedvirtual

◆ ResetSpreadCounter()

static void Barotrauma.Items.Components.Projectile.ResetSpreadCounter ( )
static

◆ Shoot()

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 
)

◆ ShouldIgnoreSubmarineCollision()

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)

Parameters
targetFixture the projectile hit
contactContact between the projectile and the target
Returns
True if the target isn't a submarine or if the collision happened behind the launch position of the projectile

Definition at line 910 of file BarotraumaShared/SharedSource/Items/Components/Projectile.cs.

◆ Unstick()

void Barotrauma.Items.Components.Projectile.Unstick ( )

◆ Update()

override void Barotrauma.Items.Components.Projectile.Update ( float  deltaTime,
Camera  cam 
)
virtual

◆ Use() [1/2]

bool Barotrauma.Items.Components.Projectile.Use ( Character  character = null,
float  launchImpulseModifier = 0f 
)

◆ Use() [2/2]

override bool Barotrauma.Items.Components.Projectile.Use ( float  deltaTime,
Character  character = null 
)
virtual

Member Data Documentation

◆ IgnoredBodies

List<Body> Barotrauma.Items.Components.Projectile.IgnoredBodies

◆ Launcher

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.

◆ LaunchSub

Submarine Barotrauma.Items.Components.Projectile.LaunchSub

◆ WaterDragCoefficient

const float Barotrauma.Items.Components.Projectile.WaterDragCoefficient = 0.1f
static

Property Documentation

◆ Attack

Attack Barotrauma.Items.Components.Projectile.Attack
get

◆ Attacker

Character Barotrauma.Items.Components.Projectile.Attacker
getset

◆ DamageDoors

bool Barotrauma.Items.Components.Projectile.DamageDoors
getset

◆ DeactivationTime

float Barotrauma.Items.Components.Projectile.DeactivationTime
getset

◆ DoesStick

bool Barotrauma.Items.Components.Projectile.DoesStick
getset

◆ FriendlyFire

bool Barotrauma.Items.Components.Projectile.FriendlyFire
getset

◆ Hits

IEnumerable<Body> Barotrauma.Items.Components.Projectile.Hits
get

◆ Hitscan

bool Barotrauma.Items.Components.Projectile.Hitscan
getset

◆ HitScanCount

int Barotrauma.Items.Components.Projectile.HitScanCount
getset

◆ IgnoreProjectilesWhileActive

bool Barotrauma.Items.Components.Projectile.IgnoreProjectilesWhileActive
getset

◆ ImpulseSpread

float Barotrauma.Items.Components.Projectile.ImpulseSpread
getset

◆ IsStuckToTarget

bool Barotrauma.Items.Components.Projectile.IsStuckToTarget
get

◆ LaunchImpulse

float Barotrauma.Items.Components.Projectile.LaunchImpulse
getset

◆ LaunchRotation

float Barotrauma.Items.Components.Projectile.LaunchRotation
getset

◆ LaunchRotationRadians

float Barotrauma.Items.Components.Projectile.LaunchRotationRadians
get

◆ MaxJointTranslation

float Barotrauma.Items.Components.Projectile.MaxJointTranslation
getset

◆ MaxTargetsToHit

int Barotrauma.Items.Components.Projectile.MaxTargetsToHit
getset

◆ Prismatic

bool Barotrauma.Items.Components.Projectile.Prismatic
getset

◆ RemoveOnHit

bool Barotrauma.Items.Components.Projectile.RemoveOnHit
getset

◆ Spread

float Barotrauma.Items.Components.Projectile.Spread
getset

◆ SpreadCounter

byte Barotrauma.Items.Components.Projectile.SpreadCounter
staticget

◆ StaticSpread

bool Barotrauma.Items.Components.Projectile.StaticSpread
getset

◆ StickDuration

float Barotrauma.Items.Components.Projectile.StickDuration
getset

◆ StickTarget

Body Barotrauma.Items.Components.Projectile.StickTarget
get

◆ StickToCharacters

bool Barotrauma.Items.Components.Projectile.StickToCharacters
getset

◆ StickToDeflective

bool Barotrauma.Items.Components.Projectile.StickToDeflective
getset

◆ StickToDoors

bool Barotrauma.Items.Components.Projectile.StickToDoors
getset

◆ StickToItems

bool Barotrauma.Items.Components.Projectile.StickToItems
getset

◆ StickToLightTargets

bool Barotrauma.Items.Components.Projectile.StickToLightTargets
getset

◆ StickToStructures

bool Barotrauma.Items.Components.Projectile.StickToStructures
getset

◆ User

Character? Barotrauma.Items.Components.Projectile.User
getset