diff -r 0b6e80767d96 -r 514babfbad9e LuaGears.wiki --- a/LuaGears.wiki Wed Oct 30 03:01:54 2019 +0000 +++ b/LuaGears.wiki Wed Oct 30 11:59:37 2019 +0100 @@ -85,7 +85,7 @@ === `SpawnHealthCrate(x, y, [, health])` === Spawns a health crate at the specified position. If `x` and `y` are set to 0, the crate will spawn on a random position (but always on land). Set `health` for the initial health contained in the health crate. If not set, the default health (`HealthCaseAmount`) is used. Do not use a negative value for `health`. -=== `SpawnSupplyCrate(x, y, ammoType [, amount])` (0.9.24) === +=== `SpawnSupplyCrate(x, y, ammoType [, amount])` === Spawns an ammo or utility crate at the specified position with the given ammo type and an optional amount (default: 1). The crate type is chosen automatically based on the ammo type. Otherwise, this function behaves like `SpawnAmmoCrate`. @@ -162,7 +162,7 @@ === `GetGearType(gearUid)` === This function returns the [GearTypes gear type] for the specified gear, if it exists. If it doesn't exist, `nil` is returned. -=== `GetVisualGearType(vgUid)` (0.9.23) === +=== `GetVisualGearType(vgUid)` === This function returns the [VisualGearTypes visual gear type] for the specified visual gear, if it exists. If it doesn't exist, `nil` is returned. === `GetState(gearUid)` === @@ -517,7 +517,7 @@ || `heResurrectable` || Whether to resurrect the hog on death || With a non-zero value, the hedgehog will be resurrected and teleported to a random safe location on death. Resurrection may fail and the hedgehog can still die when there is no or very, very little land left. `0` disables this. || || `heResurrected` || Whether the hedgehog has been resurrected once. This is only a subtle graphical effect. || With a non-zero value, the hedgehog was resurrected, `0` otherwise. || || `heFrozen` || Freeze level. Frozen hedgehogs skip turn, are heavy and take half damage || The hog is considered frozen if the value is `256` or higher, otherwise not. A number of `256` or higher denotes “how frozen” the hedgehog is, i.e. how long it takes to melt. The freezer sets this to `199999` initially. The value will be reduced by `50000` each round. Being hit by a flame reduces this number by `1000`. The values `0` to `255` are used for the freeze/melt animations. || -|| `heArtillery` || If enabled, the hedgehog can't walk (since 0.9.24). || `0` = disabled. `1` = permanently enabled. `2` = temporarily enabled (used by sniper rifle between shots) || +|| `heArtillery` || If enabled, the hedgehog can't walk. || `0` = disabled. `1` = permanently enabled. `2` = temporarily enabled (used by sniper rifle between shots) || Example (sets all bots poisoned with poison damage of 1): @@ -536,7 +536,7 @@ === `GetHogFlag(gearUid)` === Returns the name of the flag of the team of the specified hedgehog gear. -=== `GetHogFort(gearUid)` (0.9.23) === +=== `GetHogFort(gearUid)` === Returns the name of the fort of the team of the specified hedgehog gear. === `GetHogGrave(gearUid)` === @@ -555,7 +555,7 @@ GetAmmoTimer(CurrentHedgehog, amGrenade) -- May return 1000, 2000, 3000, 4000 or 5000 -=== `HealHog(gearUid, healthBoost[, showMessage[, tint]])` (0.9.24) === +=== `HealHog(gearUid, healthBoost[, showMessage[, tint]])` === Convenience function to increase the health of a hedgehog with default visual effects. Specifically, this increases the health of the hedgehog gear with the given ID `gearUid` by `healthBoost`, displays some healing particles at the hedgehog and shows the health increae as a message. This is similar to the behavour after taking a health crate, or getting a health boost from vampirism. @@ -576,7 +576,7 @@ Returns true if hedgehog gear is hidden (e.g. via `HideHog` or the !TimeBox), false if it isn't, nil if that hedgehog never existed. === `HideHog(gearUid)` === -Removes a hedgehog from the map. The hidden hedgehog can be restored with `RestoreHog(gearUid)`. Since 0.9.23, returns `true` on success and `false` on failure (if gear does not exist / hog is already hidden). You must not hide all hogs at once. +Removes a hedgehog from the map. The hidden hedgehog can be restored with `RestoreHog(gearUid)`. Returns `true` on success and `false` on failure (if gear does not exist / hog is already hidden). You must not hide all hogs at once. Example: @@ -592,7 +592,7 @@ HideHog(gear) -- Hide the newly created gear. RestoreHog(gear) -- Restore the newly hidden gear. -=== `IsHogLocal(gearUid)` (0.9.23) === +=== `IsHogLocal(gearUid)` === Returns `true` if the specified hedgehog gear is controlled by a human player on the computer on which Hedgewars runs on (i.e. not over a computer over the network). Also returns `true` if the hog is a member of any of the local clans. Returns `false` otherwise. If the game has a mission team (see `AddMissionTeam`), this function behaves a little different: It only may return `true` for hogs in the same clan as the mission team and always returns `false` for hogs from other clans.