WeaponScripts - Revision history

Thexa4 at 10:46, 28 February 2019

2019-02-28T10:46:39Z

← Older revision		Revision as of 10:46, 28 February 2019
Line 67:		Line 67:
	[[WeaponScript.ExplosionSpeed \| ExplosionSpeed]]: how fast the explosion sprite fades (15 is default fps)<br>		[[WeaponScript.ExplosionSpeed \| ExplosionSpeed]]: how fast the explosion sprite fades (15 is default fps)<br>
	[[WeaponScript.TracerType \| Tracer Type]]: Tracer effect, tracer names are logical, a list: tracer_du, tracer_bio, tracer_he, tracer_rifle, tracer_smg, tracer_vehiclemg, tracer_cg, tracer_plasma<br>		[[WeaponScript.TracerType \| Tracer Type]]: Tracer effect, tracer names are logical, a list: tracer_du, tracer_bio, tracer_he, tracer_rifle, tracer_smg, tracer_vehiclemg, tracer_cg, tracer_plasma<br>


			== source ==
			<pre>
			// get english text
			const char *name = pWeaponData->GetString("Name", "Name");
			const char *hudName = pWeaponData->GetString("HUD Name", "HUD Name");
			const char *description = pWeaponData->GetString("Description", "Description of item goes here.");

			#if CLIENT_DLL
			// perform translation client only
			const char *transName = g_pVGuiLocalize->FindAsUTF8(name);
			Q_strncpy(vehicleWeapon[i]->name, transName, sizeof(vehicleWeapon[i]->name));

			const char *transHudName = g_pVGuiLocalize->FindAsUTF8(hudName);
			Q_strncpy(vehicleWeapon[i]->hudName, transHudName, sizeof(vehicleWeapon[i]->name));

			const char *transDesc = g_pVGuiLocalize->FindAsUTF8(description);
			ExpandPrintFKeyNames(vehicleWeapon[i]->description, sizeof(vehicleWeapon[i]->description), transDesc);
			#else
			// just copy the english if not a client
			Q_strncpy(vehicleWeapon[i]->name, name, sizeof(vehicleWeapon[i]->name));
			Q_strncpy(vehicleWeapon[i]->hudName, hudName, sizeof(vehicleWeapon[i]->name));
			ExpandPrintFKeyNames(vehicleWeapon[i]->description, sizeof(vehicleWeapon[i]->description), description);
			#endif

			Q_strncpy(vehicleWeapon[i]->icon, pWeaponData->GetString("Icon", ""), sizeof(vehicleWeapon[i]->icon));
			Q_strncpy(vehicleWeapon[i]->hudIcon, pWeaponData->GetString("HUD Icon", ""), sizeof(vehicleWeapon[i]->hudIcon));
			Q_strncpy(vehicleWeapon[i]->soundReloading, pWeaponData->GetString("Sound Reloading", ""), sizeof(vehicleWeapon[i]->soundReloading));
			Q_strncpy(vehicleWeapon[i]->soundImpact, pWeaponData->GetString("Sound Impact", ""), sizeof(vehicleWeapon[i]->soundImpact));
			Q_strncpy(vehicleWeapon[i]->soundFiring, pWeaponData->GetString("Sound Firing", ""), sizeof(vehicleWeapon[i]->soundFiring));
			vehicleWeapon[i]->size = pWeaponData->GetInt("Size", 1);
			vehicleWeapon[i]->type = pWeaponData->GetInt("Type", 0);
			vehicleWeapon[i]->cost = pWeaponData->GetInt("Cost", 5);
			vehicleWeapon[i]->ammoType = pWeaponData->GetInt("Ammo Type", 0);

			vehicleWeapon[i]->damage = pWeaponData->GetFloat("Damage", 50);
			vehicleWeapon[i]->explosionRadius = pWeaponData->GetInt("Explosion Radius", 0);
			vehicleWeapon[i]->explosionForce = pWeaponData->GetFloat("Explosion Force", 0);
			vehicleWeapon[i]->spread = pWeaponData->GetFloat("Projectile Spread", 0.001f);
			vehicleWeapon[i]->speed = pWeaponData->GetInt("Speed", 100);
			vehicleWeapon[i]->gravity = pWeaponData->GetFloat("Gravity", 1.0f);
			vehicleWeapon[i]->heat = pWeaponData->GetFloat("Heat", 0.1f);
			vehicleWeapon[i]->heatToTarget = pWeaponData->GetFloat("Heat To Target", 0.1f);
			vehicleWeapon[i]->dotRadius = pWeaponData->GetFloat("Damage Over Time Radius");
			vehicleWeapon[i]->dotLength = pWeaponData->GetFloat("Damage Over Time Length");
			vehicleWeapon[i]->dotInterval = pWeaponData->GetFloat("Damage Over Time Interval");
			vehicleWeapon[i]->m_flPlayerBioDamage = pWeaponData->GetFloat("Player Bio Damage", 0);
			vehicleWeapon[i]->m_flPlayerBioTime = pWeaponData->GetFloat("Player Bio Time", 0);
			vehicleWeapon[i]->m_flPlayerBioInterval = pWeaponData->GetFloat("Player Bio Interval", 0);
			vehicleWeapon[i]->m_flVehicleBioDamage = pWeaponData->GetFloat("Vehicle Bio Damage", 0);
			vehicleWeapon[i]->m_flVehicleBioTime = pWeaponData->GetFloat("Vehicle Bio Time", 0);
			vehicleWeapon[i]->m_flVehicleBioInterval = pWeaponData->GetFloat("Vehicle Bio Interval", 0);
			vehicleWeapon[i]->weight = pWeaponData->GetInt("Weight", 10);
			vehicleWeapon[i]->cycleTime = pWeaponData->GetFloat("Cycle Time", 0.1f);
			vehicleWeapon[i]->ammoClipSize = pWeaponData->GetInt("Clip Size", 10);
			vehicleWeapon[i]->ammoTotal = pWeaponData->GetInt("Total Ammo Clips", 1);
			vehicleWeapon[i]->ammoUnlimited = pWeaponData->GetInt("Unlimited Ammo", 1) != 0;
			vehicleWeapon[i]->reloadAmount = pWeaponData->GetInt("Reload Amount", 1);
			vehicleWeapon[i]->reloadTime = pWeaponData->GetFloat("Reload Time", 20);
			vehicleWeapon[i]->dumb = pWeaponData->GetInt("Dumb Missile", 0) != 0;
			vehicleWeapon[i]->homing = pWeaponData->GetInt("Homing Missile", 0) != 0;
			vehicleWeapon[i]->guided = pWeaponData->GetInt("Guided Missile", 0) != 0;
			vehicleWeapon[i]->range = pWeaponData->GetFloat("Missile Range", 2000);
			vehicleWeapon[i]->lockOnTime = pWeaponData->GetFloat("Lock On Time", 3.0f);
			vehicleWeapon[i]->lockOnRadius = pWeaponData->GetFloat("Lock On Radius", 10.0f);
			vehicleWeapon[i]->lockOnRangeModifier = pWeaponData->GetFloat("Lock Range Modifier", 0.001f);
			vehicleWeapon[i]->countermeasureEffectiveness = pWeaponData->GetFloat("Countermeasure Effectiveness", 0.9f);
			vehicleWeapon[i]->turningSpeed = pWeaponData->GetFloat("Turning Ability", 0.1f);
			vehicleWeapon[i]->framerate = pWeaponData->GetInt("Explosion Speed", 15);
			vehicleWeapon[i]->sprite = pWeaponData->GetInt("Explosion Sprite", 0);
			vehicleWeapon[i]->drawImpactEffects = pWeaponData->GetInt("Draw Impact Effects", 1) != 0;
			vehicleWeapon[i]->falloffStart = pWeaponData->GetInt("FalloffStart", 5000);
			vehicleWeapon[i]->falloffEnd = pWeaponData->GetInt("FalloffEnd", 10000);
			vehicleWeapon[i]->minimumDamage = pWeaponData->GetInt("MinimalDamage", 1);
			vehicleWeapon[i]->grenadeTimer = pWeaponData->GetFloat("Grenade Timer", 6);
			Q_strncpy(vehicleWeapon[i]->tracerName, pWeaponData->GetString("Tracer Type", "tracer_1"), sizeof(vehicleWeapon[i]->tracerName));
			Q_strncpy(vehicleWeapon[i]->muzzleFlashName, pWeaponData->GetString("Muzzle Flash", ""), sizeof(vehicleWeapon[i]->muzzleFlashName));
			</pre>

Thexa4 at 12:53, 26 August 2017

2017-08-26T12:53:38Z

← Older revision		Revision as of 12:53, 26 August 2017
Line 2:		Line 2:
	__NOTOC__		__NOTOC__
	==Overview==		==Overview==
	This is a glossary of all the attributes that can be used in a vehicle weapon script.		This is a glossary of all the attributes that can be used in a vehicle weapon script. The weapon script file can be found in <code>scripts/vehicle_weapons.txt</code>

	You place comments in a script file by putting a "//" in front of the comment.		You place comments in a script file by putting a "//" in front of the comment.

Thexa4: /* Weapon Characteristics */

2017-06-24T20:12:00Z

Weapon Characteristics

← Older revision		Revision as of 20:12, 24 June 2017
Line 40:		Line 40:
	[[WeaponScript.ProjectileSpread \| Projectile Spread]]: only applicable to machine guns at the moment. A value of 1 is likely a full 180 degree cone.<br>		[[WeaponScript.ProjectileSpread \| Projectile Spread]]: only applicable to machine guns at the moment. A value of 1 is likely a full 180 degree cone.<br>
	[[WeaponScript.HeatToTarget \| Heat To Target]]: Amount of heat inflicted on the target upon impact. (not included the heat added by the damage to heat modifier of armor).<br>		[[WeaponScript.HeatToTarget \| Heat To Target]]: Amount of heat inflicted on the target upon impact. (not included the heat added by the damage to heat modifier of armor).<br>
	~~[[WeaponScript.Inertia \| Inertia]]: Determines if the velocity of the vehicle firing the weapon affects the velocity of the projectile fired.<br>~~
	[[WeaponScript.ExplosionRadius \| Explosion Radius]]: The amount of area around the impact location of a projectile affected by the impact. Making this value too large can bog-down servers. Current range is from 0 to 2000+.<br>		[[WeaponScript.ExplosionRadius \| Explosion Radius]]: The amount of area around the impact location of a projectile affected by the impact. Making this value too large can bog-down servers. Current range is from 0 to 2000+.<br>
	[[WeaponScript.ExplosionForce \| Explosion Force]]: amount of concussive force applied to physics objects in the blast radius.<br>		[[WeaponScript.ExplosionForce \| Explosion Force]]: amount of concussive force applied to physics objects in the blast radius.<br>

Gilmore110j: Reordered page somewhat.

2010-05-08T21:56:53Z

Reordered page somewhat.

← Older revision		Revision as of 21:56, 8 May 2010
Line 1:		Line 1:
			{{ScriptingDocumentation}}
			__NOTOC__
			==Overview==
			This is a glossary of all the attributes that can be used in a vehicle weapon script.

			You place comments in a script file by putting a "//" in front of the comment.

			==General Characteristics==
	[[WeaponScript.Name \| Name]]: name given when selecting weapons.<br>		[[WeaponScript.Name \| Name]]: name given when selecting weapons.<br>
	[[WeaponScript.HUDName \| HUD Name]]: name displayed in the weapon area of the vehicle HUD<br>		[[WeaponScript.HUDName \| HUD Name]]: name displayed in the weapon area of the vehicle HUD<br>
Line 9:		Line 17:
	[[WeaponScript.Team \| Team]]: Which team is allowed to use it. Current possible values ['IMP','NF','ALL'].<br>		[[WeaponScript.Team \| Team]]: Which team is allowed to use it. Current possible values ['IMP','NF','ALL'].<br>
	[[WeaponScript.Research \| Research]]: The name of a research item that unlocks this weapon, taken from the research scripts.<br>		[[WeaponScript.Research \| Research]]: The name of a research item that unlocks this weapon, taken from the research scripts.<br>

			==Sound Characteristics==
	[[WeaponScript.SoundFiring \| Sound Firing]]: The sound played when weapon is being fired.<br>		[[WeaponScript.SoundFiring \| Sound Firing]]: The sound played when weapon is being fired.<br>
	[[WeaponScript.SoundImpact \| Sound Impact]]: The sound played when the weapon makes its final impact.<br>		[[WeaponScript.SoundImpact \| Sound Impact]]: The sound played when the weapon makes its final impact.<br>
	[[WeaponScript.SoundReloading \| Sound Reloading]]: The sound played when the weapon reloads.<br>		[[WeaponScript.SoundReloading \| Sound Reloading]]: The sound played when the weapon reloads.<br>

			==Weapon Characteristics==
	[[WeaponScript.DamageType \| Damage Type]]: The name of a damage type to be used by the resistance system.<br>		[[WeaponScript.DamageType \| Damage Type]]: The name of a damage type to be used by the resistance system.<br>
	[[WeaponScript.AmmoType \| Ammo Type]]: This value determines what things mg weapons can damage. 0=infantry, 1=infantry+vehicles, 2=buildings+vehicles+infantry.<br>		[[WeaponScript.AmmoType \| Ammo Type]]: This value determines what things mg weapons can damage. 0=infantry, 1=infantry+vehicles, 2=buildings+vehicles+infantry.<br>
	[[WeaponScript.Damage \| Damage]]: The amount of damage inflicted to an enemy target on impact. This value is affected by many things.<br>		[[WeaponScript.Damage \| Damage]]: The amount of damage inflicted to an enemy target on impact. This value is affected by many things.<br>
			[[WeaponScript.MinimalDamage \| MinimalDamage]]<br>
			[[WeaponScript.Falloff \| Falloff]]<br>
			[[WeaponScript.Falloffbase \| Falloffbase]]<br>
	[[WeaponScript.Speed \| Speed]]: The initial velocity of the projectile.<br>		[[WeaponScript.Speed \| Speed]]: The initial velocity of the projectile.<br>
	[[WeaponScript.Gravity \| Gravity]]: effects of gravity on the projectile, only for projectiles. Gravity should normally be constant, although this value is often messed with to compansate for short-comings of the speed modifier.<br>		[[WeaponScript.Gravity \| Gravity]]: effects of gravity on the projectile, only for projectiles. Gravity should normally be constant, although this value is often messed with to compansate for short-comings of the speed modifier.<br>
Line 28:		Line 43:
	[[WeaponScript.ExplosionRadius \| Explosion Radius]]: The amount of area around the impact location of a projectile affected by the impact. Making this value too large can bog-down servers. Current range is from 0 to 2000+.<br>		[[WeaponScript.ExplosionRadius \| Explosion Radius]]: The amount of area around the impact location of a projectile affected by the impact. Making this value too large can bog-down servers. Current range is from 0 to 2000+.<br>
	[[WeaponScript.ExplosionForce \| Explosion Force]]: amount of concussive force applied to physics objects in the blast radius.<br>		[[WeaponScript.ExplosionForce \| Explosion Force]]: amount of concussive force applied to physics objects in the blast radius.<br>

			===Variables for missiles===

	[[WeaponScript.DumbMissile \| Dumb Missile]]: '1' if missile flies straight ahead<br>		[[WeaponScript.DumbMissile \| Dumb Missile]]: '1' if missile flies straight ahead<br>
	[[WeaponScript.HomingMissile \| Homing Missile]]: '1' if missile flies towards locked on target		[[WeaponScript.HomingMissile \| Homing Missile]]: '1' if missile flies towards locked on target
Line 37:		Line 55:
	[[WeaponScript.CountermeasureEffectiveness \| Countermeasure Effectiveness]]<br>		[[WeaponScript.CountermeasureEffectiveness \| Countermeasure Effectiveness]]<br>
	[[WeaponScript.TurningAbility \| Turning Ability]]: determines how effective the missile can turn to home in on its target or guide itself to the crosshair for a guided missile; 1.0 means the missile can turn instantly towards its target, 0.0 and the missile doesn't turn at all<br>		[[WeaponScript.TurningAbility \| Turning Ability]]: determines how effective the missile can turn to home in on its target or guide itself to the crosshair for a guided missile; 1.0 means the missile can turn instantly towards its target, 0.0 and the missile doesn't turn at all<br>

			===Variables for bio damage===
	[[WeaponScript.PlayerBioDamage \| Player Bio Damage]]: damage inflicted to players every interval<br>		[[WeaponScript.PlayerBioDamage \| Player Bio Damage]]: damage inflicted to players every interval<br>
	[[WeaponScript.PlayerBioTime \| Player Bio Time]]: total time to inflict damage to players<br>		[[WeaponScript.PlayerBioTime \| Player Bio Time]]: total time to inflict damage to players<br>
Line 43:		Line 63:
	[[WeaponScript.VehicleBioTime \| Vehicle Bio Time]]: total time to inflict damage to s vehicle<br>		[[WeaponScript.VehicleBioTime \| Vehicle Bio Time]]: total time to inflict damage to s vehicle<br>
	[[WeaponScript.VehicleBioInterval \| Vehicle Bio Interval]]: time inbetween each infliction of damage to a vehicle<br>		[[WeaponScript.VehicleBioInterval \| Vehicle Bio Interval]]: time inbetween each infliction of damage to a vehicle<br>

			===Variables for particles===
	[[WeaponScript.ExplosionSprite \| ExplosionSprite]]: explosion sprite to use for explosion, 0 = default, 1 = green (bio), 2 = blue (plasma)<br>		[[WeaponScript.ExplosionSprite \| ExplosionSprite]]: explosion sprite to use for explosion, 0 = default, 1 = green (bio), 2 = blue (plasma)<br>
	[[WeaponScript.ExplosionSpeed \| ExplosionSpeed]]: how fast the explosion sprite fades (15 is default fps)<br>		[[WeaponScript.ExplosionSpeed \| ExplosionSpeed]]: how fast the explosion sprite fades (15 is default fps)<br>
	[[WeaponScript.TracerType \| Tracer Type]]: Tracer effect, tracer names are logical, a list: tracer_du, tracer_bio, tracer_he, tracer_rifle, tracer_smg, tracer_vehiclemg, tracer_cg, tracer_plasma<br>		[[WeaponScript.TracerType \| Tracer Type]]: Tracer effect, tracer names are logical, a list: tracer_du, tracer_bio, tracer_he, tracer_rifle, tracer_smg, tracer_vehiclemg, tracer_cg, tracer_plasma<br>
	~~[[WeaponScript.Falloff \| Falloff]]<br>~~
	~~[[WeaponScript.Falloffbase \| Falloffbase]]<br>~~
	~~[[WeaponScript.MinimalDamage \| MinimalDamage]]<br>~~

Administrator at 07:17, 21 January 2010

2010-01-21T07:17:57Z

← Older revision		Revision as of 07:17, 21 January 2010
Line 1:		Line 1:
	[[WeaponScript.Name \| Name]]<br>		[[WeaponScript.Name \| Name]]: name given when selecting weapons.<br>
	[[WeaponScript.HUDName \| HUD Name]]<br>		[[WeaponScript.HUDName \| HUD Name]]: name displayed in the weapon area of the vehicle HUD<br>
	[[WeaponScript.Description \| Description]]<br>		[[WeaponScript.Description \| Description]]: description given when selecting weapons<br>
	[[WeaponScript.Icon \| Icon]]<br>		[[WeaponScript.Icon \| Icon]]: icon drawn in the GUI<br>
	[[WeaponScript.HUDIcon \| HUD Icon]]<br>		[[WeaponScript.HUDIcon \| HUD Icon]]: icon drawn in the vehicle HUD<br>
	[[WeaponScript.Size \| Size]]<br>		[[WeaponScript.Size \| Size]]: number of slots required when selecting weapons. Current possible values [1,2,3].<br>
	[[WeaponScript.Type \| Type]]<br>		[[WeaponScript.Type \| Type]]: 0=machine gun, 1=tank cannon, 2=artillery cannon, 3=missile launcher, 4=grenade launcher, 5=aircraft bomb bay<br>
	[[WeaponScript.Cost \| Cost]]<br>		[[WeaponScript.Cost \| Cost]]: The amount of resources required(deducted from the team) to equip a tank with the weapon.<br>
	[[WeaponScript.Team \| Team]]<br>		[[WeaponScript.Team \| Team]]: Which team is allowed to use it. Current possible values ['IMP','NF','ALL'].<br>
	[[WeaponScript.Research \| Research]]<br>		[[WeaponScript.Research \| Research]]: The name of a research item that unlocks this weapon, taken from the research scripts.<br>
	[[WeaponScript.SoundFiring \| Sound Firing]]<br>		[[WeaponScript.SoundFiring \| Sound Firing]]: The sound played when weapon is being fired.<br>
	[[WeaponScript.SoundImpact \| Sound Impact]]<br>		[[WeaponScript.SoundImpact \| Sound Impact]]: The sound played when the weapon makes its final impact.<br>
	[[WeaponScript.SoundReloading \| Sound Reloading]]<br>		[[WeaponScript.SoundReloading \| Sound Reloading]]: The sound played when the weapon reloads.<br>
	[[WeaponScript.DamageType \| Damage Type]]<br>		[[WeaponScript.DamageType \| Damage Type]]: The name of a damage type to be used by the resistance system.<br>
	[[WeaponScript.AmmoType \| Ammo Type]]<br>		[[WeaponScript.AmmoType \| Ammo Type]]: This value determines what things mg weapons can damage. 0=infantry, 1=infantry+vehicles, 2=buildings+vehicles+infantry.<br>
	[[WeaponScript.Damage \| Damage]]<br>		[[WeaponScript.Damage \| Damage]]: The amount of damage inflicted to an enemy target on impact. This value is affected by many things.<br>
	[[WeaponScript.Speed \| Speed]]<br>		[[WeaponScript.Speed \| Speed]]: The initial velocity of the projectile.<br>
	[[WeaponScript.Gravity \| Gravity]]<br>		[[WeaponScript.Gravity \| Gravity]]: effects of gravity on the projectile, only for projectiles. Gravity should normally be constant, although this value is often messed with to compansate for short-comings of the speed modifier.<br>
	[[WeaponScript.Heat \| Heat]]<br>		[[WeaponScript.Heat \| Heat]]: Amount of heat inflicted on self when weapon is fired. Vehicles have 200 heat points before they over-heat.<br>
	[[WeaponScript.Weight \| Weight]]<br>		[[WeaponScript.Weight \| Weight]]: weight in terms of effects on engine and weight restrictions for chassis<br>
	[[WeaponScript.CycleTime \| Cycle Time]]<br>		[[WeaponScript.CycleTime \| Cycle Time]]: time between shots in seconds<br>
	[[WeaponScript.ClipSize \| Clip Size]]<br>		[[WeaponScript.ClipSize \| Clip Size]]: number of shots before reload.<br>
	[[WeaponScript.TotalAmmoClips \| Total Ammo Clips]]<br>		[[WeaponScript.TotalAmmoClips \| Total Ammo Clips]]: number of possible reloads.<br>
	[[WeaponScript.ReloadTime \| Reload Time]]<br>		[[WeaponScript.ReloadTime \| Reload Time]]: time spent reloading in seconds.<br>
	[[WeaponScript.ProjectileSpread \| Projectile Spread]]<br>		[[WeaponScript.ProjectileSpread \| Projectile Spread]]: only applicable to machine guns at the moment. A value of 1 is likely a full 180 degree cone.<br>
	[[WeaponScript.HeatToTarget \| Heat To Target]]<br>		[[WeaponScript.HeatToTarget \| Heat To Target]]: Amount of heat inflicted on the target upon impact. (not included the heat added by the damage to heat modifier of armor).<br>
	[[WeaponScript.Inertia \| Inertia]]<br>		[[WeaponScript.Inertia \| Inertia]]: Determines if the velocity of the vehicle firing the weapon affects the velocity of the projectile fired.<br>
	[[WeaponScript.ExplosionRadius \| Explosion Radius]]<br>		[[WeaponScript.ExplosionRadius \| Explosion Radius]]: The amount of area around the impact location of a projectile affected by the impact. Making this value too large can bog-down servers. Current range is from 0 to 2000+.<br>
	[[WeaponScript.ExplosionForce \| Explosion Force]]<br>		[[WeaponScript.ExplosionForce \| Explosion Force]]: amount of concussive force applied to physics objects in the blast radius.<br>
	[[WeaponScript.DumbMissile \| Dumb Missile]]<br>		[[WeaponScript.DumbMissile \| Dumb Missile]]: '1' if missile flies straight ahead<br>
	[[WeaponScript.HomingMissile \| Homing Missile]]<br>		[[WeaponScript.HomingMissile \| Homing Missile]]: '1' if missile flies towards locked on target
	[[WeaponScript.GuidedMissile \| Guided Missile]]<br>		<br>
	[[WeaponScript.MissileRange \| Missile Range]]<br>		[[WeaponScript.GuidedMissile \| Guided Missile]]: '1' if missile follows crosshairs after launch<br>
	[[WeaponScript.LockOnTime \| Lock On Time]]<br>		[[WeaponScript.MissileRange \| Missile Range]]: max range in HL2 units (1 inch = 1) that the player can lock onto a target with a homing missile, or range from vehicle being fired from when a guided missile stops following the player's crosshairs<br>
	[[WeaponScript.LockRangeModifier \| Lock Range Modifier]]<br>		[[WeaponScript.LockOnTime \| Lock On Time]]: time it takes for a homing missile to lock onto the target under the player crosshairs<br>
			[[WeaponScript.LockRangeModifier \| Lock Range Modifier]]: modifies lock on time based on range (as range increases, lock on time increases based on the modifier: modifier * range to target + lock on time = total lock on time)<br>
	[[WeaponScript.CountermeasureEffectiveness \| Countermeasure Effectiveness]]<br>		[[WeaponScript.CountermeasureEffectiveness \| Countermeasure Effectiveness]]<br>
	[[WeaponScript.TurningAbility \| Turning Ability]]<br>		[[WeaponScript.TurningAbility \| Turning Ability]]: determines how effective the missile can turn to home in on its target or guide itself to the crosshair for a guided missile; 1.0 means the missile can turn instantly towards its target, 0.0 and the missile doesn't turn at all<br>
	[[WeaponScript.PlayerBioDamage \| Player Bio Damage]]<br>		[[WeaponScript.PlayerBioDamage \| Player Bio Damage]]: damage inflicted to players every interval<br>
	[[WeaponScript.PlayerBioTime \| Player Bio Time]]<br>		[[WeaponScript.PlayerBioTime \| Player Bio Time]]: total time to inflict damage to players<br>
	[[WeaponScript.PlayerBioInterval \| Player Bio Interval]]<br>		[[WeaponScript.PlayerBioInterval \| Player Bio Interval]]: time inbetween each infliction of damage to players<br>
	[[WeaponScript.VehicleBioDamage \| Vehicle Bio Damage]]<br>		[[WeaponScript.VehicleBioDamage \| Vehicle Bio Damage]]: damage inflicted to a vehicle every interval<br>
	[[WeaponScript.VehicleBioTime \| Vehicle Bio Time]]<br>		[[WeaponScript.VehicleBioTime \| Vehicle Bio Time]]: total time to inflict damage to s vehicle<br>
	[[WeaponScript.VehicleBioInterval \| Vehicle Bio Interval]]<br>		[[WeaponScript.VehicleBioInterval \| Vehicle Bio Interval]]: time inbetween each infliction of damage to a vehicle<br>
	[[WeaponScript.TracerType \| Tracer Type]]<br>		[[WeaponScript.ExplosionSprite \| ExplosionSprite]]: explosion sprite to use for explosion, 0 = default, 1 = green (bio), 2 = blue (plasma)<br>
			[[WeaponScript.ExplosionSpeed \| ExplosionSpeed]]: how fast the explosion sprite fades (15 is default fps)<br>
			[[WeaponScript.TracerType \| Tracer Type]]: Tracer effect, tracer names are logical, a list: tracer_du, tracer_bio, tracer_he, tracer_rifle, tracer_smg, tracer_vehiclemg, tracer_cg, tracer_plasma<br>
	[[WeaponScript.Falloff \| Falloff]]<br>		[[WeaponScript.Falloff \| Falloff]]<br>
	[[WeaponScript.Falloffbase \| Falloffbase]]<br>		[[WeaponScript.Falloffbase \| Falloffbase]]<br>
	[[WeaponScript.MinimalDamage \| MinimalDamage]]<br>		[[WeaponScript.MinimalDamage \| MinimalDamage]]<br>

Trickster: New page: Name
HUD Name
Description
Icon
HUD Icon...

2009-09-09T01:50:07Z

New page: Name HUD Name Description Icon HUD Icon...

New page

← Older revision		Revision as of 20:12, 24 June 2017
Line 40:		Line 40:
	[[WeaponScript.ProjectileSpread \| Projectile Spread]]: only applicable to machine guns at the moment. A value of 1 is likely a full 180 degree cone.<br>		[[WeaponScript.ProjectileSpread \| Projectile Spread]]: only applicable to machine guns at the moment. A value of 1 is likely a full 180 degree cone.<br>
	[[WeaponScript.HeatToTarget \| Heat To Target]]: Amount of heat inflicted on the target upon impact. (not included the heat added by the damage to heat modifier of armor).<br>		[[WeaponScript.HeatToTarget \| Heat To Target]]: Amount of heat inflicted on the target upon impact. (not included the heat added by the damage to heat modifier of armor).<br>
	~~[[WeaponScript.Inertia \| Inertia]]: Determines if the velocity of the vehicle firing the weapon affects the velocity of the projectile fired.<br>~~
	[[WeaponScript.ExplosionRadius \| Explosion Radius]]: The amount of area around the impact location of a projectile affected by the impact. Making this value too large can bog-down servers. Current range is from 0 to 2000+.<br>		[[WeaponScript.ExplosionRadius \| Explosion Radius]]: The amount of area around the impact location of a projectile affected by the impact. Making this value too large can bog-down servers. Current range is from 0 to 2000+.<br>
	[[WeaponScript.ExplosionForce \| Explosion Force]]: amount of concussive force applied to physics objects in the blast radius.<br>		[[WeaponScript.ExplosionForce \| Explosion Force]]: amount of concussive force applied to physics objects in the blast radius.<br>

← Older revision		Revision as of 21:56, 8 May 2010
Line 1:		Line 1:
			{{ScriptingDocumentation}}
			__NOTOC__
			==Overview==
			This is a glossary of all the attributes that can be used in a vehicle weapon script.

			You place comments in a script file by putting a "//" in front of the comment.

			==General Characteristics==
	[[WeaponScript.Name \| Name]]: name given when selecting weapons.<br>		[[WeaponScript.Name \| Name]]: name given when selecting weapons.<br>
	[[WeaponScript.HUDName \| HUD Name]]: name displayed in the weapon area of the vehicle HUD<br>		[[WeaponScript.HUDName \| HUD Name]]: name displayed in the weapon area of the vehicle HUD<br>
Line 9:		Line 17:
	[[WeaponScript.Team \| Team]]: Which team is allowed to use it. Current possible values ['IMP','NF','ALL'].<br>		[[WeaponScript.Team \| Team]]: Which team is allowed to use it. Current possible values ['IMP','NF','ALL'].<br>
	[[WeaponScript.Research \| Research]]: The name of a research item that unlocks this weapon, taken from the research scripts.<br>		[[WeaponScript.Research \| Research]]: The name of a research item that unlocks this weapon, taken from the research scripts.<br>

			==Sound Characteristics==
	[[WeaponScript.SoundFiring \| Sound Firing]]: The sound played when weapon is being fired.<br>		[[WeaponScript.SoundFiring \| Sound Firing]]: The sound played when weapon is being fired.<br>
	[[WeaponScript.SoundImpact \| Sound Impact]]: The sound played when the weapon makes its final impact.<br>		[[WeaponScript.SoundImpact \| Sound Impact]]: The sound played when the weapon makes its final impact.<br>
	[[WeaponScript.SoundReloading \| Sound Reloading]]: The sound played when the weapon reloads.<br>		[[WeaponScript.SoundReloading \| Sound Reloading]]: The sound played when the weapon reloads.<br>

			==Weapon Characteristics==
	[[WeaponScript.DamageType \| Damage Type]]: The name of a damage type to be used by the resistance system.<br>		[[WeaponScript.DamageType \| Damage Type]]: The name of a damage type to be used by the resistance system.<br>
	[[WeaponScript.AmmoType \| Ammo Type]]: This value determines what things mg weapons can damage. 0=infantry, 1=infantry+vehicles, 2=buildings+vehicles+infantry.<br>		[[WeaponScript.AmmoType \| Ammo Type]]: This value determines what things mg weapons can damage. 0=infantry, 1=infantry+vehicles, 2=buildings+vehicles+infantry.<br>
	[[WeaponScript.Damage \| Damage]]: The amount of damage inflicted to an enemy target on impact. This value is affected by many things.<br>		[[WeaponScript.Damage \| Damage]]: The amount of damage inflicted to an enemy target on impact. This value is affected by many things.<br>
			[[WeaponScript.MinimalDamage \| MinimalDamage]]<br>
			[[WeaponScript.Falloff \| Falloff]]<br>
			[[WeaponScript.Falloffbase \| Falloffbase]]<br>
	[[WeaponScript.Speed \| Speed]]: The initial velocity of the projectile.<br>		[[WeaponScript.Speed \| Speed]]: The initial velocity of the projectile.<br>
	[[WeaponScript.Gravity \| Gravity]]: effects of gravity on the projectile, only for projectiles. Gravity should normally be constant, although this value is often messed with to compansate for short-comings of the speed modifier.<br>		[[WeaponScript.Gravity \| Gravity]]: effects of gravity on the projectile, only for projectiles. Gravity should normally be constant, although this value is often messed with to compansate for short-comings of the speed modifier.<br>
Line 28:		Line 43:
	[[WeaponScript.ExplosionRadius \| Explosion Radius]]: The amount of area around the impact location of a projectile affected by the impact. Making this value too large can bog-down servers. Current range is from 0 to 2000+.<br>		[[WeaponScript.ExplosionRadius \| Explosion Radius]]: The amount of area around the impact location of a projectile affected by the impact. Making this value too large can bog-down servers. Current range is from 0 to 2000+.<br>
	[[WeaponScript.ExplosionForce \| Explosion Force]]: amount of concussive force applied to physics objects in the blast radius.<br>		[[WeaponScript.ExplosionForce \| Explosion Force]]: amount of concussive force applied to physics objects in the blast radius.<br>

			===Variables for missiles===

	[[WeaponScript.DumbMissile \| Dumb Missile]]: '1' if missile flies straight ahead<br>		[[WeaponScript.DumbMissile \| Dumb Missile]]: '1' if missile flies straight ahead<br>
	[[WeaponScript.HomingMissile \| Homing Missile]]: '1' if missile flies towards locked on target		[[WeaponScript.HomingMissile \| Homing Missile]]: '1' if missile flies towards locked on target
Line 37:		Line 55:
	[[WeaponScript.CountermeasureEffectiveness \| Countermeasure Effectiveness]]<br>		[[WeaponScript.CountermeasureEffectiveness \| Countermeasure Effectiveness]]<br>
	[[WeaponScript.TurningAbility \| Turning Ability]]: determines how effective the missile can turn to home in on its target or guide itself to the crosshair for a guided missile; 1.0 means the missile can turn instantly towards its target, 0.0 and the missile doesn't turn at all<br>		[[WeaponScript.TurningAbility \| Turning Ability]]: determines how effective the missile can turn to home in on its target or guide itself to the crosshair for a guided missile; 1.0 means the missile can turn instantly towards its target, 0.0 and the missile doesn't turn at all<br>

			===Variables for bio damage===
	[[WeaponScript.PlayerBioDamage \| Player Bio Damage]]: damage inflicted to players every interval<br>		[[WeaponScript.PlayerBioDamage \| Player Bio Damage]]: damage inflicted to players every interval<br>
	[[WeaponScript.PlayerBioTime \| Player Bio Time]]: total time to inflict damage to players<br>		[[WeaponScript.PlayerBioTime \| Player Bio Time]]: total time to inflict damage to players<br>
Line 43:		Line 63:
	[[WeaponScript.VehicleBioTime \| Vehicle Bio Time]]: total time to inflict damage to s vehicle<br>		[[WeaponScript.VehicleBioTime \| Vehicle Bio Time]]: total time to inflict damage to s vehicle<br>
	[[WeaponScript.VehicleBioInterval \| Vehicle Bio Interval]]: time inbetween each infliction of damage to a vehicle<br>		[[WeaponScript.VehicleBioInterval \| Vehicle Bio Interval]]: time inbetween each infliction of damage to a vehicle<br>

			===Variables for particles===
	[[WeaponScript.ExplosionSprite \| ExplosionSprite]]: explosion sprite to use for explosion, 0 = default, 1 = green (bio), 2 = blue (plasma)<br>		[[WeaponScript.ExplosionSprite \| ExplosionSprite]]: explosion sprite to use for explosion, 0 = default, 1 = green (bio), 2 = blue (plasma)<br>
	[[WeaponScript.ExplosionSpeed \| ExplosionSpeed]]: how fast the explosion sprite fades (15 is default fps)<br>		[[WeaponScript.ExplosionSpeed \| ExplosionSpeed]]: how fast the explosion sprite fades (15 is default fps)<br>
	[[WeaponScript.TracerType \| Tracer Type]]: Tracer effect, tracer names are logical, a list: tracer_du, tracer_bio, tracer_he, tracer_rifle, tracer_smg, tracer_vehiclemg, tracer_cg, tracer_plasma<br>		[[WeaponScript.TracerType \| Tracer Type]]: Tracer effect, tracer names are logical, a list: tracer_du, tracer_bio, tracer_he, tracer_rifle, tracer_smg, tracer_vehiclemg, tracer_cg, tracer_plasma<br>
	~~[[WeaponScript.Falloff \| Falloff]]<br>~~
	~~[[WeaponScript.Falloffbase \| Falloffbase]]<br>~~
	~~[[WeaponScript.MinimalDamage \| MinimalDamage]]<br>~~

← Older revision		Revision as of 07:17, 21 January 2010
Line 1:		Line 1:
	[[WeaponScript.Name \| Name]]<br>		[[WeaponScript.Name \| Name]]: name given when selecting weapons.<br>
	[[WeaponScript.HUDName \| HUD Name]]<br>		[[WeaponScript.HUDName \| HUD Name]]: name displayed in the weapon area of the vehicle HUD<br>
	[[WeaponScript.Description \| Description]]<br>		[[WeaponScript.Description \| Description]]: description given when selecting weapons<br>
	[[WeaponScript.Icon \| Icon]]<br>		[[WeaponScript.Icon \| Icon]]: icon drawn in the GUI<br>
	[[WeaponScript.HUDIcon \| HUD Icon]]<br>		[[WeaponScript.HUDIcon \| HUD Icon]]: icon drawn in the vehicle HUD<br>
	[[WeaponScript.Size \| Size]]<br>		[[WeaponScript.Size \| Size]]: number of slots required when selecting weapons. Current possible values [1,2,3].<br>
	[[WeaponScript.Type \| Type]]<br>		[[WeaponScript.Type \| Type]]: 0=machine gun, 1=tank cannon, 2=artillery cannon, 3=missile launcher, 4=grenade launcher, 5=aircraft bomb bay<br>
	[[WeaponScript.Cost \| Cost]]<br>		[[WeaponScript.Cost \| Cost]]: The amount of resources required(deducted from the team) to equip a tank with the weapon.<br>
	[[WeaponScript.Team \| Team]]<br>		[[WeaponScript.Team \| Team]]: Which team is allowed to use it. Current possible values ['IMP','NF','ALL'].<br>
	[[WeaponScript.Research \| Research]]<br>		[[WeaponScript.Research \| Research]]: The name of a research item that unlocks this weapon, taken from the research scripts.<br>
	[[WeaponScript.SoundFiring \| Sound Firing]]<br>		[[WeaponScript.SoundFiring \| Sound Firing]]: The sound played when weapon is being fired.<br>
	[[WeaponScript.SoundImpact \| Sound Impact]]<br>		[[WeaponScript.SoundImpact \| Sound Impact]]: The sound played when the weapon makes its final impact.<br>
	[[WeaponScript.SoundReloading \| Sound Reloading]]<br>		[[WeaponScript.SoundReloading \| Sound Reloading]]: The sound played when the weapon reloads.<br>
	[[WeaponScript.DamageType \| Damage Type]]<br>		[[WeaponScript.DamageType \| Damage Type]]: The name of a damage type to be used by the resistance system.<br>
	[[WeaponScript.AmmoType \| Ammo Type]]<br>		[[WeaponScript.AmmoType \| Ammo Type]]: This value determines what things mg weapons can damage. 0=infantry, 1=infantry+vehicles, 2=buildings+vehicles+infantry.<br>
	[[WeaponScript.Damage \| Damage]]<br>		[[WeaponScript.Damage \| Damage]]: The amount of damage inflicted to an enemy target on impact. This value is affected by many things.<br>
	[[WeaponScript.Speed \| Speed]]<br>		[[WeaponScript.Speed \| Speed]]: The initial velocity of the projectile.<br>
	[[WeaponScript.Gravity \| Gravity]]<br>		[[WeaponScript.Gravity \| Gravity]]: effects of gravity on the projectile, only for projectiles. Gravity should normally be constant, although this value is often messed with to compansate for short-comings of the speed modifier.<br>
	[[WeaponScript.Heat \| Heat]]<br>		[[WeaponScript.Heat \| Heat]]: Amount of heat inflicted on self when weapon is fired. Vehicles have 200 heat points before they over-heat.<br>
	[[WeaponScript.Weight \| Weight]]<br>		[[WeaponScript.Weight \| Weight]]: weight in terms of effects on engine and weight restrictions for chassis<br>
	[[WeaponScript.CycleTime \| Cycle Time]]<br>		[[WeaponScript.CycleTime \| Cycle Time]]: time between shots in seconds<br>
	[[WeaponScript.ClipSize \| Clip Size]]<br>		[[WeaponScript.ClipSize \| Clip Size]]: number of shots before reload.<br>
	[[WeaponScript.TotalAmmoClips \| Total Ammo Clips]]<br>		[[WeaponScript.TotalAmmoClips \| Total Ammo Clips]]: number of possible reloads.<br>
	[[WeaponScript.ReloadTime \| Reload Time]]<br>		[[WeaponScript.ReloadTime \| Reload Time]]: time spent reloading in seconds.<br>
	[[WeaponScript.ProjectileSpread \| Projectile Spread]]<br>		[[WeaponScript.ProjectileSpread \| Projectile Spread]]: only applicable to machine guns at the moment. A value of 1 is likely a full 180 degree cone.<br>
	[[WeaponScript.HeatToTarget \| Heat To Target]]<br>		[[WeaponScript.HeatToTarget \| Heat To Target]]: Amount of heat inflicted on the target upon impact. (not included the heat added by the damage to heat modifier of armor).<br>
	[[WeaponScript.Inertia \| Inertia]]<br>		[[WeaponScript.Inertia \| Inertia]]: Determines if the velocity of the vehicle firing the weapon affects the velocity of the projectile fired.<br>
	[[WeaponScript.ExplosionRadius \| Explosion Radius]]<br>		[[WeaponScript.ExplosionRadius \| Explosion Radius]]: The amount of area around the impact location of a projectile affected by the impact. Making this value too large can bog-down servers. Current range is from 0 to 2000+.<br>
	[[WeaponScript.ExplosionForce \| Explosion Force]]<br>		[[WeaponScript.ExplosionForce \| Explosion Force]]: amount of concussive force applied to physics objects in the blast radius.<br>
	[[WeaponScript.DumbMissile \| Dumb Missile]]<br>		[[WeaponScript.DumbMissile \| Dumb Missile]]: '1' if missile flies straight ahead<br>
	[[WeaponScript.HomingMissile \| Homing Missile]]<br>		[[WeaponScript.HomingMissile \| Homing Missile]]: '1' if missile flies towards locked on target
	[[WeaponScript.GuidedMissile \| Guided Missile]]<br>		<br>
	[[WeaponScript.MissileRange \| Missile Range]]<br>		[[WeaponScript.GuidedMissile \| Guided Missile]]: '1' if missile follows crosshairs after launch<br>
	[[WeaponScript.LockOnTime \| Lock On Time]]<br>		[[WeaponScript.MissileRange \| Missile Range]]: max range in HL2 units (1 inch = 1) that the player can lock onto a target with a homing missile, or range from vehicle being fired from when a guided missile stops following the player's crosshairs<br>
	[[WeaponScript.LockRangeModifier \| Lock Range Modifier]]<br>		[[WeaponScript.LockOnTime \| Lock On Time]]: time it takes for a homing missile to lock onto the target under the player crosshairs<br>
			[[WeaponScript.LockRangeModifier \| Lock Range Modifier]]: modifies lock on time based on range (as range increases, lock on time increases based on the modifier: modifier * range to target + lock on time = total lock on time)<br>
	[[WeaponScript.CountermeasureEffectiveness \| Countermeasure Effectiveness]]<br>		[[WeaponScript.CountermeasureEffectiveness \| Countermeasure Effectiveness]]<br>
	[[WeaponScript.TurningAbility \| Turning Ability]]<br>		[[WeaponScript.TurningAbility \| Turning Ability]]: determines how effective the missile can turn to home in on its target or guide itself to the crosshair for a guided missile; 1.0 means the missile can turn instantly towards its target, 0.0 and the missile doesn't turn at all<br>
	[[WeaponScript.PlayerBioDamage \| Player Bio Damage]]<br>		[[WeaponScript.PlayerBioDamage \| Player Bio Damage]]: damage inflicted to players every interval<br>
	[[WeaponScript.PlayerBioTime \| Player Bio Time]]<br>		[[WeaponScript.PlayerBioTime \| Player Bio Time]]: total time to inflict damage to players<br>
	[[WeaponScript.PlayerBioInterval \| Player Bio Interval]]<br>		[[WeaponScript.PlayerBioInterval \| Player Bio Interval]]: time inbetween each infliction of damage to players<br>
	[[WeaponScript.VehicleBioDamage \| Vehicle Bio Damage]]<br>		[[WeaponScript.VehicleBioDamage \| Vehicle Bio Damage]]: damage inflicted to a vehicle every interval<br>
	[[WeaponScript.VehicleBioTime \| Vehicle Bio Time]]<br>		[[WeaponScript.VehicleBioTime \| Vehicle Bio Time]]: total time to inflict damage to s vehicle<br>
	[[WeaponScript.VehicleBioInterval \| Vehicle Bio Interval]]<br>		[[WeaponScript.VehicleBioInterval \| Vehicle Bio Interval]]: time inbetween each infliction of damage to a vehicle<br>
	[[WeaponScript.TracerType \| Tracer Type]]<br>		[[WeaponScript.ExplosionSprite \| ExplosionSprite]]: explosion sprite to use for explosion, 0 = default, 1 = green (bio), 2 = blue (plasma)<br>
			[[WeaponScript.ExplosionSpeed \| ExplosionSpeed]]: how fast the explosion sprite fades (15 is default fps)<br>
			[[WeaponScript.TracerType \| Tracer Type]]: Tracer effect, tracer names are logical, a list: tracer_du, tracer_bio, tracer_he, tracer_rifle, tracer_smg, tracer_vehiclemg, tracer_cg, tracer_plasma<br>
	[[WeaponScript.Falloff \| Falloff]]<br>		[[WeaponScript.Falloff \| Falloff]]<br>
	[[WeaponScript.Falloffbase \| Falloffbase]]<br>		[[WeaponScript.Falloffbase \| Falloffbase]]<br>
	[[WeaponScript.MinimalDamage \| MinimalDamage]]<br>		[[WeaponScript.MinimalDamage \| MinimalDamage]]<br>

WeaponScripts - Revision history

Thexa4 at 10:46, 28 February 2019

Thexa4 at 12:53, 26 August 2017

Thexa4: /* Weapon Characteristics */

Gilmore110j: Reordered page somewhat.

Administrator at 07:17, 21 January 2010

Trickster: New page: Name HUD Name Description Icon HUD Icon...

Trickster: New page: Name
HUD Name
Description
Icon
HUD Icon...