# Avorion Script API Documentation

Home Functions Search
Search:

ClientSettings ClientSettings
Properties
ambientOcclusion
autoPayCrews
autosaveInBuildMode
backgroundResolutionFactor
bloom
complexSelfShadows
consoleFontSize
consoleHeight
damageParticleSize
detailedTurretTooltips
display
drawFps
drawFrameGraphs
effectVolume
encyclopediaPopUp
fogIntensity
fogQuality
fpsLimit
gamma
globalShadowMapSize
instancedShadows
invertY
language
largeObjectShadows
mapEdgeScrollingEnabled
masterVolume
mouseSensitivity
musicVolume
ownShadowMapSize
particlesQuality
pauseInBuildMode
planetResolutionFactor
playedTutorial
playerName
playerShadows
pressSpaceInLoadingScreen
resolution
retinaMode
shadowRange
showDriverWarning
showProgradeMarker
showRetrogradeMarker
silenceDuration
softShadows
strategyStateEdgeScrollingEnabled
streamerMode
superSampling
uiColor
uiScale
uiVolume
vsync
weaponVolume
Member Functions

# ClientSettings

This object is only available on the client.

function ClientSettings()

Returns

A new instance of ClientSettings

property bool ambientOcclusion | [read-only]

property bool autoPayCrews | [read-only]

property bool autosaveInBuildMode | [read-only]

property float backgroundResolutionFactor | [read-only]

property bool bloom | [read-only]

property bool complexSelfShadows | [read-only]

property int consoleFontSize | [read-only]

property float consoleHeight | [read-only]

property float damageParticleSize | [read-only]

property bool detailedTurretTooltips | [read-only]

property int display | [read-only]

property bool drawFps | [read-only]

property bool drawFrameGraphs | [read-only]

property float effectVolume | [read-only]

property bool encyclopediaPopUp | [read-only]

property float fogIntensity | [read-only]

property float fogQuality | [read-only]

property int fpsLimit | [read-only]

property float gamma | [read-only]

property int globalShadowMapSize | [read-only]

property bool instancedShadows | [read-only]

property bool invertY | [read-only]

property string language | [read-only]

property bool largeObjectShadows | [read-only]

property bool mapEdgeScrollingEnabled | [read-only]

property float masterVolume | [read-only]

property float mouseSensitivity | [read-only]

property float musicVolume | [read-only]

property int ownShadowMapSize | [read-only]

property int particlesQuality | [read-only]

property bool pauseInBuildMode | [read-only]

property float planetResolutionFactor | [read-only]

property bool playedTutorial | [read-only]

property string playerName | [read-only]

property bool playerShadows | [read-only]

property bool pressSpaceInLoadingScreen | [read-only]

property ivec2 resolution | [read-only]

property bool retinaMode | [read-only]

property float shadowRange | [read-only]

property bool showDriverWarning | [read-only]

property bool showProgradeMarker | [read-only]

property bool showRetrogradeMarker | [read-only]

property double silenceDuration | [read-only]

property bool softShadows | [read-only]

property bool strategyStateEdgeScrollingEnabled | [read-only]

property bool streamerMode | [read-only]

property float superSampling | [read-only]

property Color uiColor | [read-only]

property float uiScale | [read-only]

property float uiVolume | [read-only]

property int vsync | [read-only]

property float weaponVolume | [read-only]

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