API Reference Edit page

Auto-generated reference for every package in the Wurst standard library. For orientation and guidance on which package to use, see the standard library overview.

Object Editing

• AbilityObjEditing
• BuffObjEditing: You should use ‘createBuffObject’ inside compiletime expressions
• ChannelAbilityPreset
• DestructableObjEditing
• DoodadObjEditing
• HeroPreset
• ItemObjEditing
• ObjectIdGenerator
• ObjectIds
• ObjEditingCommons
• ObjEditingNatives
• OrderStringFactory
• TargetsAllowed
• UnitObjEditing
• UpgradeObjEditing: Use this class to create upgrade definitions.

Data Structures

• ArrayList: High-performance array-based list using static shared storage per type.
• BitSet
• HashList: HashLists are used if you require quick contains operations
• HashMap: Generic Table Wrapper
• HashSet: Generic set implementation
• LinkedList: Doubly-linked list implementation that implements all common list, stack and queue operations.
• LinkedListModule: Turns a class into a linked list where each instance knows it’s previous
• Table: Wraps a hashtable to provide single key tables

Closures

• ClosureEvents: This package is a comfort wrapper around wc3 events,
• ClosureForGroups: Executes the given closure for every unit in this group,
• ClosureFrames
• ClosureKeyPresses
• ClosureTimers: Execute an action after a certain time.
• Execute: This package exposes a single function execute(),

Events

• DamageEvent: This package provides a light-weight damage detection system with priority-ordered listeners.
• EventHelper: This class exposes all Getters and Setters for trigger events.
• LastOrder: If you import this package in any of your packages, each order
• OnUnitEnterLeave
• RegisterEvents

Dummies

• DummyCaster: Dummy casters are commonly used in custom spells to cast abilities dynamically onto targets or points.
• DummyDamage: DummyDamage is used when you want to inflict damage from a certain player,
• DummyRecycler: Id of the root ability
• Fx: *
• Fx2
• InstantDummyCaster: Dummy caster for casting instant spells.

Math

• Angle
• BigNum
• Bitwise: A tuple containing 4 bytes comprising a 4-byte integer.
• BitwiseInit
• Interpolation: Linear Interpolation
• Maths: Returns the length of the hypotenuse of a right-angle triangle with the
• Matrices: Matrix 2x2
• Quaternion: Linear interpolation.
• Raycast: An infinite 2D ray
• Vectors: A vector is a geometric object that has a length and direction.

File & Network

• Base64: Specifies how many characters to encode per a single execute() call.
• ByteBuffer
• ChunkedString
• FileIO
• GameStatus
• SaveLoadData: Asynchronously loads the data from the file of the given player
• Serializable
• SyncSimple

Utilities

• Board: This Board library allows you to create a simple multi board with dynamic cell values.
• Cinematic: Create a cinematic by composing cinematic sequences
• Colors: Mixes two colors, s would be a number 0<=s<=1 that determines
• DialogBox: DialogBox lets you create dialogs more easily and associate its buttons with closures.
• EffectUtils
• GameTimer
• GroupUtils: The max number of recyclable groups.
• Knockback3: Use the Knockback3.add(..) functions to apply 3D knockback to units.
• MapBounds
• Preloader
• Printing
• SafetyChecks: Enables or disables various safety checks in miscellaneous libraries in Wurst.
• Simulate3dSound
• SoundUtils
• StandardTextTags
• StringUtils: Custom Function which can split strings and runs callback for each string.
• TerrainUtils
• Time: Type-safe wrappers to distinguish durations (an amount of time) from instants (a point in time), and the valid ways
• TimerUtils: Get a new timer.
• UnitIndexer: Returns the int index of this unit.

Handle Wrappers

• _Handles
• _Primitives
• Ability
• Boolean
• Boolexpr
• Camera: Pans the camera to pos.x, pos.y and absolute height pos.z
• CommonNativeExtensions
• Destructable
• Dialog: Dialogs are big dialog boxes at the center of the screen.
• Effect: Change the orientation of the special effect.
• Fogmodifier
• Force
• Framehandle: Returns the origin frame of the given type.
• GameCache
• Group: Use this group for your non-nested group enum calls
• Hashtable
• Image: ImageLayer influences the order in which the images are drawn above one another
• Integer
• Item: Updates the item’s name, tooltip, extendedtooltip, description or icon for the specific player.
• Lightning
• Multiboard
• Player
• Playercolor
• Quest
• QuestItem
• Real: The arctangent function with two arguments.
• Rect
• Reference: A simple wrapper class which contains a reference to a value of the given type.
• Region
• Sound: Returns sound length in milliseconds.
• String: returns the position of the char in the charset
• Texttag
• Timer
• TimerDialog: Multiplies the timer’s tick rate and remaining time, so that the overall elapsed time stays the same.
• Trigger: Metakey is an integer based native parameter which is used as a bitfield.
• Unit: Sets the unit’s position using the SetUnitPosition native.
• Weather
• Widget

Core Language

• Abilities
• AbilityIds
• Annotations
• Assets
• AttachmentPoints: Class that contains every known attachmentpoint in game
• Basics
• BuffIds
• Buildings
• Doodads
• Environment
• ErrorHandling: error handing function.
• FramehandleNames: These default frames templates can be created with createFrame(..) [BlzCreateFrame]
• Icons
• ItemIds
• MagicFunctions: builtin magic function.
• Objects
• OrderIds
• Orders
• PathingMaps
• Reflection: This package is designed for debugging.
• Sounds
• Soundsets
• Textures
• Tiles
• TypeCasting
• UI
• UnitAnimations
• UnitIds
• Units
• WeatherEffects
• Wurstunit

Root

• Wurst