Character

Barotrauma Character class with some additional functions and fields

Barotrauma source code: Character.cs

Functions

AddAbilityFlag(abilityFlag)

AddAbilityFlag

Parameters

  • abilityFlag AbilityFlags

AddActiveObjectiveEntity(entity, sprite, color)

AddActiveObjectiveEntity

Parameters

  • entity Entity

  • sprite Sprite

  • color optional Microsoft.Xna.Framework.Color

AddAttacker(character, damage)

AddAttacker

Parameters

  • character Character

  • damage number

AddDamage(attacker, worldPosition, attack, impulseDirection, deltaTime, playSound)

AddDamage

Parameters

  • attacker Character

  • worldPosition Microsoft.Xna.Framework.Vector2

  • attack Attack

  • impulseDirection Microsoft.Xna.Framework.Vector2

  • deltaTime number

  • playSound bool

Returns

  • AttackResult

AddDamage(worldPosition, afflictions, stun, playSound, attackImpulse, hitLimb, attacker, damageMultiplier)

AddDamage

Parameters

  • worldPosition Microsoft.Xna.Framework.Vector2

  • afflictions IEnumerable

  • stun number

  • playSound bool

  • attackImpulse Microsoft.Xna.Framework.Vector2

  • hitLimb Limb&

  • attacker Character

  • damageMultiplier number

Returns

  • AttackResult

AddDamage(worldPosition, afflictions, stun, playSound, attackImpulse, attacker, damageMultiplier)

AddDamage

Parameters

  • worldPosition Microsoft.Xna.Framework.Vector2

  • afflictions IEnumerable

  • stun number

  • playSound bool

  • attackImpulse optional Microsoft.Xna.Framework.Vector2

  • attacker Character

  • damageMultiplier number

Returns

  • AttackResult

AddMessage(rawText, color, playSound, identifier, value, lifetime)

AddMessage

Parameters

  • color Microsoft.Xna.Framework.Color

  • playSound bool

  • identifier Identifier

  • value optional Int32

  • lifetime number

AddToGUIUpdateList()

AddToGUIUpdateList

ApplyAttack(attacker, worldPosition, attack, deltaTime, impulseDirection, playSound, targetLimb, penetration)

ApplyAttack

Parameters

  • attacker Character

  • worldPosition Microsoft.Xna.Framework.Vector2

  • attack Attack

  • deltaTime number

  • impulseDirection Microsoft.Xna.Framework.Vector2

  • playSound bool

  • targetLimb Limb

  • penetration number

Returns

  • AttackResult

ApplyMovementLimits(targetMovement, currentSpeed)

ApplyMovementLimits

Parameters

  • targetMovement Microsoft.Xna.Framework.Vector2

  • currentSpeed number

Returns

  • Microsoft.Xna.Framework.Vector2

ApplyStatusEffects(actionType, deltaTime)

ApplyStatusEffects

Parameters

  • actionType ActionType

  • deltaTime number

ApplyTemporarySpeedLimits(speed)

ApplyTemporarySpeedLimits

Parameters

  • speed number

Returns

  • number

BreakJoints()

BreakJoints

CanAccessInventory(inventory, accessLevel)

CanAccessInventory

Parameters

  • accessLevel AccessLevel

Returns

  • bool

CanBeDraggedBy(character)

CanBeDraggedBy

Parameters

  • character Character

Returns

  • bool

CanBeHealedBy(character, checkFriendlyTeam)

CanBeHealedBy

Parameters

  • character Character

  • checkFriendlyTeam bool

Returns

  • bool

CanHearCharacter(speaker)

CanHearCharacter

Parameters

  • speaker Character

Returns

  • bool

CanInteractWith(item, distanceToItem, checkLinked)

CanInteractWith

Parameters

  • item Item

  • distanceToItem Single&

  • checkLinked bool

Returns

  • bool

CanInteractWith(c, maxDist, checkVisibility, skipDistanceCheck)

CanInteractWith

Parameters

  • c Character

  • maxDist number

  • checkVisibility bool

  • skipDistanceCheck bool

Returns

  • bool

CanInteractWith(item, checkLinked)

CanInteractWith

Parameters

  • item Item

  • checkLinked bool

Returns

  • bool

CanRunWhileDragging()

CanRunWhileDragging

Returns

  • bool

CanSeeTarget(target, seeingEntity, seeThroughWindows, checkFacing)

CanSeeTarget

Parameters

  • target ISpatialEntity

  • seeingEntity ISpatialEntity

  • seeThroughWindows bool

  • checkFacing bool

Returns

  • bool

ChangeAbilityResistance(identifier, value)

ChangeAbilityResistance

Parameters

  • identifier TalentResistanceIdentifier

  • value number

ChangeStat(statType, value)

ChangeStat

Parameters

  • statType StatTypes

  • value number

Character.AddAllToGUIUpdateList()

AddAllToGUIUpdateList

Character.Create(characterInfo, position, seed, id, isRemotePlayer, hasAi, ragdoll, spawnInitialItems)

Create

Parameters

  • characterInfo CharacterInfo

  • position Microsoft.Xna.Framework.Vector2

  • id number

  • isRemotePlayer bool

  • hasAi bool

  • ragdoll RagdollParams

  • spawnInitialItems bool

Returns

  • Character

Character.Create(speciesName, position, seed, characterInfo, id, isRemotePlayer, hasAi, createNetworkEvent, ragdoll, throwErrorIfNotFound, spawnInitialItems)

Create

Parameters

  • position Microsoft.Xna.Framework.Vector2

  • characterInfo CharacterInfo

  • id number

  • isRemotePlayer bool

  • hasAi bool

  • createNetworkEvent bool

  • ragdoll RagdollParams

  • throwErrorIfNotFound bool

  • spawnInitialItems bool

Returns

  • Character

Character.Create(prefab, position, seed, characterInfo, id, isRemotePlayer, hasAi, createNetworkEvent, ragdoll, spawnInitialItems)

Create

Parameters

  • prefab CharacterPrefab

  • position Microsoft.Xna.Framework.Vector2

  • characterInfo CharacterInfo

  • id number

  • isRemotePlayer bool

  • hasAi bool

  • createNetworkEvent bool

  • ragdoll RagdollParams

  • spawnInitialItems bool

Returns

  • Character

Character.Create(speciesName, position, seed, characterInfo, id, isRemotePlayer, hasAi, createNetworkEvent, ragdoll, throwErrorIfNotFound, spawnInitialItems)

Create

Parameters

  • speciesName Identifier

  • position Microsoft.Xna.Framework.Vector2

  • characterInfo CharacterInfo

  • id number

  • isRemotePlayer bool

  • hasAi bool

  • createNetworkEvent bool

  • ragdoll RagdollParams

  • throwErrorIfNotFound bool

  • spawnInitialItems bool

Returns

  • Character

Character.DrawSpeechBubbles(spriteBatch, cam)

DrawSpeechBubbles

Parameters

  • spriteBatch Microsoft.Xna.Framework.Graphics.SpriteBatch

  • cam Camera

Character.GetFriendlyCrew(character)

GetFriendlyCrew

Parameters

  • character Character

Returns

  • IEnumerable

Character.IsFriendly(me, other)

IsFriendly

Parameters

  • me Character

  • other Character

Returns

  • bool

Character.IsOnFriendlyTeam(me, other)

IsOnFriendlyTeam

Parameters

  • me Character

  • other Character

Returns

  • bool

Character.IsOnFriendlyTeam(myTeam, otherTeam)

IsOnFriendlyTeam

Parameters

  • myTeam CharacterTeamType

  • otherTeam CharacterTeamType

Returns

  • bool

Character.IsSameSpeciesOrGroup(me, other)

IsSameSpeciesOrGroup

Parameters

  • me Character

  • other Character

Returns

  • bool

Character.IsTargetVisible(target, seeingEntity, seeThroughWindows, checkFacing)

IsTargetVisible

Parameters

  • target ISpatialEntity

  • seeingEntity ISpatialEntity

  • seeThroughWindows bool

  • checkFacing bool

Returns

  • bool

Character.ReadSpawnData(inc)

ReadSpawnData

Parameters

  • inc Networking.IReadMessage

Returns

  • Character

Character.RemoveByPrefab(prefab)

RemoveByPrefab

Parameters

  • prefab CharacterPrefab

Character.SaveInventory(inventory, parentElement)

SaveInventory

Parameters

  • parentElement Xml.Linq.XElement

Character.UpdateAll(deltaTime, cam)

UpdateAll

Parameters

  • deltaTime number

  • cam Camera

Character.UpdateAnimAll(deltaTime)

UpdateAnimAll

Parameters

  • deltaTime number

CheckTalents(abilityEffectType, abilityObject)

CheckTalents

Parameters

  • abilityEffectType AbilityEffectType

  • abilityObject Abilities.AbilityObject

CheckTalents(abilityEffectType)

CheckTalents

Parameters

  • abilityEffectType AbilityEffectType

ClearInput(inputType)

ClearInput

Parameters

  • inputType InputType

ClearInputs()

ClearInputs

ClientEventRead(msg, sendingTime)

ClientEventRead

Parameters

  • msg Networking.IReadMessage

  • sendingTime number

ClientEventWrite(msg, extraData)

ClientEventWrite

Parameters

  • msg Networking.IWriteMessage

  • extraData Networking.IData

ClientReadPosition(msg, sendingTime)

ClientReadPosition

Parameters

  • msg Networking.IReadMessage

  • sendingTime number

ClientWriteInput(segmentTableWriter, msg)

ClientWriteInput

Parameters

  • segmentTableWriter Networking.SegmentTableWriter`1&

  • msg Networking.IWriteMessage

Control(deltaTime, cam)

Control

Parameters

  • deltaTime number

  • cam Camera

ControlLocalPlayer(deltaTime, cam, moveCam)

ControlLocalPlayer

Parameters

  • deltaTime number

  • cam Camera

  • moveCam bool

DamageLimb(worldPosition, hitLimb, afflictions, stun, playSound, attackImpulse, attacker, damageMultiplier, allowStacking, penetration, shouldImplode, ignoreDamageOverlay, recalculateVitality)

DamageLimb

Parameters

  • worldPosition Microsoft.Xna.Framework.Vector2

  • hitLimb Limb

  • afflictions IEnumerable

  • stun number

  • playSound bool

  • attackImpulse Microsoft.Xna.Framework.Vector2

  • attacker Character

  • damageMultiplier number

  • allowStacking bool

  • penetration number

  • shouldImplode bool

  • ignoreDamageOverlay bool

  • recalculateVitality bool

Returns

  • AttackResult

DeselectCharacter()

DeselectCharacter

DespawnNow(createNetworkEvents)

DespawnNow

Parameters

  • createNetworkEvents bool

DisableLine(identifier)

DisableLine

Parameters

DisableLine(identifier)

DisableLine

Parameters

  • identifier Identifier

DoInteractionUpdate(deltaTime, mouseSimPos)

DoInteractionUpdate

Parameters

  • deltaTime number

  • mouseSimPos Microsoft.Xna.Framework.Vector2

DoVisibilityCheck(cam)

DoVisibilityCheck

Parameters

  • cam Camera

Draw(spriteBatch, cam)

Draw

Parameters

  • spriteBatch Microsoft.Xna.Framework.Graphics.SpriteBatch

  • cam Camera

DrawFront(spriteBatch, cam)

DrawFront

Parameters

  • spriteBatch Microsoft.Xna.Framework.Graphics.SpriteBatch

  • cam Camera

DrawGUIMessages(spriteBatch, cam)

DrawGUIMessages

Parameters

  • spriteBatch Microsoft.Xna.Framework.Graphics.SpriteBatch

  • cam Camera

DrawHUD(spriteBatch, cam, drawHealth)

DrawHUD

Parameters

  • spriteBatch Microsoft.Xna.Framework.Graphics.SpriteBatch

  • cam Camera

  • drawHealth bool

EmulateInput(input)

EmulateInput

Parameters

  • input InputType

Equals(obj)

Equals

Parameters

  • obj Object

Returns

  • bool

EvaluatePlayDeadProbability(probability)

EvaluatePlayDeadProbability

Parameters

  • probability optional Single

FindClosestItem(itemCollection, simPosition, aimAssistModifier)

FindClosestItem

Parameters

  • simPosition Microsoft.Xna.Framework.Vector2

  • aimAssistModifier number

Returns

  • Item

FindItem(itemIndex, targetItem, identifiers, ignoreBroken, ignoredItems, ignoredContainerIdentifiers, customPredicate, customPriorityFunction, maxItemDistance, positionalReference)

FindItem

Parameters

  • itemIndex Int32&

  • targetItem Item&

  • identifiers IEnumerable

  • ignoreBroken bool

  • ignoredItems IEnumerable

  • ignoredContainerIdentifiers IEnumerable

  • customPredicate function

  • customPriorityFunction function

  • maxItemDistance number

  • positionalReference ISpatialEntity

Returns

  • bool

ForgiveAttacker(character)

ForgiveAttacker

Parameters

  • character Character

FreeID()

FreeID

GetAbilityResistance(resistanceId)

GetAbilityResistance

Parameters

  • resistanceId Identifier

Returns

  • number

GetAbilityResistance(affliction)

GetAbilityResistance

Parameters

  • affliction AfflictionPrefab

Returns

  • number

GetAttackContexts()

GetAttackContexts

Returns

  • IEnumerable

GetBaseCharacterSpeciesName()

GetBaseCharacterSpeciesName

Returns

  • Identifier

GetCurrentOrder(order)

GetCurrentOrder

Parameters

  • order Order

Returns

  • Order

GetCurrentOrderWithTopPriority()

GetCurrentOrderWithTopPriority

Returns

  • Order

GetDamageDoneByAttacker(otherCharacter)

GetDamageDoneByAttacker

Parameters

  • otherCharacter Character

Returns

  • number

GetDistanceToClosestLimb(simPos)

GetDistanceToClosestLimb

Parameters

  • simPos Microsoft.Xna.Framework.Vector2

Returns

  • number

GetEquippedItem(tagOrIdentifier, slotType)

GetEquippedItem

Parameters

  • tagOrIdentifier Identifier

  • slotType optional InvSlotType

Returns

  • Item

GetHashCode()

GetHashCode

Returns

  • number

GetLeftHandPenalty()

GetLeftHandPenalty

Returns

  • number

GetLegPenalty(startSum)

GetLegPenalty

Parameters

  • startSum number

Returns

  • number

GetNameColor()

GetNameColor

Returns

  • Microsoft.Xna.Framework.Color

GetPositionUpdateInterval(recipient)

GetPositionUpdateInterval

Parameters

  • recipient Networking.Client

Returns

  • number

GetRelativeSimPosition(target, worldPos)

GetRelativeSimPosition

Parameters

  • target ISpatialEntity

  • worldPos optional Microsoft.Xna.Framework.Vector2

Returns

  • Microsoft.Xna.Framework.Vector2

GetRightHandPenalty()

GetRightHandPenalty

Returns

  • number

GetSkillLevel(skillIdentifier)

GetSkillLevel

Parameters

  • skillIdentifier Identifier

Returns

  • number

GetSound(predicate, random)

GetSound

Parameters

  • predicate function

  • random bool

Returns

  • CharacterSound

GetStatValue(statType, includeSaved)

GetStatValue

Parameters

  • statType StatTypes

  • includeSaved bool

Returns

  • number

GetTargetMovement()

GetTargetMovement

Returns

  • Microsoft.Xna.Framework.Vector2

GetTemporarySpeedReduction()

GetTemporarySpeedReduction

Returns

  • number

GetType()

GetType

Returns

  • Type

GetVisibleHulls()

GetVisibleHulls

Returns

GiveIdCardTags(spawnPoint, createNetworkEvent)

GiveIdCardTags

Parameters

  • spawnPoint WayPoint

  • createNetworkEvent bool

GiveJobItems(isPvPMode, spawnPoint)

GiveJobItems

Parameters

  • isPvPMode bool

  • spawnPoint WayPoint

GiveMoney(amount)

GiveMoney

Parameters

  • amount number

GiveTalent(talentPrefab, addingFirstTime)

GiveTalent

Parameters

  • talentPrefab TalentPrefab

  • addingFirstTime bool

Returns

  • bool

GiveTalent(talentIdentifier, addingFirstTime)

GiveTalent

Parameters

  • talentIdentifier Identifier

  • addingFirstTime bool

Returns

  • bool

GiveTalent(talentIdentifier, addingFirstTime)

GiveTalent

Parameters

  • talentIdentifier number

  • addingFirstTime bool

Returns

  • bool

HasAbilityFlag(abilityFlag)

HasAbilityFlag

Parameters

  • abilityFlag AbilityFlags

Returns

  • bool

HasEquippedItem(tagOrIdentifier, allowBroken, slotType)

HasEquippedItem

Parameters

  • tagOrIdentifier Identifier

  • allowBroken bool

  • slotType optional InvSlotType

Returns

  • bool

HasEquippedItem(item, slotType, predicate)

HasEquippedItem

Parameters

  • item Item

  • slotType optional InvSlotType

  • predicate function

Returns

  • bool

HasHandsFull(items)

HasHandsFull

Parameters

  • items ValueTuple`2&

Returns

  • bool

HasItem(item, requireEquipped, slotType)

HasItem

Parameters

  • item Item

  • requireEquipped bool

  • slotType optional InvSlotType

Returns

  • bool

HasJob(identifier)

HasJob

Parameters

Returns

  • bool

HasJob(identifier)

HasJob

Parameters

  • identifier Identifier

Returns

  • bool

HasRecipeForItem(recipeIdentifier)

HasRecipeForItem

Parameters

  • recipeIdentifier Identifier

Returns

  • bool

HasSelectedAnotherSecondaryItem(item)

HasSelectedAnotherSecondaryItem

Parameters

  • item Item

Returns

  • bool

HasStoreAccessForItem(prefab)

HasStoreAccessForItem

Parameters

  • prefab ItemPrefab

Returns

  • bool

HasTalent(identifier)

HasTalent

Parameters

  • identifier Identifier

Returns

  • bool

HasTalents()

HasTalents

Returns

  • bool

HasTeamChange(identifier)

HasTeamChange

Parameters

Returns

  • bool

HasUnlockedAllTalents()

HasUnlockedAllTalents

Returns

  • bool

IsAnySelectedItem(item)

IsAnySelectedItem

Parameters

  • item Item

Returns

  • bool

IsClientOwner(client)

IsClientOwner

Parameters

  • client Networking.Client

Returns

  • bool

IsDualWieldingRangedWeapons()

IsDualWieldingRangedWeapons

Returns

  • bool

IsFacing(targetWorldPos)

IsFacing

Parameters

  • targetWorldPos Microsoft.Xna.Framework.Vector2

Returns

  • bool

IsFriendly(other)

IsFriendly

Parameters

  • other Character

Returns

  • bool

IsInSameRoomAs(character)

IsInSameRoomAs

Parameters

  • character Character

Returns

  • bool

IsInventoryAccessibleTo(character, accessLevel)

IsInventoryAccessibleTo

Parameters

  • character Character

  • accessLevel AccessLevel

Returns

  • bool

IsItemTakenBySomeoneElse(item)

IsItemTakenBySomeoneElse

Parameters

  • item Item

Returns

  • bool

IsKeyDown(inputType)

IsKeyDown

Parameters

  • inputType InputType

Returns

  • bool

IsKeyHit(inputType)

IsKeyHit

Parameters

  • inputType InputType

Returns

  • bool

IsOnFriendlyTeam(otherTeam)

IsOnFriendlyTeam

Parameters

  • otherTeam CharacterTeamType

Returns

  • bool

IsOnFriendlyTeam(other)

IsOnFriendlyTeam

Parameters

  • other Character

Returns

  • bool

IsSameSpeciesOrGroup(other)

IsSameSpeciesOrGroup

Parameters

  • other Character

Returns

  • bool

Kill(causeOfDeath, causeOfDeathAffliction, isNetworkMessage, log)

Kill

Parameters

  • causeOfDeath CauseOfDeathType

  • causeOfDeathAffliction Affliction

  • isNetworkMessage bool

  • log bool

LoadHeadAttachments()

LoadHeadAttachments

LoadTalents()

LoadTalents

MatchesSpeciesNameOrGroup(speciesNameOrGroup)

MatchesSpeciesNameOrGroup

Parameters

  • speciesNameOrGroup Identifier

Returns

  • bool

OnWearablesChanged()

OnWearablesChanged

PlaySound(soundType, soundIntervalFactor, maxInterval)

PlaySound

Parameters

  • soundType SoundType

  • soundIntervalFactor number

  • maxInterval number

RecordKill(target)

RecordKill

Parameters

  • target Character

ReleaseSecondaryItem()

ReleaseSecondaryItem

ReloadHead(headId, hairIndex, beardIndex, moustacheIndex, faceAttachmentIndex)

ReloadHead

Parameters

  • headId optional Int32

  • hairIndex number

  • beardIndex number

  • moustacheIndex number

  • faceAttachmentIndex number

Remove()

Remove

RemoveAbilityFlag(abilityFlag)

RemoveAbilityFlag

Parameters

  • abilityFlag AbilityFlags

RemoveAbilityResistance(identifier)

RemoveAbilityResistance

Parameters

  • identifier TalentResistanceIdentifier

RemoveActiveObjectiveEntity(entity)

RemoveActiveObjectiveEntity

Parameters

  • entity Entity

ResetNetState()

ResetNetState

ResetSpeedMultiplier()

ResetSpeedMultiplier

ResetTalents(applyXpPenalty)

ResetTalents

Parameters

  • applyXpPenalty bool

Revive(removeAfflictions, createNetworkEvent)

Revive

Parameters

  • removeAfflictions bool

  • createNetworkEvent bool

SaveInventory()

SaveInventory

SelectCharacter(character)

SelectCharacter

Parameters

  • character Character

ServerEventRead(msg, c)

ServerEventRead

Parameters

  • msg Networking.IReadMessage

  • c Networking.Client

ServerEventWrite(msg, c, extraData)

ServerEventWrite

Parameters

  • msg Networking.IWriteMessage

  • c Networking.Client

  • extraData Networking.IData

ServerReadInput(msg, c)

ServerReadInput

Parameters

  • msg Networking.IReadMessage

  • c Networking.Client

ServerWritePosition(tempBuffer, c)

ServerWritePosition

Parameters

  • tempBuffer Networking.ReadWriteMessage

  • c Networking.Client

SetAllDamage(damageAmount, bleedingDamageAmount, burnDamageAmount)

SetAllDamage

Parameters

  • damageAmount number

  • bleedingDamageAmount number

  • burnDamageAmount number

SetAttackTarget(attackLimb, damageTarget, attackPos)

SetAttackTarget

Parameters

  • attackLimb Limb

  • damageTarget IDamageable

  • attackPos Microsoft.Xna.Framework.Vector2

SetCustomInteract(onCustomInteract, hudText)

SetCustomInteract

Parameters

  • onCustomInteract function

  • hudText LocalizedString

SetInput(inputType, hit, held)

SetInput

Parameters

  • inputType InputType

  • hit bool

  • held bool

SetMoney(amount)

SetMoney

Parameters

  • amount number

SetOrder(order, isNewOrder, speak, force)

SetOrder

Parameters

  • order Order

  • isNewOrder bool

  • speak bool

  • force bool

SetOriginalTeamAndChangeTeam(newTeam, processImmediately)

SetOriginalTeamAndChangeTeam

Parameters

  • newTeam CharacterTeamType

  • processImmediately bool

SetOwnerClient(client)

SetOwnerClient

Parameters

  • client Networking.Client

SetStun(newStun, allowStunDecrease, isNetworkMessage)

SetStun

Parameters

  • newStun number

  • allowStunDecrease bool

  • isNetworkMessage bool

ShouldLockHud()

ShouldLockHud

Returns

  • bool

ShowSpeechBubble(color, text)

ShowSpeechBubble

Parameters

  • color Microsoft.Xna.Framework.Color

ShowTextlessSpeechBubble(duration, color)

ShowTextlessSpeechBubble

Parameters

  • duration number

  • color Microsoft.Xna.Framework.Color

SpawnInventoryItems(inventory, itemData)

SpawnInventoryItems

Parameters

  • itemData ContentXElement

Speak(message, messageType, delay, identifier, minDurationBetweenSimilar)

Speak

Parameters

  • messageType optional Networking.ChatMessageType

  • delay number

  • identifier Identifier

  • minDurationBetweenSimilar number

StackHealthMultiplier(val)

StackHealthMultiplier

Parameters

  • val number

StackSpeedMultiplier(val)

StackSpeedMultiplier

Parameters

  • val number

StopClimbing()

StopClimbing

TeleportTo(worldPos)

TeleportTo

Parameters

  • worldPos Microsoft.Xna.Framework.Vector2

ToString()

ToString

Returns

TryAddNewTeamChange(identifier, newTeamChange)

TryAddNewTeamChange

Parameters

  • newTeamChange ActiveTeamChange

Returns

  • bool

TryAdjustAttackerSkill(attacker, attackResult)

TryAdjustAttackerSkill

Parameters

  • attacker Character

  • attackResult AttackResult

TryAdjustHealerSkill(healer, healthChange, affliction)

TryAdjustHealerSkill

Parameters

  • healer Character

  • healthChange number

  • affliction Affliction

TryPutItem(item, allowedSlots)

TryPutItem

Parameters

  • item Item

  • allowedSlots IEnumerable

Returns

  • bool

TryPutItemInAnySlot(item)

TryPutItemInAnySlot

Parameters

  • item Item

Returns

  • bool

TryPutItemInBag(item)

TryPutItemInBag

Parameters

  • item Item

Returns

  • bool

TryRemoveTeamChange(identifier)

TryRemoveTeamChange

Parameters

Returns

  • bool

TrySeverLimbJoints(targetLimb, severLimbsProbability, damage, allowBeheading, ignoreSeveranceProbabilityModifier, attacker)

TrySeverLimbJoints

Parameters

  • targetLimb Limb

  • severLimbsProbability number

  • damage number

  • allowBeheading bool

  • ignoreSeveranceProbabilityModifier bool

  • attacker Character

TurnIntoHusk(huskInfection, playDead)

TurnIntoHusk

Parameters

  • huskInfection AfflictionPrefabHusk

  • playDead optional bool

Unequip(item)

Unequip

Parameters

  • item Item

Returns

  • bool

Update(deltaTime, cam)

Update

Parameters

  • deltaTime number

  • cam Camera

UpdateHUDProgressBar(linkedObject, worldPosition, progress, emptyColor, fullColor, textTag)

UpdateHUDProgressBar

Parameters

  • linkedObject Object

  • worldPosition Microsoft.Xna.Framework.Vector2

  • progress number

  • emptyColor Microsoft.Xna.Framework.Color

  • fullColor Microsoft.Xna.Framework.Color

Returns

  • HUDProgressBar

UpdateLocalCursor(cam)

UpdateLocalCursor

Parameters

  • cam Camera

UpdateTeam()

UpdateTeam

WriteSpawnData(msg, entityId, restrictMessageSize)

WriteSpawnData

Parameters

  • msg Networking.IWriteMessage

  • entityId number

  • restrictMessageSize bool

Fields

AIController

AIController, field of type AIController

  • AIController

AIState

AIState, field of type AIState

  • AIState

AITurretPriority

AITurretPriority, field of type number

  • AITurretPriority

ActiveConversation

ActiveConversation, field of type ConversationAction

  • ActiveConversation

ActiveObjectiveEntities

ActiveObjectiveEntities, field of type IEnumerable

  • ActiveObjectiveEntities

AiTarget

AiTarget, field of type AITarget

  • AiTarget

AimRefPosition

AimRefPosition, field of type Microsoft.Xna.Framework.Vector2

  • AimRefPosition

AllowCustomInteract

AllowCustomInteract, field of type bool

  • AllowCustomInteract

AllowInput

AllowInput, field of type bool

  • AllowInput

AllowPlayDead

AllowPlayDead, field of type bool

  • AllowPlayDead

Anim

Anim, field of type Animation

  • Anim

AnimController

AnimController, field of type AnimController

  • AnimController

AttachedProjectiles

AttachedProjectiles, field of type HashSet

  • AttachedProjectiles

Bleeding

Bleeding, field of type number

  • Bleeding

BloodDecalName

BloodDecalName, field of type string

  • BloodDecalName

BloodEmitters

BloodEmitters, field of type IEnumerable

  • BloodEmitters

Bloodloss

Bloodloss, field of type number

  • Bloodloss

BlurStrength

BlurStrength, field of type number

  • BlurStrength

CameraShake

CameraShake, field of type number

  • CameraShake

CampaignInteractionType

CampaignInteractionType, field of type InteractionType

  • CampaignInteractionType

CanAim

CanAim, field of type bool

  • CanAim

CanBeSelected

CanBeSelected, field of type bool

  • CanBeSelected

CanClimb

CanClimb, field of type bool

  • CanClimb

CanEat

CanEat, field of type bool

  • CanEat

CanInteract

CanInteract, field of type bool

  • CanInteract

CanMove

CanMove, field of type bool

  • CanMove

CanRun

CanRun, field of type bool

  • CanRun

CanSpeak

CanSpeak, field of type bool

  • CanSpeak

CauseOfDeath

CauseOfDeath, field of type CauseOfDeath

  • CauseOfDeath

Character.CharacterList

Character.CharacterList, Table containing all characters.

Character.CharacterUpdateInterval

Character.CharacterUpdateInterval, field of type number

Character.Controlled

Character.Controlled, field of type Character

Character.DebugDrawInteract

Character.DebugDrawInteract, field of type bool

Character.DisableControls

Character.DisableControls, field of type bool

Character.IsMouseOnUI

Character.IsMouseOnUI, field of type bool

Character.KnockbackCooldown

Character.KnockbackCooldown, field of type number

Character.MaxDragDistance

Character.MaxDragDistance, field of type number

Character.MaxHighlightDistance

Character.MaxHighlightDistance, field of type number

CharacterHealth

CharacterHealth, field of type CharacterHealth

  • CharacterHealth

CharacterTalents

CharacterTalents, field of type IReadOnlyCollection

  • CharacterTalents

ChromaticAberrationStrength

ChromaticAberrationStrength, field of type number

  • ChromaticAberrationStrength

ClientDisconnected

ClientDisconnected, field of type bool

  • ClientDisconnected

CollapseEffectStrength

CollapseEffectStrength, field of type number

  • CollapseEffectStrength

CombatAction

CombatAction, field of type CombatAction

  • CombatAction

ConfigPath

ConfigPath, field of type string

  • ConfigPath

CreationIndex

CreationIndex, field of type number

  • CreationIndex

CreationStackTrace

CreationStackTrace, field of type string

  • CreationStackTrace

CurrentHull

CurrentHull, field of type Hull

  • CurrentHull

CurrentOrders

CurrentOrders, field of type table

  • CurrentOrders

CurrentSpeed

CurrentSpeed, field of type number

  • CurrentSpeed

CursorPosition

CursorPosition, field of type Microsoft.Xna.Framework.Vector2

  • CursorPosition

CursorWorldPosition

CursorWorldPosition, field of type Microsoft.Xna.Framework.Vector2

  • CursorWorldPosition

CustomInteractHUDText

CustomInteractHUDText, field of type LocalizedString

  • CustomInteractHUDText

DamageEmitters

DamageEmitters, field of type IEnumerable

  • DamageEmitters

DisableFocusingOnEntities

DisableFocusingOnEntities, field of type bool

  • DisableFocusingOnEntities

DisableHealthWindow

DisableHealthWindow, field of type bool

  • DisableHealthWindow

DisableImpactDamageTimer

DisableImpactDamageTimer, field of type number

  • DisableImpactDamageTimer

DisableInteract

DisableInteract, field of type bool

  • DisableInteract

DisableRunning

DisableRunning, field of type bool

  • DisableRunning

DisabledByEvent

DisabledByEvent, field of type bool

  • DisabledByEvent

DisplayName

DisplayName, field of type string

  • DisplayName

DistortStrength

DistortStrength, field of type number

  • DistortStrength

DoesBleed

DoesBleed, field of type bool

  • DoesBleed

DrawPosition

DrawPosition, field of type Microsoft.Xna.Framework.Vector2

  • DrawPosition

EmpVulnerability

EmpVulnerability, field of type number

  • EmpVulnerability

EnableDespawn

EnableDespawn, field of type bool

  • EnableDespawn

Enabled

Enabled, field of type bool

  • Enabled

ErrorLine

ErrorLine, field of type string

  • ErrorLine

ExternalHighlight

ExternalHighlight, field of type bool

  • ExternalHighlight

Faction

Faction, field of type Identifier

  • Faction

FocusedCharacter

FocusedCharacter, field of type Character

  • FocusedCharacter

FocusedItem

FocusedItem, field of type Item

  • FocusedItem

FollowCursor

FollowCursor, field of type bool

  • FollowCursor

ForceRun

ForceRun, field of type bool

  • ForceRun

GibEmitters

GibEmitters, field of type IEnumerable

  • GibEmitters

GodMode

GodMode, field of type bool

  • GodMode

GrainColor

GrainColor, field of type Microsoft.Xna.Framework.Color

  • GrainColor

GrainStrength

GrainStrength, field of type number

  • GrainStrength

Group

Group, field of type Identifier

  • Group

HUDProgressBars

HUDProgressBars, field of type table

  • HUDProgressBars

HasSelectedAnyItem

HasSelectedAnyItem, field of type bool

  • HasSelectedAnyItem

Health

Health, field of type number

  • Health

HealthMultiplier

HealthMultiplier, field of type number

  • HealthMultiplier

HealthPercentage

HealthPercentage, field of type number

  • HealthPercentage

HealthUpdateInterval

HealthUpdateInterval, field of type number

  • HealthUpdateInterval

HealthUpdatePending

HealthUpdatePending, field of type bool

  • HealthUpdatePending

HeldItems

HeldItems, field of type IEnumerable

  • HeldItems

HideFace

HideFace, field of type bool

  • HideFace

HullOxygenPercentage

HullOxygenPercentage, field of type number

  • HullOxygenPercentage

HumanPrefab

HumanPrefab, field of type HumanPrefab

  • HumanPrefab

HumanPrefabHealthMultiplier

HumanPrefabHealthMultiplier, field of type number

  • HumanPrefabHealthMultiplier

ID

ID, field of type number

  • ID

IdFreed

IdFreed, field of type bool

  • IdFreed

IgnoreMeleeWeapons

IgnoreMeleeWeapons, field of type bool

  • IgnoreMeleeWeapons

InDetectable

InDetectable, field of type bool

  • InDetectable

InPressure

InPressure, field of type bool

  • InPressure

InWater

InWater, field of type bool

  • InWater

Info

Info, field of type CharacterInfo

  • Info

Inventory

Inventory, field of type CharacterInventory

  • Inventory

InvisibleTimer

InvisibleTimer, field of type number

  • InvisibleTimer

IsAssistant

IsAssistant, field of type bool

  • IsAssistant

IsBot

IsBot, field of type bool

  • IsBot

IsCaptain

IsCaptain, field of type bool

  • IsCaptain

IsClimbing

IsClimbing, field of type bool

  • IsClimbing

IsCommanding

IsCommanding, field of type bool

  • IsCommanding

IsCriminal

IsCriminal, field of type bool

  • IsCriminal

IsDead

IsDead, field of type bool

  • IsDead

IsDisguisedAsHusk

IsDisguisedAsHusk, field of type bool

  • IsDisguisedAsHusk

IsDismissed

IsDismissed, field of type bool

  • IsDismissed

IsDraggable

IsDraggable, field of type bool

  • IsDraggable

IsEngineer

IsEngineer, field of type bool

  • IsEngineer

IsEscorted

IsEscorted, field of type bool

  • IsEscorted

IsFemale

IsFemale, field of type bool

  • IsFemale

IsFlipped

IsFlipped, field of type bool

  • IsFlipped

IsForceRagdolled

IsForceRagdolled, field of type bool

  • IsForceRagdolled

IsFriendlyNPCTurnedHostile

IsFriendlyNPCTurnedHostile, field of type bool

  • IsFriendlyNPCTurnedHostile

IsHandcuffed

IsHandcuffed, field of type bool

  • IsHandcuffed

IsHostileEscortee

IsHostileEscortee, field of type bool

  • IsHostileEscortee

IsHuman

IsHuman, field of type bool

  • IsHuman

IsHumanoid

IsHumanoid, field of type bool

  • IsHumanoid

IsHusk

IsHusk, field of type bool

  • IsHusk

IsHuskInfected

IsHuskInfected, field of type bool

  • IsHuskInfected

IsImmuneToPressure

IsImmuneToPressure, field of type bool

  • IsImmuneToPressure

IsInFriendlySub

IsInFriendlySub, field of type bool

  • IsInFriendlySub

IsInPlayerSub

IsInPlayerSub, field of type bool

  • IsInPlayerSub

IsIncapacitated

IsIncapacitated, field of type bool

  • IsIncapacitated

IsInstigator

IsInstigator, field of type bool

  • IsInstigator

IsKiller

IsKiller, field of type bool

  • IsKiller

IsKnockedDown

IsKnockedDown, field of type bool

  • IsKnockedDown

IsLatched

IsLatched, field of type bool

  • IsLatched

IsLocalPlayer

IsLocalPlayer, field of type bool

  • IsLocalPlayer

IsLowInOxygen

IsLowInOxygen, field of type bool

  • IsLowInOxygen

IsMachine

IsMachine, field of type bool

  • IsMachine

IsMale

IsMale, field of type bool

  • IsMale

IsMechanic

IsMechanic, field of type bool

  • IsMechanic

IsMedic

IsMedic, field of type bool

  • IsMedic

IsOnPlayerTeam

IsOnPlayerTeam, field of type bool

  • IsOnPlayerTeam

IsOriginallyOnPlayerTeam

IsOriginallyOnPlayerTeam, field of type bool

  • IsOriginallyOnPlayerTeam

IsPet

IsPet, field of type bool

  • IsPet

IsPlayer

IsPlayer, field of type bool

  • IsPlayer

IsPrisoner

IsPrisoner, field of type bool

  • IsPrisoner

IsProtectedFromPressure

IsProtectedFromPressure, field of type bool

  • IsProtectedFromPressure

IsRagdolled

IsRagdolled, field of type bool

  • IsRagdolled

IsRemotePlayer

IsRemotePlayer, field of type bool

  • IsRemotePlayer

IsRemotelyControlled

IsRemotelyControlled, field of type bool

  • IsRemotelyControlled

IsSecurity

IsSecurity, field of type bool

  • IsSecurity

IsTraitor

IsTraitor, field of type bool

  • IsTraitor

IsUnconscious

IsUnconscious, field of type bool

  • IsUnconscious

IsVip

IsVip, field of type bool

  • IsVip

IsVisible

IsVisible, field of type bool

  • IsVisible

IsWatchman

IsWatchman, field of type bool

  • IsWatchman

ItemSelectedDurations

ItemSelectedDurations, field of type table

  • ItemSelectedDurations

JobIdentifier

JobIdentifier, field of type Identifier

  • JobIdentifier

Keys

Keys, field of type Key[]

  • Keys

KillDisconnectedTimer

KillDisconnectedTimer, field of type number

  • KillDisconnectedTimer

KnockbackCooldownTimer

KnockbackCooldownTimer, field of type number

  • KnockbackCooldownTimer

LastAttacker

LastAttacker, field of type Character

  • LastAttacker

LastAttackers

LastAttackers, field of type IEnumerable

  • LastAttackers

LastDamage

LastDamage, field of type AttackResult

  • LastDamage

LastDamageSource

LastDamageSource, field of type Entity

  • LastDamageSource

LastNetworkUpdateID

LastNetworkUpdateID, field of type number

  • LastNetworkUpdateID

LastOrderedCharacter

LastOrderedCharacter, field of type Character

  • LastOrderedCharacter

LastProcessedID

LastProcessedID, field of type number

  • LastProcessedID

Latchers

Latchers, field of type HashSet

  • Latchers

LockHands

LockHands, field of type bool

  • LockHands

LogName

LogName, field of type string

  • LogName

LowPassMultiplier

LowPassMultiplier, field of type number

  • LowPassMultiplier

MarkedAsLooted

MarkedAsLooted, field of type HashSet

  • MarkedAsLooted

Mass

Mass, field of type number

  • Mass

MaxHealth

MaxHealth, field of type number

  • MaxHealth

MaxPerceptionDistance

MaxPerceptionDistance, field of type number

  • MaxPerceptionDistance

MaxVitality

MaxVitality, field of type number

  • MaxVitality

MemLocalState

MemLocalState, field of type table

  • MemLocalState

MemState

MemState, field of type table

  • MemState

MerchantIdentifier

MerchantIdentifier, field of type Identifier

  • MerchantIdentifier

Name

Name, field of type string

  • Name

NeedsAir

NeedsAir, field of type bool

  • NeedsAir

NeedsOxygen

NeedsOxygen, field of type bool

  • NeedsOxygen

NeedsWater

NeedsWater, field of type bool

  • NeedsWater

Noise

Noise, field of type number

  • Noise

ObstructVision

ObstructVision, field of type bool

  • ObstructVision

ObstructVisionAmount

ObstructVisionAmount, field of type number

  • ObstructVisionAmount

OnAttacked

OnAttacked, field of type OnAttackedHandler

  • OnAttacked

OnDeath

OnDeath, field of type OnDeathHandler

  • OnDeath

OriginalTeamID

OriginalTeamID, field of type CharacterTeamType

  • OriginalTeamID

OverrideMovement

OverrideMovement, field of type ?Microsoft.Xna.Framework.Vector2

  • OverrideMovement

Oxygen

Oxygen, field of type number

  • Oxygen

OxygenAvailable

OxygenAvailable, field of type number

  • OxygenAvailable

Params

Params, field of type CharacterParams

  • Params

PickingItem

PickingItem, field of type Item

  • PickingItem

PoisonVulnerability

PoisonVulnerability, field of type number

  • PoisonVulnerability

Position

Position, field of type Microsoft.Xna.Framework.Vector2

  • Position

Prefab

Prefab, field of type CharacterPrefab

  • Prefab

PressureProtection

PressureProtection, field of type number

  • PressureProtection

PressureTimer

PressureTimer, field of type number

  • PressureTimer

PreviousHull

PreviousHull, field of type Hull

  • PreviousHull

Properties

Properties, field of type table

  • Properties

PropulsionSpeedMultiplier

PropulsionSpeedMultiplier, field of type number

  • PropulsionSpeedMultiplier

RadialDistortStrength

RadialDistortStrength, field of type number

  • RadialDistortStrength

Removed

Removed, field of type bool

  • Removed

RequireConsciousnessForCustomInteract

RequireConsciousnessForCustomInteract, field of type bool

  • RequireConsciousnessForCustomInteract

SecondLastOrderedCharacter

SecondLastOrderedCharacter, field of type Character

  • SecondLastOrderedCharacter

Seed

Seed, field of type string

  • Seed

SelectedBy

SelectedBy, field of type Character

  • SelectedBy

SelectedCharacter

SelectedCharacter, field of type Character

  • SelectedCharacter

SelectedItem

SelectedItem, field of type Item

  • SelectedItem

SelectedSecondaryItem

SelectedSecondaryItem, field of type Item

  • SelectedSecondaryItem

SerializableProperties

SerializableProperties, field of type table

  • SerializableProperties

ShowInteractionLabels

ShowInteractionLabels, field of type bool

  • ShowInteractionLabels

SimPosition

SimPosition, field of type Microsoft.Xna.Framework.Vector2

  • SimPosition

SmoothedCursorPosition

SmoothedCursorPosition, field of type Microsoft.Xna.Framework.Vector2

  • SmoothedCursorPosition

SpawnTime

SpawnTime, field of type number

  • SpawnTime

SpeciesName

SpeciesName, field of type Identifier

  • SpeciesName

SpeechImpediment

SpeechImpediment, field of type number

  • SpeechImpediment

SpeedMultiplier

SpeedMultiplier, field of type number

  • SpeedMultiplier

Stun

Stun, field of type number

  • Stun

Submarine

Submarine, field of type Submarine

  • Submarine

TeamID

TeamID, field of type CharacterTeamType

  • TeamID

TextChatVolume

TextChatVolume, field of type number

  • TextChatVolume

TraitorCurrentObjective

TraitorCurrentObjective, field of type LocalizedString

  • TraitorCurrentObjective

UniqueNameColor

UniqueNameColor, field of type ?Microsoft.Xna.Framework.Color

  • UniqueNameColor

Unkillable

Unkillable, field of type bool

  • Unkillable

UseHealthWindow

UseHealthWindow, field of type bool

  • UseHealthWindow

UseHullOxygen

UseHullOxygen, field of type bool

  • UseHullOxygen

VariantOf

VariantOf, field of type Identifier

  • VariantOf

ViewTarget

ViewTarget, field of type Entity

  • ViewTarget

Visibility

Visibility, field of type number

  • Visibility

Vitality

Vitality, field of type number

  • Vitality

Wallet

Wallet, field of type Wallet

  • Wallet

WasFullHealth

WasFullHealth, field of type bool

  • WasFullHealth

WorldPosition

WorldPosition, field of type Microsoft.Xna.Framework.Vector2

  • WorldPosition

healthUpdateTimer

healthUpdateTimer, field of type number

  • healthUpdateTimer

isSynced

isSynced, field of type bool

  • isSynced