Editing Weapon (object)

A weapon object is a [[BZW]] map structure that defines a fixed weapon effect. This is also called a world weapon.

==Code==
The code for a weaponobject is as follows
{|
|
 weapon
  name example_weapon
  position 0.0 0.0 0.0
  rotation 0.0
  color 0
  tilt 0.0
  initdelay 10.0
  delay 10.0 3.0 5.0 3.0
  type SW
  trigger oncap
  eventteam 1
 end
|}
Valid parameters for a weapon object are:
{|{{Prettytable}}
|-
| {{Hl3}} |'''Parameter''' 
| {{Hl3}} |'''Description'''
|-
| '''name''' || the name of the weapon, generally unused.
|-
| '''position''' || the position in world units for the effect to begin at.
|-
| '''rotation''' || the orientation in degrees for the effect to fire in.
|-
| '''color''' || the color the weapon should be. 0: rogue, 1: red, 2: green, 3: blue, 4: purple 5: observer, 6: rabbit - note there is no observer super bolt texture.
|-
| '''tilt''' || the vertical tilt in degrees for the effect to fire in.
|-
| '''initdelay''' || the delay to wait after the server starts before the effect is triggered.
|-
| '''delay''' || a list of delays to loop through after the startup delay. (optional).
|-
| '''type''' || the [http://bzflag.org/documentation/flags FlagCode] for the flag effect to use for the weapon. Using V or A for example would create a high speed bullet while using SW would create a shockwave.
|-
| '''trigger''' || if a delay is not used, when to trigger the flag, currently only oncap is valid.
|-
| '''eventteam''' || the team to use when looking at oncap weapons. Use numeric values 1 - red 2 - green 3 - blue 4 - purple. Explodes when the flag of that team is captured.
|}

The weapon object can be used as many times as desired on a map.
The flag for the weapon must be specified in options. If a worldweapon is desired, without a corresponding flag on the ground, it can be specified without a quantity.  +f <flag>

==Appearance==
The weapon object will produce a weapon effect that is exactly the same as similar effects produced by players.

Be sure to note that if you specify an observer shot color and set the shot type to SB (SuperBullet) a white box will appear because there is no texture for an observer super bolt.

==History==
The weapon object was added in [[BZFlag 2.0.0|v2.0.0]].

==Editor Support==
The weapon object is only fully supported by the [[BZWTools]] blender plug-in.

==See also==
* [[Comparison of map editors|map editors]]
* [[Comparison of map objects|map objects]]
* [https://github.com/BZFlag-Dev/bzflag/blob/2.4/plugins/wwzones/README.wwzones.txt Wwzones] - a plug-in which can be used to create landmines, booby traps using world weapons.

[[Category:Map Making]]
[[Category:Map Objects]]