LuaGameplay.wiki
changeset 1970 c85f6f3bb16c
parent 1952 da4ee30e45f1
child 1971 210ad26e9e94
equal deleted inserted replaced
1969:93991afec8b1 1970:c85f6f3bb16c
   171 Example:
   171 Example:
   172 <code language="lua">
   172 <code language="lua">
   173 -- Appends a text to the ammo tooltip of the bazooka but leaves name and main description intact
   173 -- Appends a text to the ammo tooltip of the bazooka but leaves name and main description intact
   174 SetAmmoTexts(amBazooka, "This weapon deals double the damage than usually.")</code>
   174 SetAmmoTexts(amBazooka, "This weapon deals double the damage than usually.")</code>
   175 
   175 
   176 === <tt>!AddAmmo(gearUid, ammoType, ammoCount)</tt> ===
   176 === <tt>!AddAmmo(gearUid, ammoType [, ammoCount])</tt> ===
   177 Adds `ammoType` to the specified gear. The amount added is determined by the arguments passed via `SetAmmo()` in the `onAmmoStoreInit()` [LuaEvents event handler]. `ammoCount` is an optional parameter. If this is set, the ammo will *not* be added, but instead set to `ammoCount`. A value of `0` will remove the weapon, a value of `AMMO_INFINITE` will give infinite ammo.
   177 Adds or sets the amount of ammo to the specified hedgehog gear.
   178 
   178 
   179 Note: By default, ammo is per-team, so calling `AddAmmo` for a hedgehog will give the ammo for the whole team. The game flags `gfPerHogAmmo` and `gfSharedAmmo` change how ammo is managed in the game, so these game flags also affect `AddAmmo`.
   179 If `ammoCount` is `nil`, then X ammos of the type `ammoType` will be added to `gearUid`, where X is determined by the `numberInCrate` argument passed via `SetAmmo()` in the `onAmmoStoreInit()` [LuaEvents event handler]. Note that `numberInCrate` defaults to 0 if `SetAmmo()` was not called for the ammo type before.
       
   180 
       
   181 If `ammoCount` is a number, the ammo will *not* be added, but instead set to `ammoCount`. A value of `0` will remove the ammo, a value of `AMMO_INFINITE` will set it to infinite.
       
   182 
       
   183 Note: By default, ammo is per-team, so calling `AddAmmo` for a hedgehog will add/set the ammo for the whole team. The game flags `gfPerHogAmmo` and `gfSharedAmmo` change how ammo is managed in the game, so these game flags also affect `AddAmmo`.
   180 
   184 
   181 === <tt>!GetAmmoName(ammoType [, ignoreOverwrite ])</tt> (0.9.23) ===
   185 === <tt>!GetAmmoName(ammoType [, ignoreOverwrite ])</tt> (0.9.23) ===
   182 Returns the localized name for the specified `ammoType`, taking an ammo name overwritten by `SetAmmoTexts` into account. If `ignoreOverwrite` is `true`, this function will always return the original ammo name of the weapon and ignores names which may have been overwritten by `SetAmmoTexts`.
   186 Returns the localized name for the specified `ammoType`, taking an ammo name overwritten by `SetAmmoTexts` into account. If `ignoreOverwrite` is `true`, this function will always return the original ammo name of the weapon and ignores names which may have been overwritten by `SetAmmoTexts`.
   183 
   187 
   184 === <tt>!SetAmmoSlot(ammoType, slot)</tt> (1.0.0) ===
   188 === <tt>!SetAmmoSlot(ammoType, slot)</tt> (1.0.0) ===