diff -r 0b6e80767d96 -r 514babfbad9e LuaGameplay.wiki --- a/LuaGameplay.wiki Wed Oct 30 03:01:54 2019 +0000 +++ b/LuaGameplay.wiki Wed Oct 30 11:59:37 2019 +0100 @@ -22,10 +22,10 @@ Returns `true` if the specified gameflag is enabled, otherwise `false`. == Turns == -=== SkipTurn() (0.9.24) === +=== SkipTurn() === Forces the current hedgehog to skip its turn. -=== `EndTurn([noTaunts])` (0.9.23) === +=== `EndTurn([noTaunts])` === Ends the current turn immediately. Normally, a “Coward” taunt may be played and an announcer message may be shown (depending on the situation). Set the optional `noTaunts` parameter to `true` to force the engine to never play a taunt or show a message. `noTaunts` is `false` by default. @@ -68,13 +68,13 @@ === !SetWind(windSpeed) === Sets the current wind in the range of -100 to 100 inclusive. Use together with `gfDisableWind` for full control. -=== !GetWind() (0.9.24) === +=== !GetWind() === Returns current wind, expressed as a floating point number between -100 to 100 inclusive. Note there may be rounding errors. === !SetMaxBuildDistance(distInPx) === Sets the maximum building distance for of girders and rubber bands in pixels to `distInPx`. If `distInPx` is `0`, the limit is disabled. If called without arguments, the distance will be reset to the default value. -=== Explode(x, y, radius[, options]) (0.9.24) === +=== Explode(x, y, radius[, options]) === Cause an explosion or erase land, push or damage gears. By default, an explosion destroys a circular piece of land and damages and pushes gears in its radius. @@ -148,7 +148,7 @@ === !SetAmmoDelay(ammoType, delay) === Changes the delay of a specified [AmmoTypes Ammo Type]. If `delay` is set to `9999`, the ammo type is disabled indefinitely. -=== !SetAmmoTexts(ammoType, name, caption, description [, showExtra]) (0.9.23) === +=== !SetAmmoTexts(ammoType, name, caption, description [, showExtra]) === Allows you to overwrite the displayed name and tooltip descriptions of a given ammo type. This function must only be called either inside the `onGameStart` callback function, or after the engine has called `onGameStart`. * `ammoType`: The ammo type to set the text for @@ -164,7 +164,7 @@ -- Overwrites bazooka name and description SetAmmoTexts(amBazooka, "Spoon Missile", "Crazy weapon", "This crazy weapon looks like a spoon and explodes on impact.|Attack: Hold to launch with more power") -=== !SetAmmoDescriptionAppendix(ammoType, descAppend) (0.9.23) === +=== !SetAmmoDescriptionAppendix(ammoType, descAppend) === Will set a string `descAppend` to be appended below the “core” description (ammo tooltip) of the specified `ammoType`, without changing the ordinary description. Note that calling this function always sets the complete appended string, you can't use this function to append multiple texts in row. @@ -184,7 +184,7 @@ 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`. -=== !GetAmmoName(ammoType [, ignoreOverwrite ]) (0.9.23) === +=== !GetAmmoName(ammoType [, ignoreOverwrite ]) === 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`. === !SetAmmoSlot(ammoType, slot) (1.0.0) === @@ -216,7 +216,7 @@ || 6 || long || vertical || || 7 || long || increasing right || -=== !PlaceRubber(x, y, frameIdx) (0.9.23) === +=== !PlaceRubber(x, y, frameIdx) === Attempts to place a rubber with centre points `x`, `y` and a certain orientation, specified by `frameIdx`. The rubber can only be placed in open space and must not collide with anything so this function may fail. It will return `true` on successful placement and `false` on failure. These are the accepted values for `frameIdx`: @@ -335,13 +335,13 @@ === !GetInputMask() === Returns the current input mask of the player. -=== !SetVampiric(bool) (0.9.24) === +=== !SetVampiric(bool) === Toggles vampirism mode for this turn. Set `bool` to `true` to enable (same effect as if the hedgehog has used Vampirism), `false` to disable. === !GetVampiric() (0.9.25) === Returns true if vampirism mode is currently active. -=== !SetLaserSight(bool) (0.9.24) === +=== !SetLaserSight(bool) === Toggles laser sight for this turn. Set `bool` to `true` to enable (same effect as if the hedgehog has used Laser Sight), `false` to disable. === !GetLaserSight() (0.9.25) === @@ -418,13 +418,13 @@ -- Add mission team with default clan color AddMissionTeam(-1) -=== !GetTeamName(teamIdx) (0.9.24) === +=== !GetTeamName(teamIdx) === Returns the name of the team with the index `teamIdx`. `teamIdx` is a number between 0 and `TeamsCount-1`. -=== !GetTeamIndex(teamname) (0.9.24) === +=== !GetTeamIndex(teamname) === Returns the team index (number between 0 and `TeamsCount-1`) of the team with the name `teamName`. -=== !GetTeamClan(teamname) (0.9.24) === +=== !GetTeamClan(teamname) === Returns the clan ID of the team with the given `teamName`. === !DismissTeam(teamname) === @@ -432,7 +432,7 @@ This function must not be called while it's the team's turn. -=== !SetTeamLabel(teamname[, label]) (0.9.24) === +=== !SetTeamLabel(teamname[, label]) === Set or remove a label for the team with the given team name. The label is a string and will be displayed next to the team's health bar. If `label` is `nil`, the label will be removed. @@ -471,4 +471,4 @@ === !GetRandom(number) === Returns a randomly generated whole number in the range of `0` to `number - 1`. `number` must be a whole number >= 1. This random number uses the game seed, so is synchronised, and thus safe for multiplayer and saved games. -Use `GetRandom` for anything that could impact the engine state. For example, a visual gear could simply use Lua’s `math.random`, but adding a regular gear should use `GetRandom`. \ No newline at end of file +Use `GetRandom` for anything that could impact the engine state. For example, a visual gear could simply use Lua’s `math.random`, but adding a regular gear should use `GetRandom`.