# Avorion Script API Documentation

Home Functions Search
Search:

Weapon Weapon
Properties
accuracy
appearance
appearanceSeed
armed
banimationAcceleration
banimationSpeed
bauraWidth
binnerColor
blength
blockPenetration
bouterColor
bshape
bshapeSize
bwidth
civil
continuousBeam
damage
damageType
deathExplosion
dps
explosionRadius
fireDelay
fireRate
holdingForce
hullDamage
hullDamageMultiplicator
hullDamageMultiplier
hullRepair
icon
impactExplosion
impactParticles
impactSound
isBeam
isProjectile
localPosition
material
metalRawEfficiency
metalRefinedEfficiency
name
otherForce
pangularVelocity
pcolor
pmaximumTime
position
prefix
pshape
psize
pvelocity
rarity
reach
recoil
seeker
selfForce
shieldDamage
shieldDamageMultiplicator
shieldDamageMultiplier
shieldPenetration
shieldRepair
shotCreationPosition
shotsFired
shotsPerSecond
smaterial
sound
stoneDamageMultiplicator
stoneDamageMultiplier
stoneRawEfficiency
stoneRefinedEfficiency
tech
timedDeath
Member Functions
propertiesEqual
setBeam
setProjectile

# Weapon

function Weapon()

Returns

A new instance of Weapon

property float accuracy |

property int appearance |

property int appearanceSeed |

property bool armed | [read-only]

property float banimationAcceleration |

property float banimationSpeed |

property float bauraWidth |

property Color binnerColor |

property float blength |

property int blockPenetration |

property Color bouterColor |

property int bshape |

property float bshapeSize |

property float bwidth |

property bool civil | [read-only]

property bool continuousBeam |

property float damage |

property DamageType damageType |

property bool deathExplosion |

property float dps | [read-only]

property float explosionRadius |

property float fireDelay |

property float fireRate |

property float holdingForce |

property float hullDamage | [read-only]

property float hullDamageMultiplicator |

property float hullDamageMultiplier |

property float hullRepair |

property string icon |

property bool impactExplosion |

property int impactParticles |

property int impactSound |

property bool isBeam | [read-only]

property bool isProjectile | [read-only]

property vec3 localPosition |

property Material material |

property float metalRawEfficiency |

property float metalRefinedEfficiency |

property string name |

property float otherForce |

property float pangularVelocity |

property Color pcolor |

property float pmaximumTime |

property vec3 position | [read-only]

property string prefix |

property int pshape |

property float psize |

property float pvelocity |

property Rarity rarity |

property float reach |

property float recoil |

property bool seeker |

property float selfForce |

property float shieldDamage | [read-only]

property float shieldDamageMultiplicator |

property float shieldDamageMultiplier |

property float shieldPenetration |

property float shieldRepair |

property vec3 shotCreationPosition |

property int shotsFired |

property float shotsPerSecond | [read-only]

property Material smaterial |

property string sound |

property float stoneDamageMultiplicator |

property float stoneDamageMultiplier |

property float stoneRawEfficiency |

property float stoneRefinedEfficiency |

property int tech |

property bool timedDeath |

function bool propertiesEqual(Weapon other)

function var setBeam()

Returns

nothing

function var setProjectile()

Returns

nothing

Overview
Home Functions Search
Search:
Callbacks
Callbacks Alliance [Client] Callbacks Alliance [Server] Callbacks Alliance [Server] Callbacks Entity Callbacks Galaxy Callbacks Player Callbacks Player [Client] Callbacks Sector Callbacks Server Callbacks
Predefined Functions & Example Scripts
Command Entity FactionDatabase PlanGenerator Player Sector Server UsableInventoryItem
Common Components
Boarding BspTree CargoBay CargoLoot ControlUnit CrewComponent DeletionTimer DirectFlightPhysics DockingClamps DockingParent DockingPositions Durability EnergySystem Engine FighterAI Hangar HyperspaceEngine InteractionText InventoryItemLoot Owner Physics Plan ReadOnlyBoarding ReadOnlyBspTree ReadOnlyCargoBay ReadOnlyControlUnit ReadOnlyCrew ReadOnlyDeletionTimer ReadOnlyEnergySystem ReadOnlyEngine ReadOnlyFighterAI ReadOnlyHangar ReadOnlyHyperspaceEngine ReadOnlyInteractionText ReadOnlyOwner ReadOnlyPhysics ReadOnlyPlan ReadOnlyShipAI ReadOnlyShipSystem ReadOnlyTorpedoAI [Server] [Client] [Server] [Client] ReadOnlyTorpedoAI [Server] [Client] [Server] [Client] ReadOnlyTorpedoLauncher ReadOnlyTurretBases ReadOnlyVelocity ReadOnlyWeapons ReadOnlyWormHole Shield ShipAI ShipSystem StructuralIntegrity SystemUpgradeLoot Thrusters Torpedo TorpedoAI TorpedoLauncher Turret TurretAI TurretBases Velocity Weapons WormHole
Common Objects
AllianceMember AllianceRank BlockPlan BlockPlanBlock BlockStatistics Box Captain Color ControlUnitSeat CraftDesign CraftStatsOverview Crew CrewMan CrewProfession DebugInfo dvec2 dvec3 dvec4 Entity EntityDescriptor FighterTemplate Format GameSettings Group HighResolutionTimer Inventory InventoryTurret ivec2 ivec3 ivec4 Language Mail Material Matrix ModManager NamedFormat PlanBspTree PlanetSpecifics PlanGenerationStage PlanPart PlanStyle PlayerId PluralForm Profiler QuadTree Random Rarity Ray ReadOnlyEntity Rect Relation Scenario SectorView Seed Sphere Squad SystemUpgradeTemplate Timer Tooltip TooltipLine TorpedoShaft TorpedoTemplate TradingGood TurretDesign TurretDesignPart TurretTemplate UsableInventoryItem Uuid VanillaInventoryItem vec2 vec3 vec4 Version Weapon
Client Components
EntityIcon EntityTooltip PlanMesh ReadOnlyIcon ReadOnlyPlanMesh ReadOnlyScriptUI ReadOnlyTooltip ScriptUI
Client Objects
Achievements Alliance [Client] CameraKeyFrame CaptainSelectionItem Client ClientSettings ColorSelectionItem CraftDesignSelectionItem Faction [Client] Galaxy [Client] GalaxyMap GameInput GlowFX IconSelectionItem InputWindow InventoryReferenceSelectionItem InventorySelectionItem Keyboard LaserFX Mouse Music PixelIconSelectionItem Planet Player [Client] PlayerWindow RefractionFX Sector [Client] SelectionItem ShipDatabaseEntry [Client] SoundSource StrategyState TargetIndicator TooltipRenderer TurretDesignSelectionItem
Client UI Objects
AllianceEmblem AllianceTab ArrowLine Button [Client] [Client] Button [Client] [Client] CaptainIcon CaptainProfile CheckBox ComboBox ContextMenu CraftPortrait CrewBar Frame Hud InventorySelection Label Line ListBox ListBoxEx MapArrowLine MapIcon MultiLineTextBox NumbersBar Picture PlanDisplayer ProgressBar SavedDesignsSelection ScrollFrame Selection ShipWindow Slider StatisticsBar Tab TabbedWindow TextBox TextField TooltipDisplayer Tree UIArbitraryHorizontalSplitter UIArbitraryVerticalSplitter UIContainer UIElement UIGridSplitter UIHorizontalLister UIHorizontalMultiSplitter UIHorizontalSplitter UIOrganizer UIRect UIRenderer UIVerticalLister UIVerticalMultiSplitter UIVerticalSplitter ValueComboBox Window
Server Components
EntityTransferrer FighterController Loot ReadOnlyEntityTransferrer ReadOnlyFighterController ReadOnlyLoot ReadOnlyTurretController ReadOnlyWreckageCreator TurretController WreckageCreator
Server Objects
Alliance [Server] Faction [Server] Galaxy [Server] Player [Server] ReadOnlySector Sector [Server] Server ShipDatabaseEntry [Server]
Enums
AIState AlliancePrivilege BeamShape BlockShading BlockStructure BlockType BlockType2 BoxType BuildError CaptainGenderId ChatChannel ChatMessageType ComponentType ControlAction ControlActionBit ControlStyle CoolingType CraftStatsOverviewStat CrewProfessionType CrewRank DamageSource DamageType DeletionType Difficulty EntityArrivalType EntityType FighterOrders FighterStartError FighterType FontType ImpactParticles InventoryItemType JumpError KeyboardKey ListBoxEntryType MalusReason MaterialType MoonType MouseButton PlanetType PlanTypeFilter PlayerStateType ProjectileShape RarityType RelationStatus SavedDesignType ScenarioType SectorChangeType ShipAvailability SoundType StatsBonuses TargetIndicatorVisuals TransformationFeature TurretAutoFireMode TurretSlotType WeaponAppearance WeaponCategory

This is the official documentation for the scripting API of Avorion. This documentation is automatically generated and not necessarily complete. Depending on the context in which functions exist, some documentation such as descriptions, return values or variable names or types may be missing.

Work in Progress. Documentation of Avorion Version: 2.5.8 a0d3f0b5b065