Differences
This shows you the differences between two versions of the page.
Next revision | Previous revision | ||
constants [2016/11/27 17:23] textstorm created |
constants [2016/12/05 22:43] (current) textstorm |
||
---|---|---|---|
Line 1: | Line 1: | ||
====== TextStorm Constants ====== | ====== TextStorm Constants ====== | ||
+ | Here you will find the constants used throughout TextStorm. | ||
+ | |||
+ | There are two types; **Booleans** (1 or 0 - on or off), **Values** (Store a particular string or integer) | ||
+ | |||
+ | They can be called/accessed anywhere within the game engine including the plugins you develop! | ||
+ | ===== Booleans ===== | ||
+ | ==== ADMIN ==== | ||
+ | You can use the following to determine whether a user is an Administrator or not: | ||
+ | |||
+ | <code php> | ||
+ | if (ADMIN) {} | ||
+ | </code> | ||
+ | ==== CHESTSON ==== | ||
+ | You can use the following to determine if the game has chests enabled: | ||
+ | <code php> | ||
+ | if (CHESTSON) {} | ||
+ | </code> | ||
+ | ==== HASWEAPON ==== | ||
+ | You can use the following to determine if the player has a weapon equipped: | ||
+ | <code php> | ||
+ | if (HASWEAPON) {} | ||
+ | </code> | ||
+ | ==== INVEHICLE ==== | ||
+ | You can use the following to determine if the player is in a vehicle: | ||
+ | <code php> | ||
+ | if (INVEHICLE) {} | ||
+ | </code> | ||
+ | ==== VEHICLESON ==== | ||
+ | You can use the following to determine if the game has vehicles enabled: | ||
+ | <code php> | ||
+ | if (VEHICLESON) {} | ||
+ | </code> | ||
+ | === VEHICLEDAMAGEON === | ||
+ | You can use the following to determine if the game uses vehicle damage attributes: | ||
+ | <code php> | ||
+ | if (VEHICLEDAMAGEON) {} | ||
+ | </code> | ||
+ | === VEHICLESPEEDON === | ||
+ | You can use the following to determine if the game uses the vehicle speed attribute: | ||
+ | <code php> | ||
+ | if (VEHICLESPEEDON) {} | ||
+ | </code> | ||
+ | ==== WEAPONSON ==== | ||
+ | You can use the following to determine if the game has weapons enabled: | ||
+ | <code php> | ||
+ | if (WEAPONSON) {} | ||
+ | </code> | ||
+ | ===== Values ===== | ||
+ | ==== CHESTTITLE ==== | ||
+ | You can access this string to display how the game refers to chests (Lockers, Treasure etc.) | ||
+ | <code php> | ||
+ | echo CHESTTITLE; | ||
+ | </code> | ||
+ | ==== CURRENCY ==== | ||
+ | You can access this string to display how the game refers to Currency (Coins, Doubloons etc.) | ||
+ | <code php> | ||
+ | echo CURRENCY; | ||
+ | </code> | ||
+ | ==== EXPERIENCE ==== | ||
+ | You can access this string to display how the game refers to experience | ||
+ | <code php> | ||
+ | echo EXPERIENCE; | ||
+ | </code> | ||
+ | ==== GENERICNAME ==== | ||
+ | You can access this string to display the general character being role-played (Racer, Pirate etc.) | ||
+ | <code php> | ||
+ | echo GENERICNAME; | ||
+ | </code> | ||
+ | ==== LOCATIONID ==== | ||
+ | You can access this integer to determine the players location | ||
+ | <code php> | ||
+ | echo LOCATIONID; | ||
+ | </code> | ||
+ | ==== VEHICLETITLE ==== | ||
+ | You can access this string to display how vehicles are referred to in the game (Car, Ship etc.) | ||
+ | <code php> | ||
+ | echo VEHICLETITLE; | ||
+ | </code> | ||
+ | ==== WEAPONTITLE ==== | ||
+ | You can access this string to display how weapons are referred to in the game (Gun, Weapon etc.) | ||
+ | <code php> | ||
+ | echo WEAPONTITLE; | ||
+ | </code> | ||