-
-
Notifications
You must be signed in to change notification settings - Fork 2.6k
Weapons
Matthias Mailรคnder edited this page Jul 22, 2017
·
9 revisions
This documentation is aimed at modders. It displays a template for weapon definitions as well as its contained types (warheads and projectiles) with default values and developer commentary. Please do not edit it directly, but add new [Desc("String")]
tags to the source code. This file has been automatically generated for version {DEV_VERSION} of OpenRA.
- OpenRA.Mods.Cnc.Projectiles
- TeslaZap
- OpenRA.Mods.Common.Projectiles
- AreaBeam
- Bullet
- InstantHit
- GravityBomb
- LaserZap
- Missile
- Railgun
- OpenRA.Mods.Common.Warheads
- CreateEffectWarhead
- CreateResourceWarhead
- DestroyResourceWarhead
- GrantExternalConditionWarhead
- HealthPercentageDamageWarhead
- LeaveSmudgeWarhead
- SpreadDamageWarhead
- TargetDamageWarhead
Property | Default Value | Type | Description |
---|---|---|---|
Image | litning | String | |
BrightSequence | bright | String | |
DimSequence | dim | String | |
Palette | effect | String | |
BrightZaps | 1 | Integer | |
DimZaps | 2 | Integer | |
Duration | 2 | Integer | |
DamageDuration | 1 | Integer | |
TrackTarget | True | Boolean |
Property | Default Value | Type | Description |
---|---|---|---|
Speed | 0c128 | Collection of 1D World Distance | Projectile speed in WDist / tick, two values indicate a randomly picked velocity per beam. |
Duration | 10 | Integer | The maximum duration (in ticks) of each beam burst. |
DamageInterval | 3 | Integer | The number of ticks between the beam causing warhead impacts in its area of effect. |
Width | 0c512 | 1D World Distance | The width of the beam. |
Shape | Cylindrical | BeamRenderableShape | The shape of the beam. Accepts values Cylindrical or Flat. |
BeyondTargetRange | 0c0 | 1D World Distance | How far beyond the target the projectile keeps on travelling. |
Falloff | 100, 100 | Collection of Integer | Damage modifier applied at each range step. |
Range | 0c0, 2097151c1023 | Collection of 1D World Distance | Ranges at which each Falloff step is defined. |
Inaccuracy | 0c0 | 1D World Distance | Maximum offset at the maximum range. |
Blockable | False | Boolean | Can this projectile be blocked when hitting actors with an IBlocksProjectiles trait. |
TrackTarget | False | Boolean | Does the beam follow the target. |
RenderBeam | True | Boolean | Should the beam be visually rendered? False = Beam is invisible. |
ZOffset | 0 | Integer | Equivalent to sequence ZOffset. Controls Z sorting. |
Color | FF0000 | Color (RRGGBB[AA] notation) | Color of the beam. |
UsePlayerColor | False | Boolean | Beam color is the player's color. |
BlockerScanRadius | -0c1 | 1D World Distance | Scan radius for actors with projectile-blocking trait. If set to a negative value (default), it will automatically scale to the blocker with the largest health shape. Only set custom values if you know what you're doing. |
AreaVictimScanRadius | -0c1 | 1D World Distance | Scan radius for actors damaged by beam. If set to a negative value (default), it will automatically scale to the largest health shape. Only set custom values if you know what you're doing. |
Property | Default Value | Type | Description |
---|---|---|---|
Speed | 0c17 | Collection of 1D World Distance | Projectile speed in WDist / tick, two values indicate variable velocity. |
Inaccuracy | 0c0 | 1D World Distance | Maximum offset at the maximum range. |
Image | String | Image to display. | |
Sequences | idle | Collection of String | Loop a randomly chosen sequence of Image from this list while this projectile is moving. |
Palette | effect | String | The palette used to draw this projectile. |
Shadow | False | Boolean | Does this projectile have a shadow? |
ShadowPalette | shadow | String | Palette to use for this projectile's shadow if Shadow is true. |
TrailImage | String | Trail animation. | |
TrailSequences | idle | Collection of String | Loop a randomly chosen sequence of TrailImage from this list while this projectile is moving. |
Blockable | True | Boolean | Is this blocked by actors with BlocksProjectiles trait. |
Width | 0c1 | 1D World Distance | Width of projectile (used for finding blocking actors). |
LaunchAngle | 0 | Collection of 1D World Angle | Arc in WAngles, two values indicate variable arc. |
BounceCount | 0 | Integer | Up to how many times does this bullet bounce when touching ground without hitting a target. 0 implies exploding on contact with the originally targeted position. |
BounceRangeModifier | 60 | Integer | Modify distance of each bounce by this percentage of previous distance. |
ValidBounceBlockerStances | Enemy, Neutral | Stance | If projectile touches an actor with one of these stances during or after the first bounce, trigger explosion. |
TrailInterval | 2 | Integer | Interval in ticks between each spawned Trail animation. |
TrailDelay | 1 | Integer | Delay in ticks until trail animation is spawned. |
AirburstAltitude | 0c0 | 1D World Distance | Altitude above terrain below which to explode. Zero effectively deactivates airburst. |
TrailPalette | effect | String | Palette used to render the trail sequence. |
TrailUsePlayerPalette | False | Boolean | Use the Player Palette to render the trail sequence. |
ContrailLength | 0 | Integer | |
ContrailZOffset | 2047 | Integer | |
ContrailColor | FFFFFF | Color (RRGGBB[AA] notation) | |
ContrailUsePlayerColor | False | Boolean | |
ContrailDelay | 1 | Integer | |
ContrailWidth | 0c64 | 1D World Distance | |
BlockerScanRadius | -0c1 | 1D World Distance | Scan radius for actors with projectile-blocking trait. If set to a negative value (default), it will automatically scale to the blocker with the largest health shape. Only set custom values if you know what you're doing. |
BounceBlockerScanRadius | -0c1 | 1D World Distance | Extra search radius beyond path for actors with ValidBounceBlockerStances. If set to a negative value (default), it will automatically scale to the largest health shape. Only set custom values if you know what you're doing. |
Simple, invisible, usually direct-on-target projectile.
Property | Default Value | Type | Description |
---|---|---|---|
Inaccuracy | 0c0 | 1D World Distance | Maximum offset at the maximum range. |
Blockable | False | Boolean | Projectile can be blocked. |
Width | 0c1 | 1D World Distance | The width of the projectile. |
BlockerScanRadius | -0c1 | 1D World Distance | Scan radius for actors with projectile-blocking trait. If set to a negative value (default), it will automatically scale to the blocker with the largest health shape. Only set custom values if you know what you're doing. |
Property | Default Value | Type | Description |
---|---|---|---|
Image | String | ||
Sequences | idle | Collection of String | Loop a randomly chosen sequence of Image from this list while falling. |
OpenSequence | String | Sequence to play when launched. Skipped if null or empty. | |
Palette | effect | String | |
Shadow | False | Boolean | |
ShadowPalette | shadow | String | |
Velocity | 0,0,0 | 3D World Vector | Projectile movement vector per tick (forward, right, up), use negative values for opposite directions. |
Acceleration | 0,0,-15 | 3D World Vector | Value added to Velocity every tick. |
Not a sprite, but an engine effect.
Property | Default Value | Type | Description |
---|---|---|---|
Width | 0c86 | 1D World Distance | The width of the zap. |
Shape | Cylindrical | BeamRenderableShape | The shape of the beam. Accepts values Cylindrical or Flat. |
ZOffset | 0 | Integer | Equivalent to sequence ZOffset. Controls Z sorting. |
Duration | 10 | Integer | |
UsePlayerColor | False | Boolean | |
Color | FF0000 | Color (RRGGBB[AA] notation) | Color of the beam. |
TrackTarget | True | Boolean | Beam follows the target. |
Inaccuracy | 0c0 | 1D World Distance | Maximum offset at the maximum range. |
Blockable | False | Boolean | Beam can be blocked. |
SecondaryBeam | False | Boolean | Draw a second beam (for 'glow' effect). |
SecondaryBeamWidth | 0c86 | 1D World Distance | The width of the zap. |
SecondaryBeamShape | Cylindrical | BeamRenderableShape | The shape of the beam. Accepts values Cylindrical or Flat. |
SecondaryBeamZOffset | 0 | Integer | Equivalent to sequence ZOffset. Controls Z sorting. |
SecondaryBeamUsePlayerColor | False | Boolean | |
SecondaryBeamColor | FF0000 | Color (RRGGBB[AA] notation) | Color of the secondary beam. |
HitAnim | String | Impact animation. | |
HitAnimSequence | idle | String | Sequence of impact animation to use. |
HitAnimPalette | effect | String | |
BlockerScanRadius | -0c1 | 1D World Distance | Scan radius for actors with projectile-blocking trait. If set to a negative value (default), it will automatically scale to the blocker with the largest health shape. Only set custom values if you know what you're doing. |
Property | Default Value | Type | Description |
---|---|---|---|
Image | String | Name of the image containing the projectile sequence. | |
Sequences | idle | Collection of String | Loop a randomly chosen sequence of Image from this list while this projectile is moving. |
Palette | effect | String | Palette used to render the projectile sequence. |
Shadow | False | Boolean | Should the projectile's shadow be rendered? |
MinimumLaunchAngle | 960 | 1D World Angle | Minimum vertical launch angle (pitch). |
MaximumLaunchAngle | 128 | 1D World Angle | Maximum vertical launch angle (pitch). |
MinimumLaunchSpeed | -0c1 | 1D World Distance | Minimum launch speed in WDist / tick. Defaults to Speed if -1. |
MaximumLaunchSpeed | -0c1 | 1D World Distance | Maximum launch speed in WDist / tick. Defaults to Speed if -1. |
Speed | 0c384 | 1D World Distance | Maximum projectile speed in WDist / tick |
Acceleration | 0c5 | 1D World Distance | Projectile acceleration when propulsion activated. |
Arm | 0 | Integer | How many ticks before this missile is armed and can explode. |
Blockable | True | Boolean | Is the missile blocked by actors with BlocksProjectiles: trait. |
TerrainHeightAware | False | Boolean | Is the missile aware of terrain height levels. Only needed for mods with real, non-visual height levels. |
Width | 0c1 | 1D World Distance | Width of projectile (used for finding blocking actors). |
Inaccuracy | 0c0 | 1D World Distance | Maximum offset at the maximum range |
LockOnProbability | 100 | Integer | Probability of locking onto and following target. |
HorizontalRateOfTurn | 5 | Integer | Horizontal rate of turn. |
VerticalRateOfTurn | 6 | Integer | Vertical rate of turn. |
Gravity | 10 | Integer | Gravity applied while in free fall. |
RangeLimit | 0c0 | 1D World Distance | Run out of fuel after covering this distance. Zero for defaulting to weapon range. Negative for unlimited fuel. |
ExplodeWhenEmpty | True | Boolean | Explode when running out of fuel. |
AirburstAltitude | 0c0 | 1D World Distance | Altitude above terrain below which to explode. Zero effectively deactivates airburst. |
CruiseAltitude | 0c512 | 1D World Distance | Cruise altitude. Zero means no cruise altitude used. |
HomingActivationDelay | 0 | Integer | Activate homing mechanism after this many ticks. |
TrailImage | String | Image that contains the trail animation. | |
TrailSequences | idle | Collection of String | Loop a randomly chosen sequence of TrailImage from this list while this projectile is moving. |
TrailPalette | effect | String | Palette used to render the trail sequence. |
TrailUsePlayerPalette | False | Boolean | Use the Player Palette to render the trail sequence. |
TrailInterval | 2 | Integer | Interval in ticks between spawning trail animation. |
TrailWhenDeactivated | False | Boolean | Should trail animation be spawned when the propulsion is not activated. |
ContrailLength | 0 | Integer | |
ContrailZOffset | 2047 | Integer | |
ContrailWidth | 0c64 | 1D World Distance | |
ContrailColor | FFFFFF | Color (RRGGBB[AA] notation) | |
ContrailUsePlayerColor | False | Boolean | |
ContrailDelay | 1 | Integer | |
Jammable | True | Boolean | Should missile targeting be thrown off by nearby actors with JamsMissiles. |
JammedDiversionRange | 20 | Integer | Range of facings by which jammed missiles can stray from current path. |
BoundToTerrainType | String | Explodes when leaving the following terrain type, e.g., Water for torpedoes. | |
AllowSnapping | False | Boolean | Allow the missile to snap to the target, meaning jumping to the target immediately when the missile enters the radius of the current speed around the target. |
CloseEnough | 0c298 | 1D World Distance | Explodes when inside this proximity radius to target. Note: If this value is lower than the missile speed, this check might not trigger fast enough, causing the missile to fly past the target. |
BlockerScanRadius | -0c1 | 1D World Distance | Scan radius for actors with projectile-blocking trait. If set to a negative value (default), it will automatically scale to the blocker with the largest health shape. Only set custom values if you know what you're doing. |
Laser effect with helix coiling around.
Property | Default Value | Type | Description |
---|---|---|---|
DamageActorsInLine | False | Boolean | Damage all units hit by the beam instead of just the target? |
Inaccuracy | 0c0 | 1D World Distance | Maximum offset at the maximum range. |
Blockable | False | Boolean | Can this projectile be blocked when hitting actors with an IBlocksProjectiles trait. |
Duration | 15 | Integer | Duration of the beam and helix |
ZOffset | 0 | Integer | Equivalent to sequence ZOffset. Controls Z sorting. |
BeamWidth | 0c86 | 1D World Distance | The width of the main trajectory. ("beam"). |
BeamShape | Cylindrical | BeamRenderableShape | The shape of the beam. Accepts values Cylindrical or Flat. |
BeamColor | FFFFFF80 | Color (RRGGBB[AA] notation) | Beam color in (A),R,G,B. |
BeamPlayerColor | False | Boolean | When true, this will override BeamColor parameter and draw the laser with player color. (Still uses BeamColor's alpha information) |
BeamAlphaDeltaPerTick | -8 | Integer | Beam alpha gets + this value per tick during drawing; hence negative value makes it fade over time. |
HelixThickness | 0c32 | 1D World Distance | Thickness of the helix |
HelixRadius | 0c64 | 1D World Distance | The radius of the spiral effect. (WDist) |
HelixPitch | 0c512 | 1D World Distance | Height of one complete helix turn, measured parallel to the axis of the helix (WDist) |
HelixRadiusDeltaPerTick | 8 | Integer | Helix radius gets + this value per tick during drawing |
HelixAlphaDeltaPerTick | -8 | Integer | Helix alpha gets + this value per tick during drawing; hence negative value makes it fade over time. |
HelixAngleDeltaPerTick | 16 | 1D World Angle | Helix spins by this much over time each tick. |
QuantizationCount | 16 | Integer | Draw each cycle of helix with this many quantization steps |
HelixColor | FFFFFF80 | Color (RRGGBB[AA] notation) | Helix color in (A),R,G,B. |
HelixPlayerColor | False | Boolean | Draw helix in PlayerColor? Overrides RGB part of the HelixColor. (Still uses HelixColor's alpha information) |
HitAnim | String | Impact animation. | |
HitAnimSequence | idle | String | Sequence of impact animation to use. |
HitAnimPalette | effect | String | |
AreaVictimScanRadius | 0c0 | 1D World Distance | Scan radius for actors damaged by beam. If set to zero (default), it will automatically scale to the largest health shape. Only set custom values if you know what you're doing. |
BlockerScanRadius | 0c0 | 1D World Distance | Scan radius for actors with projectile-blocking trait. If set to zero (default), it will automatically scale to the blocker with the largest health shape. Only set custom values if you know what you're doing. |
Property | Default Value | Type | Description |
---|---|---|---|
Explosions | Collection of String | List of explosion sequences that can be used. | |
Image | explosion | String | Image containing explosion effect sequence. |
ExplosionPalette | effect | String | Palette to use for explosion effect. |
UsePlayerPalette | False | Boolean | Remap explosion effect to player color, if art supports it. |
ForceDisplayAtGroundLevel | False | Boolean | Display explosion effect at ground level, regardless of explosion altitude. |
ImpactSounds | Collection of String | List of sounds that can be played on impact. | |
AirThreshold | 0c128 | 1D World Distance | Consider explosion above this altitude an air explosion. If that's the case, this warhead will consider the explosion position to have the 'Air' TargetType (in addition to any nearby actor's TargetTypes). |
VictimScanRadius | -0c1 | 1D World Distance | Scan radius for victims around impact. If set to a negative value (default), it will automatically scale to the largest health shape. Custom overrides should not be necessary under normal circumstances. |
ValidTargets | Ground, Water | Set of String | What types of targets are affected. |
InvalidTargets | Set of String | What types of targets are unaffected. Overrules ValidTargets. | |
ValidStances | Enemy, Neutral, Ally | Stance | What diplomatic stances are affected. |
AffectsParent | False | Boolean | Can this warhead affect the actor that fired it. |
Delay | 0 | Integer | Delay in ticks before applying the warhead effect. 0 = instant (old model). |
DebugOverlayColor | FF0000 | Color (RRGGBB[AA] notation) | The color used for this warhead's visualization in the world's `WarheadDebugOverlay` trait. |
Property | Default Value | Type | Description |
---|---|---|---|
Size | 0, 0 | Collection of Integer | Size of the area. The resources are seeded within this area. Provide 2 values for a ring effect (outer/inner). |
AddsResourceType | String | Will this splatter resources and which? | |
ValidTargets | Ground, Water | Set of String | What types of targets are affected. |
InvalidTargets | Set of String | What types of targets are unaffected. Overrules ValidTargets. | |
ValidStances | Enemy, Neutral, Ally | Stance | What diplomatic stances are affected. |
AffectsParent | False | Boolean | Can this warhead affect the actor that fired it. |
Delay | 0 | Integer | Delay in ticks before applying the warhead effect. 0 = instant (old model). |
DebugOverlayColor | FF0000 | Color (RRGGBB[AA] notation) | The color used for this warhead's visualization in the world's `WarheadDebugOverlay` trait. |
Property | Default Value | Type | Description |
---|---|---|---|
Size | 0, 0 | Collection of Integer | Size of the area. The resources are seeded within this area. Provide 2 values for a ring effect (outer/inner). |
ValidTargets | Ground, Water | Set of String | What types of targets are affected. |
InvalidTargets | Set of String | What types of targets are unaffected. Overrules ValidTargets. | |
ValidStances | Enemy, Neutral, Ally | Stance | What diplomatic stances are affected. |
AffectsParent | False | Boolean | Can this warhead affect the actor that fired it. |
Delay | 0 | Integer | Delay in ticks before applying the warhead effect. 0 = instant (old model). |
DebugOverlayColor | FF0000 | Color (RRGGBB[AA] notation) | The color used for this warhead's visualization in the world's `WarheadDebugOverlay` trait. |
Property | Default Value | Type | Description |
---|---|---|---|
Condition | String | The condition to apply. Must be included in the target actor's ExternalConditions list. | |
Duration | 0 | Integer | Duration of the condition (in ticks). Set to 0 for a permanent condition. |
Range | 1c0 | 1D World Distance | |
ValidTargets | Ground, Water | Set of String | What types of targets are affected. |
InvalidTargets | Set of String | What types of targets are unaffected. Overrules ValidTargets. | |
ValidStances | Enemy, Neutral, Ally | Stance | What diplomatic stances are affected. |
AffectsParent | False | Boolean | Can this warhead affect the actor that fired it. |
Delay | 0 | Integer | Delay in ticks before applying the warhead effect. 0 = instant (old model). |
DebugOverlayColor | FF0000 | Color (RRGGBB[AA] notation) | The color used for this warhead's visualization in the world's `WarheadDebugOverlay` trait. |
Property | Default Value | Type | Description |
---|---|---|---|
Spread | 0c43 | Collection of 1D World Distance | Size of the area. Damage will be applied to this area. If two spreads are defined, the area of effect is a ring, where the second value is the inner radius. |
Damage | 0 | Integer | How much (raw) damage to deal. |
DamageTypes | Set of String | Types of damage that this warhead causes. Leave empty for no damage. | |
Versus | Mapping of String to Integer | Damage percentage versus each armortype. | |
ValidTargets | Ground, Water | Set of String | What types of targets are affected. |
InvalidTargets | Set of String | What types of targets are unaffected. Overrules ValidTargets. | |
ValidStances | Enemy, Neutral, Ally | Stance | What diplomatic stances are affected. |
AffectsParent | False | Boolean | Can this warhead affect the actor that fired it. |
Delay | 0 | Integer | Delay in ticks before applying the warhead effect. 0 = instant (old model). |
DebugOverlayColor | FF0000 | Color (RRGGBB[AA] notation) | The color used for this warhead's visualization in the world's `WarheadDebugOverlay` trait. |
Property | Default Value | Type | Description |
---|---|---|---|
Size | 0, 0 | Collection of Integer | Size of the area. A smudge will be created in each tile. Provide 2 values for a ring effect (outer/inner). |
SmudgeType | Set of String | Type of smudge to apply to terrain. | |
AirThreshold | 0c128 | 1D World Distance | How close to ground must the impact happen to spawn smudges. |
ValidTargets | Ground, Water | Set of String | What types of targets are affected. |
InvalidTargets | Set of String | What types of targets are unaffected. Overrules ValidTargets. | |
ValidStances | Enemy, Neutral, Ally | Stance | What diplomatic stances are affected. |
AffectsParent | False | Boolean | Can this warhead affect the actor that fired it. |
Delay | 0 | Integer | Delay in ticks before applying the warhead effect. 0 = instant (old model). |
DebugOverlayColor | FF0000 | Color (RRGGBB[AA] notation) | The color used for this warhead's visualization in the world's `WarheadDebugOverlay` trait. |
Property | Default Value | Type | Description |
---|---|---|---|
Spread | 0c43 | 1D World Distance | Range between falloff steps. |
Falloff | 100, 37, 14, 5, 0 | Collection of Integer | Damage percentage at each range step |
Range | Collection of 1D World Distance | Ranges at which each Falloff step is defined. Overrides Spread. | |
VictimScanRadius | -0c1 | 1D World Distance | Extra search radius beyond maximum spread. If set to a negative value (default), it will automatically scale to the largest health shape. Custom overrides should not be necessary under normal circumstances. |
Damage | 0 | Integer | How much (raw) damage to deal. |
DamageTypes | Set of String | Types of damage that this warhead causes. Leave empty for no damage. | |
Versus | Mapping of String to Integer | Damage percentage versus each armortype. | |
ValidTargets | Ground, Water | Set of String | What types of targets are affected. |
InvalidTargets | Set of String | What types of targets are unaffected. Overrules ValidTargets. | |
ValidStances | Enemy, Neutral, Ally | Stance | What diplomatic stances are affected. |
AffectsParent | False | Boolean | Can this warhead affect the actor that fired it. |
Delay | 0 | Integer | Delay in ticks before applying the warhead effect. 0 = instant (old model). |
DebugOverlayColor | FF0000 | Color (RRGGBB[AA] notation) | The color used for this warhead's visualization in the world's `WarheadDebugOverlay` trait. |
Property | Default Value | Type | Description |
---|---|---|---|
Damage | 0 | Integer | How much (raw) damage to deal. |
DamageTypes | Set of String | Types of damage that this warhead causes. Leave empty for no damage. | |
Versus | Mapping of String to Integer | Damage percentage versus each armortype. | |
ValidTargets | Ground, Water | Set of String | What types of targets are affected. |
InvalidTargets | Set of String | What types of targets are unaffected. Overrules ValidTargets. | |
ValidStances | Enemy, Neutral, Ally | Stance | What diplomatic stances are affected. |
AffectsParent | False | Boolean | Can this warhead affect the actor that fired it. |
Delay | 0 | Integer | Delay in ticks before applying the warhead effect. 0 = instant (old model). |
DebugOverlayColor | FF0000 | Color (RRGGBB[AA] notation) | The color used for this warhead's visualization in the world's `WarheadDebugOverlay` trait. |
Players ๐ฒ
- FAQ โ
- Installation ๐ฆ
- Game Content ๐ฟ
- Hotkeys and Stances ๐ฎ
- Strategies ๐
- Settings ๐ง
- Dedicated Server โพ
- RaspberryPi ๐
- Badges & Icons ๐ฅ
- Changelog ๐
Modders โ๏ธ
- Audio guide ๐
- Traits ๐
- Palettes and Remaps ๐จ
- World Coordinate System ๐
- Map scripting
- Lua-API ๐
- Conditions ๐
- Mapping ๐ง
- Pixelart ๐
Developers ๐ง
- Contributing โค๏ธ
- Compiling
- Hacking
- Coding Standard ๐
- Branches and Releases ๐
- Release Checklist โ
- Sequences
- Glossary
- Reverse engineering ๐
- License ยฉ๏ธ