Wwzones - Revision history

Zehra: redirected page

2017-03-17T19:11:55Z

redirected page

← Older revision		Revision as of 19:11, 17 March 2017
Line 1:		Line 1:
	~~Wwzones is a standard~~ [[Plug-ins~~\|plug-in]] that is shipped with the [[BZFlag Source]] code. The plugin fires a map defined world weapon whenever a player is in a map defined volume.~~		#REDIRECT [[Plug-ins]]

	~~It can be used for landmines, booby traps, clearing campers in difficult locations, general amusement, etc.~~

	~~Multiple zones with different weapons, etc. may be used in same map file.~~

	~~=Usage=~~

	~~The general form of a wwzone [[BZW]] map entry looks like the following:~~

	~~wwzone~~
	~~cylinder <X> <Y> <Zmin> <Zmax> <radius>~~
	~~zoneweapon <flagType> <lifetime> <X> <Y> <Z> <tilt> <direction> <shotID> <nowiki><DT></nowiki>~~
	~~playermessage <message>~~
	~~servermessage <message>~~
	~~infomessage~~
	~~repeat <seconds>~~
	~~timedelay <seconds>~~
	~~end~~

	~~or with a bbox instead of a cylinder~~

	~~wwzone~~
	~~bbox <Xmin> <Xmax> <Ymin> <Ymax> <Zmin> <Zmax>~~
	~~zoneweapon <flagType> <lifetime> <X> <Y> <Z> <tilt> <direction> <shotID> <nowiki><DT></nowiki>~~
	~~playermessage <message>~~
	~~servermessage <message>~~
	~~infomessage~~
	~~repeat <seconds>~~
	~~timedelay <seconds>~~
	~~end~~

	~~=Parameters=~~

	~~===bbox / cylinder===~~


	~~These define the volume on the map that will trigger a world weapon whenever players enter it.~~

	~~bbox <Xmin> <Xmax> <Ymin> <Ymax> <Zmin> <Zmax>~~

	or

	~~cylinder <X> <Y> <Zmin> <Zmax> <radius>~~

	~~===zoneweapon===~~

	~~This defines the world weapon.<br />~~

	~~zoneweapon <flagType> <lifetime> <X> <Y> <Z> <tilt> <direction> <shotID> <nowiki><DT></nowiki>~~


	~~<properties>~~
	~~flagType=The [http://bzflag.org/documentation/flags FlagCode] of the weapon to be used. This must be a valid weapon.~~
	~~lifetime=Defines the lifetime of the weapon's shots in seconds.~~
	~~X Y Z=The position of the weapon. The xy-plane is the ground, and z is up.~~
	~~tilt=The tilt of the weapon, measured from the ground. Units are degrees.~~
	~~direction=Defines the direction of the weapon in the xy-plane (the ground). Units are degrees.~~
	~~shotID=All shots have an integer ID. This is the ID to be used for this shot. If this is 0, a shot ID will be automatically generated.~~
	~~DT= Defines the initial delay time of the world weapon in seconds.~~
	~~</properties>~~

	~~===playermessage===~~

	~~If used (optional), this sends a custom message to a player when he or she triggers the world weapon.~~

	~~playermessage "your message here"~~

	~~===servermessage===~~

	~~If used (optional), this sends a custom message to all players when a world weapon is triggered.~~

	~~servermessage "your message here"~~

	~~===infomessage===~~

	~~If used (optional), this will issue a standard message to all players, stating which type of world weapon was triggered by whom. This message cannot be customized.~~

	~~infomessage~~

	~~===repeat===~~

	If used (optional), this will repeat weapon fire while a player is in the defined volume. The parameter <seconds> defines the repeat time of the weapon (minimum 0.1 seconds). If <seconds> not specified, the default is 0.5 seconds. If repeat is not included in definition, the weapon will only fire once when a player enters the zone.

	~~repeat <seconds>~~

	~~===timedelay===~~
	~~If used (optional), this will delay the initial fire of the world weapon by the specified number of seconds.~~

	~~timedelay <seconds>~~

	~~=Examples=~~

	In the following example, a cuboid-shaped wwzone with the dimensions 50 x 50 x 1 and centered at (-50, 50, 1) is created. If a player remains in the defined zone for at least two seconds, a [[ShockWave]] weapon will fire in (approximately) 0.25 second intervals thereafter. The [[ShockWave]] world weapon is positioned at the coordinates (0, 0, 1), and the message, "You triggered Shockwave!" will be sent to the player who triggers it.
	{\|
	\|
	~~wwzone~~
	~~bbox -80 -30 -80 -30 0 2~~
	~~zoneweapon SW 1 0 0 1 0 0 0 0~~
	~~playermessage "You triggered Shockwave!~~
	~~repeat .25~~
	~~timedelay 2~~
	~~end~~
	\|}

	This will fire a laser in 0.5 second intervals while a player is in the volume defined by the bbox. In this example, the volume is a rectangular box with the dimensions 50 x 50 x 1 centered at the coordinates (50, 50, 1). The laser is positioned at the coordinates (5, 5, 1) and is tilted up 45 degrees from the xy-plane (the ground) with a heading of 25 degrees. When initially triggered, the message, "Laserz rule!" is sent to all players.
	{\|
	\|
	~~wwzone~~
	~~bbox 30 80 30 80 0 2~~
	~~zoneweapon L 1 5 5 1 45 25 0 0~~
	~~servermessage "Laserz rule!"~~
	~~repeat~~
	~~end~~
	\|}

	In this example, a cylindrical wwzone that fires a Guided Missile is defined. The defined volume has a radius of 20 [[World units]], a height of six, and is centered at the coordinates (50, -50, 3). The weapon is centered at (0, 0, 1) with both the tilt and heading set to 0 degrees. If a player remains in this volume for one second, the weapon will fire only once, and when it is triggered, the message, "GM triggered by <callsign>" is sent to all players.
	{\|
	\|
	~~wwzone~~
	~~cylinder 50 -50 0 6 20~~
	~~zoneweapon GM 1 0 0 1 0 0 0 0~~
	~~infomessage~~
	~~timedelay 1~~
	~~end~~
	\|}

	~~=External Links=~~
	* http://my.bzflag.org/bb/viewtopic.php?f=79&t=9949&p=98931&hilit=wwzones#p98931 Wwzones plugin page.

	~~[[Category:Development]]~~
	~~[[Category:Plug-Ins~~]]

Zehra: updated link to official documentation

2017-03-17T16:55:15Z

updated link to official documentation

← Older revision		Revision as of 16:55, 17 March 2017
Line 52:		Line 52:

	<properties>		<properties>
	flagType=The [[FlagCode]] of the weapon to be used. This must be a valid weapon.		flagType=The [http://bzflag.org/documentation/flags FlagCode] of the weapon to be used. This must be a valid weapon.
	lifetime=Defines the lifetime of the weapon's shots in seconds.		lifetime=Defines the lifetime of the weapon's shots in seconds.
	X Y Z=The position of the weapon. The xy-plane is the ground, and z is up.		X Y Z=The position of the weapon. The xy-plane is the ground, and z is up.

Zehra: updated information

2016-07-16T01:27:09Z

updated information

← Older revision		Revision as of 01:27, 16 July 2016
Line 1:		Line 1:
	The plugin ~~will fire~~ a map defined world weapon whenever a player is in a map defined volume.		Wwzones is a standard [[Plug-ins\|plug-in]] that is shipped with the [[BZFlag Source]] code. The plugin fires a map defined world weapon whenever a player is in a map defined volume.

	It ~~could~~ be used for landmines, booby traps, clearing campers in difficult locations, general amusement, etc.		It can be used for landmines, booby traps, clearing campers in difficult locations, general amusement, etc.

	Multiple zones with different weapons, etc. may be used in same map file.		Multiple zones with different weapons, etc. may be used in same map file.

Cobra Fast: complete article review, DoDoc removed

2010-09-28T15:46:25Z

complete article review, DoDoc removed

Show changes

Enigma at 17:34, 5 June 2008

2008-06-05T17:34:58Z

Show changes

76.110.232.25: /* Usage */

2008-06-05T17:22:34Z

Usage

← Older revision		Revision as of 17:22, 5 June 2008
Line 9:		Line 9:
	The general form of a wwzone [[BZW]] map entry looks like the following:		The general form of a wwzone [[BZW]] map entry looks like the following:

			{\|
			\|
	wwzone		wwzone
	cylinder <X> <Y> <Zmin> <Zmax> <radius>		cylinder <X> <Y> <Zmin> <Zmax> <radius>
Line 18:		Line 20:
	timedelay <seconds>		timedelay <seconds>
	end		end
			\|}

	or with a bbox instead of a cylinder		or with a bbox instead of a cylinder

			{\|
			\|
	wwzone		wwzone
	bbox <Xmin> <Xmax> <Ymin> <Ymax> <Zmin> <Zmax>		bbox <Xmin> <Xmax> <Ymin> <Ymax> <Zmin> <Zmax>
Line 30:		Line 35:
	timedelay <seconds>		timedelay <seconds>
	end		end
			\|}

	==Parameters==		==Parameters==

76.110.229.28: /* zoneweapon */

2008-06-04T20:16:26Z

zoneweapon

← Older revision		Revision as of 20:16, 4 June 2008
Line 74:		Line 74:
	\|-		\|-
	\|shotID		\|shotID
	\|All shots have an ID. This is the ID to be used for this shot.		\|All shots have an ID. This is the ID to be used for this shot. If this is 0, a shot ID will be automatically generated.
	\|Integer		\|Integer
	\|-		\|-

76.110.229.28: /* zoneweapon */

2008-05-25T07:39:06Z

zoneweapon

← Older revision		Revision as of 07:39, 25 May 2008
Line 54:		Line 54:
	\|-		\|-
	\| flagType		\| flagType
	\|The ~~flag abbreviation~~ of the weapon to be used. This must be a valid weapon.		\|The [[FlagCode]] of the weapon to be used. This must be a valid weapon.
	\|~~Flag Abbreviation~~		\|[[FlagCode]]
	\|-		\|-
	\| lifetime		\| lifetime

Enigma: /* Examples */ removed a word

2008-05-14T23:26:50Z

Examples: removed a word

← Older revision		Revision as of 23:26, 14 May 2008
Line 129:		Line 129:


	In this example, a cylindrical wwzone that fires a Guided Missile is defined. The defined volume has a radius of 20 [[World units]], a height of six, and is centered at the coordinates (50, -50, 3). The weapon is centered at (0, 0, 1) with a both the tilt and heading set to 0 degrees. If a player remains in this volume for one second, the weapon will fire only once, and when it is triggered, the message, "GM triggered by <callsign>" is sent to all players.		In this example, a cylindrical wwzone that fires a Guided Missile is defined. The defined volume has a radius of 20 [[World units]], a height of six, and is centered at the coordinates (50, -50, 3). The weapon is centered at (0, 0, 1) with both the tilt and heading set to 0 degrees. If a player remains in this volume for one second, the weapon will fire only once, and when it is triggered, the message, "GM triggered by <callsign>" is sent to all players.

	wwzone<br />		wwzone<br />

Enigma: /* zoneweapon */

2008-05-14T19:29:51Z

zoneweapon

← Older revision		Revision as of 19:29, 14 May 2008
Line 51:		Line 51:
	!Parameter		!Parameter
	!Description		!Description
			!Expected Input/Units
	\|-		\|-
	\| flagType		\| flagType
	\|The flag abbreviation of the weapon to be used. This must be a valid weapon.		\|The flag abbreviation of the weapon to be used. This must be a valid weapon.
			\|Flag Abbreviation
	\|-		\|-
	\| lifetime		\| lifetime
	\|Defines the lifetime of the weapon's shots.		\|Defines the lifetime of the weapon's shots.
			\|Seconds
	\|-		\|-
	\|X Y Z		\|X Y Z
	\|The position of the weapon. The xy-plane is the ground, and z is up.		\|The position of the weapon. The xy-plane is the ground, and z is up.
			\|[[World units]]
	\|-		\|-
	\|tilt		\|tilt
	\|The tilt ~~(in degrees)~~ of the weapon, measured from the ground.		\|The tilt of the weapon, measured from the ground.
			\|Degrees
	\|-		\|-
	\|direction		\|direction
	\|Defines the direction ~~(in degrees)~~ of the weapon in the xy-plane (the ground).		\|Defines the direction of the weapon in the xy-plane (the ground).
			\|Degrees
	\|-		\|-
	\|shotID		\|shotID
	\|All shots have an ID. This is the ID to be used for this shot.		\|All shots have an ID. This is the ID to be used for this shot.
			\|Integer
	\|-		\|-
	\|DT		\|DT
	\|Defines the initial delay time of the world weapon.		\|Defines the initial delay time of the world weapon.
			\|Seconds
	\|}		\|}