HWR Function Reference

#### Discussion Threads:

Functions: https://forums.gearboxsoftware.com/t/resource-hwr-functions-list-updated-02-14/1556232/1

Globals Dump: https://forums.gearboxsoftware.com/t/new-globals-dump/1539958/1

**A**

AddAbility

AddCustomCode

AddMagneticField

AddShield

AddShipMultiplier

AddWeaponResult

**B**

bind1

bindup

**C**

Camera\_AllowControl

Camera\_AltFocus

Camera\_AltFocusWithVolume

Camera\_FocusOnFleet

Camera\_FocusRestore

Camera\_FocusSave

Camera\_FocusSobGroup

Camera\_FocusSobGroupWithBuffer

Camera\_FocusVolume

Camera\_FocusVolumeKeepingEyePosition

Camera\_GetDistanceToSobGroup

Camera\_GetLastZoomAmount

Camera\_Interpolate

Camera\_IsFocused

Camera\_PlayerHasPanned

Camera\_PlayerHasRotated

Camera\_ResetPanned

Camera\_ResetRotated

Camera\_SetLetterboxState

Camera\_SetLetterboxStateNoUI

Camera\_UseCameraPoint

Camera\_UsePanning

Camera\_ZoomClose

**D**

dofilepath

**E**

EventPointer\_Remove

**F**

FX\_StartEvent

**G**

getRulesNum

getShipNum

**K**

KAS\_AllowToPurchase

KAS\_BuildControl

KAS\_CampaignAutoSave

KAS\_CPUPlayerInit

KAS\_EnableTradeGUI

KAS\_FillShipsByCapital

KAS\_FillShipsByClass\_Normal

KAS\_FillShipsByClass\_Normal

KAS\_FindEnemiesInside

KAS\_FocusDerelict

KAS\_GameMessageReceived

KAS\_HW1CPUDisableAllAIFeatures

KAS\_HW1CPUEnableAIFeature

KAS\_Launch

KAS\_MessageSendToAll

KAS\_MusicPlayType

KAS\_MusicStop

KAS\_PingAddPoint

KAS\_PingRemove

KAS\_PlayerMothership

KAS\_RememberStartingRUs

KAS\_ResetGameMessageQueue

KAS\_SensorsToggle

KAS\_SetColourScheme

KAS\_SetColourSchemeColours

KAS\_SetFormation

KAS\_SetHidden

KAS\_SetLetterboxStart

KAS\_SetLetterboxState

KAS\_SetTradeCost

KAS\_SetTraderDisabled

KAS\_SetTradeString

KAS\_ShipsAdd

KAS\_SubtitleAddOnce

KAS\_TeamHyperspaceIn

KAS\_TeamNamesEqual

KAS\_UniversePause

KAS\_UnrestrictResearchOption

KASObjective\_Add

KASObjective\_SetState

KASPointer\_RemoveAll

KASRule\_Add

KASRule\_AddFSM

KASRule\_Remove

KASRules\_PauseExceptFSM

KASRules\_UnpauseOthers

KASSobGroup\_Create

KASSobGroup\_CreateIfNotExist

KASTimer\_IsExpiredIfSoDestroy

KASTimer\_Start

**M**

MainUI\_ActivateScreen

MainUI\_ElementVisible

MainUI\_FlashButton

MainUI\_LoadScreen

MainUI\_ShowElement

MainUI\_UnloadScreen

**P**

Player\_CancelResearch

Player\_GetLevelOfDifficulty

Player\_GetNumberOfSquadronsOfTypeAwakeOrSleeping

Player\_GetShipsByFilterInclude

Player\_HasQueuedResearch

Player\_InstantDockAndParade

Player\_InstantlyGatherAllResources

Player\_RestrictAllResearch

Player\_RestrictBuildOption

Player\_SetPlayerName

Player\_SetTeamColourTheme

Player\_UnrestrictBuildOption

print

PlayerRace\_DoesHaveTag

**S**

setConcurrentBuildLimit

setDefaultMusic

setBattleMusic

setEngineGlow

setSupplyValue

SpawnSalvageOnDeath

SobGroup\_AbilityActivate

SobGroup\_AddFilterExclude

SobGroup\_AddFilterInclude

SobGroup\_AllowPassiveActionsAlways

SobGroup\_AreAllInHyperspace

SobGroup\_AreAllInRealSpace

SobGroup\_AreAnyFromTheseAttackFamilies

SobGroup\_AreAnyOfTheseTypes

SobGroup\_AreAnySquadronsOutsideDustCloud

SobGroup\_AreAnySquadronsOutsideNebula

SobGroup\_Attack

SobGroup\_AttackPlayer

SobGroup\_AttackSobGroupHardPoint

SobGroup\_AvoidanceIgnore

SobGroup\_CaptureSobGroup

SobGroup\_ChangePower

SobGroup\_Clear

SobGroup\_ClearScriptFlag

SobGroup\_ClearTumble

SobGroup\_CloakToggle

SobGroup\_Copy

SobGroup\_Count

SobGroup\_CountByFilterInclude

SobGroup\_CountByScriptFlag

SobGroup\_Create

SobGroup\_CreateIfNotExist

SobGroup\_CreateShip

SobGroup\_CreateSubSystem

SobGroup\_CreateSubSystemCheck

SobGroup\_CustomCommand

SobGroup\_CustomCommandTargets

SobGroup\_DeployMinesInSphere

SobGroup\_DeSelectAll

SobGroup\_Despawn

SobGroup\_DockSobGroup

SobGroup\_DockSobGroup\_NoLatch

SobGroup\_DockSobGroupAndStayDocked

SobGroup\_DockSobGroupInstant

SobGroup\_Empty

SobGroup\_EnterHyperSpaceOffMap

SobGroup\_ExitHyperSpace

SobGroup\_ExitHyperSpaceSobGroup

SobGroup\_FillBattleScar

SobGroup\_FillCompare

SobGroup\_FillIntersect

SobGroup\_FillProximityPoint

SobGroup\_FillProximitySobGroup

SobGroup\_FillShipsByFamily

SobGroup\_FillShipsByIndexRange

SobGroup\_FillShipsByType

SobGroup\_FillSobGroupByHealthBelow

SobGroup\_FillSobGroupInVolume

SobGroup\_FillSubstract

SobGroup\_FillUnion

SobGroup\_FilterExclude

SobGroup\_FollowPath

SobGroup\_ForceStayDockedIfDocking

SobGroup\_FormHyperspaceGate

SobGroup\_FormSquadron

SobGroup\_FormStrikeGroup

SobGroup\_GetActualSpeed

SobGroup\_GetAttackers

SobGroup\_GetCentrePosition

SobGroup\_GetCoordSys

SobGroup\_GetDistanceToSobGroup

SobGroup\_GetHardPointHealth

SobGroup\_GetNextPathPoint

SobGroup\_GetPlayerOwner

SobGroup\_GetPosition

SobGroup\_GetROE

SobGroup\_GetShipType

SobGroup\_GetSobGroupBeingCapturedGroup

SobGroup\_GetSobGroupDockedWithGroup

SobGroup\_GetSobGroupSalvagingGroup

SobGroup\_GetStaticF

SobGroup\_GroupInGroup

SobGroup\_GuardSobGroup

SobGroup\_HealthPercentage

SobGroup\_HyperspaceTo

SobGroup\_InactiveWhenCaptured

SobGroup\_InStrikeGroup

SobGroup\_IsBuilding

SobGroup\_IsCloaked

SobGroup\_IsDocked

SobGroup\_IsDockedCompletely

SobGroup\_IsDockedSobGroup

SobGroup\_IsGateDeployed

SobGroup\_IsInControlGroup

SobGroup\_IsInVolume

SobGroup\_IsShipNearPoint

SobGroup\_Kamikaze

SobGroup\_Launch

SobGroup\_LaunchSelf

SobGroup\_LoadPersistantData

SobGroup\_MakeDead

SobGroup\_MakeUntargeted

SobGroup\_ManualEngineGlow

SobGroup\_MinimumHealth

SobGroup\_Move

SobGroup\_MoveToPoint

SobGroup\_MoveToSobGroup

SobGroup\_OwnedBy

SobGroup\_OwnedBy

SobGroup\_ParadeSobGroup

SobGroup\_PlayerIsInSensorRange

SobGroup\_ReleaseSalCapSobGroup

SobGroup\_RemoveType

SobGroup\_RepairSobGroup

SobGroup\_ResearchModuleExistOrSelected

SobGroup\_ResetRenderedFlags

SobGroup\_Resource

SobGroup\_RestrictBuildOption

SobGroup\_SalvagedByPlayer

SobGroup\_Selected

SobGroup\_SelectSobGroup

SobGroup\_SetAsDeployed

SobGroup\_SetAutoLaunch

SobGroup\_SetAutoLaunch

SobGroup\_SetBuildSpeedMultiplier

SobGroup\_SetCaptureAlwaysDisables

SobGroup\_SetCaptureState

SobGroup\_SetDamageMultiplier

SobGroup\_SetDisplayedRestrictedHardpoint

SobGroup\_SetFixed

SobGroup\_SetGhost

SobGroup\_SetHardPointHealth

SobGroup\_SetHealth

SobGroup\_SetHidden

SobGroup\_SetIgnoreWorldBounds

SobGroup\_SetInherentVisibility

SobGroup\_SetInRadiation

SobGroup\_SetInvulnerability

SobGroup\_SetInvulnerabilityOfHardPoint

SobGroup\_SetMadState

SobGroup\_SetMaxSpeed

SobGroup\_SetMaxSpeedMultiplier

SobGroup\_SetRetaliation

SobGroup\_SetROE

SobGroup\_SetScriptFlag

SobGroup\_SetSpeed

SobGroup\_SetStance

SobGroup\_SetSwitchOwnerFlag

SobGroup\_SetTeamColours

SobGroup\_SetTeamColourTheme

SobGroup\_SobGroupAdd

SobGroup\_SpawnNewShipInSobGroup

SobGroup\_SpawnToVector

SobGroup\_SplitGroupFromGroup

SobGroup\_Stop

SobGroup\_SwitchOwner

SobGroup\_TakeDamage

SobGroup\_TakeDamageAbsolute

SobGroup\_Tumble

SobGroup\_UnderAttack

SobGroup\_UnRestrictBuildOption

SobGroup\_UpdateClass

Sound\_EnableAllSpeech

Sound\_EnterIntelEvent

Sound\_SetMuteActor

Subtitle\_IsDoneOrSkipped

Subtitle\_Message

StartWeaponConfig

Subtitle\_Message\_Handlerw

**U**

UI\_IsNamedElementVisible

UI\_SetElementSize

Universe\_AllowPlayerOrders

Universe\_EnableSkip

Universe\_Fade

**V**

Volume\_AddSphere

**SHIP**

addAbility

addCustomCode

addMagneticField

addShield

AddShipMultiplier

getRulesNum

getShipNum

loadLatchPointList

LoadModel

loadShipPatchList

setConcurrentBuildLimit

setEngineBurn

setEngineGlow

setSupplyValue

setTacticsMults

setTargetBox

SpawnSalvageOnDeath

StartShipHardPointConfig

StartShipWeaponConfig

**WEPN**

addAnimTurretSound

AddWeaponResult

setAccuracy

setAccuracyFalloff

setAngles

setBallistics

setDamageFalloff

setFireMultFactor

setFrustratedTimers

setLifetimeMult

setMiscValues

setMissileKiller

setMissProperties

setPenetration

setRangeBoost

setRangeByStance

setSpeedvsAccuracyAgainst

StartWeaponConfig

**MISS**

LoadHODFile

loadShipPatchList

setEngineBurn

setEngineTrail

setTacticsMults

StartMissileConfig

**LEVEL**

addSquadron

setObjectAttributes

addAsteroid

addSphere

addPoint

createSOBGroup

addToSOBGroup

addCamera

addReactiveFleetSlot

setWorldBoundsInner

setWorldBoundsOuter

addPebble

fogSetActive

setGlareIntensity

setLevelShadowColour

loadBackground

setSensorsManagerCameraDistances

addDustCloudWithResources

**SUBS**

StartSubSystemWeaponConfig