COAL Manual - Revision history

Corbin: added player.add_tactile() to the COAL Manual

2018-10-02T17:31:27Z

added player.add_tactile() to the COAL Manual

Corbin: /* PLAYER MODULE */ updated Player Module

2018-09-14T21:09:49Z

‎PLAYER MODULE: updated Player Module

Corbin: Updated COAL documentation

2018-09-14T20:25:36Z

Updated COAL documentation

Corbin at 23:20, 8 March 2018

2018-03-08T23:20:15Z

Corbin: Changed introduction

2017-02-23T03:42:41Z

Changed introduction

Corbin: /* * Drawing Stuff */ changed formatting slightly

2017-02-17T06:50:24Z

‎* Drawing Stuff: changed formatting slightly

Corbin: minor formatting changes

2017-02-15T05:16:53Z

minor formatting changes

Corbin at 02:55, 14 February 2017

2017-02-14T02:55:42Z

Corbin: Massive formatting clean-up

2017-02-14T02:53:20Z

Massive formatting clean-up

Show changes

Corbin: Entire Article: Better Formatting (still not completed)

2017-02-14T02:22:04Z

Entire Article: Better Formatting (still not completed)

Show changes

@@ Line 285: / Line 285: @@
 ==== '''<code>player.hurt_angle()</code>''' ====
 <blockquote>''<code>Like player.hurt_dir(), except this returns the map angle from the player to his attacker. The result is in degrees (ranging from 0 to 359), where East is 0 and North is 90.</code>''</blockquote>
 == * CAMERA MODULE ==

@@ Line 130: / Line 130: @@
 ==== '''<code>player.get_name()</code>''' ====
 <blockquote><code>''Returns the name of the current player.''</code></blockquote>
 ==== '''<code>player.health()</code>''' ====
@@ Line 222: / Line 231: @@
 <blockquote>''<code>Returns true if the player's current weapon is sharing a single clip between primary and secondary attackes (the SHARED_CLIP command).</code>''</blockquote>
-== Conditions ==
+== * Conditions ==
 ==== '''<code>player.on_ground()</code>''' ====
@@ Line 260: / Line 269: @@
 ==== '''<code>player.set_who(index)</code>''' ====
-<blockquote><code>''Sets who the current player is. The 'index' parameter is a small number: 1 for the "main player" on this computer (the person at the keyboard), 2 for the next player in the list, etc... upto the number of players in the game. All the player query functions described here return their results for the current player.''</code></blockquote>
+<blockquote><code>''Sets who the current player is. The 'index' parameter is a small number: 1 for the "main player" on this computer (the person at the keyboard), 2 for the next player in the list, for instance the split-screen player) etc... up to the number of players in the game. All the player query functions described here return their results for the current player.''</code></blockquote>
 ==== '''<code>player.hurt_by()</code>''' ====
@@ Line 277: / Line 286: @@
 <blockquote>''<code>Like player.hurt_dir(), except this returns the map angle from the player to his attacker. The result is in degrees (ranging from 0 to 359), where East is 0 and North is 90.</code>''</blockquote>
-== CAMERA MODULE ==
+== * CAMERA MODULE ==
-'''<code>cam.set_bob(1|0, [, 1.0,0.0)</code>'''<blockquote>''<code>Sets the Player bobbing. The parameter flags above are as follows:</code>''</blockquote>
-* <blockquote>First Parameter is an '''Integer''' for enabling or disabling the camera bob. This can either be 1 or 0.</blockquote>
+==== '''<code>cam.set_vert_bob(f)</code>''' ====
-* <blockquote>Second Parameter is a '''Float''' for controlling the Up/Down bobbing scale.</blockquote>
+<blockquote>''<code>Sets the Player bobbing. The parameter flags above are as follows:</code>''</blockquote>
-* <blockquote>Third Parameter is a '''Float''' for controlling the camera roll bobbing scale.</blockquote>
+* <blockquote>Parameter is a ''Float'' for controlling the vertical bobbing. This was previously encapsulated in DDF where it is now controlled via COAL.</blockquote>
-== GAME MODULE ==
+==== '''<code>cam.set_roll_bob(f)</code>''' ====
-==== '''<code>player.is_bot()</code>''' ====
+== CAMERA-MAN MODULE ==
-<blockquote>''<code>Returns true if the current player is a bot.</code>''</blockquote>
+The new Camera-Man system is in reality a COAL module, and can be completely configured through COAL. However, due to its complexity and the fact that the format is not in the QC extension (which is actually done with Console Commands), it has its own article and how-to's. [[CAMERA-MAN|You can visit that guide by clicking on this sentence.]]

@@ Line 182: / Line 182: @@
 == * Weapon Stuff ==
-==== '''player.has_weapon(name)''' ====
+==== '''<code>player.has_weapon(name)</code>''' ====
 <blockquote><code>''Returns true if the player currently owns the weapon, where 'name' is the DDF name of the weapon.''</code></blockquote>
@@ Line 222: / Line 222: @@
 <blockquote>''<code>Returns true if the player's current weapon is sharing a single clip between primary and secondary attackes (the SHARED_CLIP command).</code>''</blockquote>
-=== Conditions ===
+== Conditions ==
 ==== '''<code>player.on_ground()</code>''' ====
@@ Line 238: / Line 238: @@
 ==== '''<code>player.is_crouching()</code>''' ====
 <blockquote>''<code>Returns true if player is crouching.</code>''</blockquote>
 ==== '''<code>player.is_attacking()</code>''' ====
@@ Line 273: / Line 276: @@
 ==== '''<code>player.hurt_angle()</code>''' ====
 <blockquote>''<code>Like player.hurt_dir(), except this returns the map angle from the player to his attacker. The result is in degrees (ranging from 0 to 359), where East is 0 and North is 90.</code>''</blockquote>

@@ Line 2: / Line 2: @@
 == OVERVIEW ==
-COAL is a new scripting language which has been developed especially for 3DGE. At the moment, 3DGE uses this to define custom HUD modules. This manual is designed to get you up-to-speed on all of the functions that COAL provides.<blockquote>The standard Coal scripts for drawing the DOOM HUD is loaded from this file: <code>doom_ddf/coal_hud.ec</code></blockquote><blockquote>The API that COAL itself is contained in is loaded from <code>doom_ddf/coal_api.ec</code>, which is a good reference to look at while developing your HUD. Take note that the API is hard-coded to 3DGE.</blockquote><blockquote>Additionally, each archive may contain a lump called "<code>COALHUDS</code>" which is automatically loaded (which can reside in the PAK/PK3 namespace ''<sub><code>./scripts</code></sub>''). Later scripts are able to replace any definitions (functions etc) in earlier scripts.</blockquote>
+[[COAL|COAL]] is a new scripting language which has been developed especially for 3DGE. At the moment, 3DGE uses this to define custom HUD modules. This manual is designed to get you up-to-speed on all of the functions that COAL provides.<blockquote>The standard Coal scripts for drawing the DOOM HUD is loaded from this file: <code>doom_ddf/coal_hud.ec</code></blockquote><blockquote>The API that COAL itself is contained in is loaded from <code>doom_ddf/coal_api.ec</code>, which is a good reference to look at while developing your HUD. Take note that the API is hard-coded to 3DGE.</blockquote><blockquote>Additionally, each archive may contain a lump called "<code>COALHUDS</code>" which is automatically loaded (which can reside in the PAK/PK3 namespace ''<sub><code>./scripts</code></sub>''). Later scripts are able to replace any definitions (functions etc) in earlier scripts.</blockquote>
 == FILES CONTENTS ==

@@ Line 2: / Line 2: @@
 == OVERVIEW ==
-COAL is a new scripting language which is being developed especially for EDGE. It is still quite primitive but good enough for the purpose of drawing HUDs. Documentation about the language is being worked on, though the syntax is quite similar to existing languages like C and Pascal.<blockquote>The standard Coal scripts for drawing the DOOM HUD is loaded from this file: <code>doom_ddf/coal_hud.ec</code></blockquote><blockquote>Additionally, each pwad may contain a lump called "<code>COALHUDS</code>" which is automatically loaded (which can reside in the PAK/PK3 namespace ''<sub><code>./scripts</code></sub>''). Later scripts are able to replace any definitions (functions etc) in earlier scripts.</blockquote>
+COAL is a new scripting language which has been developed especially for 3DGE. At the moment, 3DGE uses this to define custom HUD modules. This manual is designed to get you up-to-speed on all of the functions that COAL provides.<blockquote>The standard Coal scripts for drawing the DOOM HUD is loaded from this file: <code>doom_ddf/coal_hud.ec</code></blockquote><blockquote>The API that COAL itself is contained in is loaded from <code>doom_ddf/coal_api.ec</code>, which is a good reference to look at while developing your HUD. Take note that the API is hard-coded to 3DGE.</blockquote><blockquote>Additionally, each archive may contain a lump called "<code>COALHUDS</code>" which is automatically loaded (which can reside in the PAK/PK3 namespace ''<sub><code>./scripts</code></sub>''). Later scripts are able to replace any definitions (functions etc) in earlier scripts.</blockquote>
 == FILES CONTENTS ==

@@ Line 48: / Line 48: @@
 ==== '''<code>hud.text_color(name)</code>''' ====
-<blockquote>''<code>Sets the current text color, which must refer to an entry in [[COLMAP|COLMAPS.DDF]], or can be the empty string "" which causes the text to be drawn normally (without being colormapped). The default is "" and is reset after each frame.</code>''</blockquote><blockquote>'''<code>hud.set_scale(value)</code>'''</blockquote><blockquote>''<code>Sets the scaling for drawing text and for '''hud.draw_image()'''. Larger values make the text/image bigger. The default scale is 1.0 and is reset after each frame.</code>''</blockquote>
+<blockquote>''<code>Sets the current text color, which must refer to an entry in [[COLMAP|COLMAPS.DDF]], or can be the empty string "" which causes the text to be drawn normally (without being colormapped). The default is "" and is reset after each frame.</code>''</blockquote>
 ==== '''<code>hud.set_alpha(value)</code>''' ====
@@ Line 84: / Line 87: @@
 ==== '''<code>hud.render_automap(x, y, w, h, [options])</code>''' ====
-<blockquote>''<code>Renders the automap for the player on the screen, in a rectangle with the given coordinates. Note that no background is drawn, hence you can use this function to create an overlay automap (drawn over the top of the player's view). If you need a solid color behind it, use the '''hud.solid_box()''' function first.</code>''</blockquote><blockquote><code>The 'options' parameter is optional, when present it is a table containing a set of variables which modify the way the automap is drawn. Variables which are not present in the table are not affected (stay the same as the user's normal automap). The following list shows all the possible variables:</code></blockquote>
+<blockquote>''<code>Renders the automap for the player on the screen, in a rectangle with the given coordinates. Note that no background is drawn, hence you can use this function to create an overlay automap (drawn over the top of the player's view). If you need a solid color behind it, use the '''hud.solid_box()''' function first.</code>''</blockquote><blockquote><code>The 'options' parameter is optional, when present it is a table containing a set of variables which modify the way the automap is drawn. Variables which are not present in the table are not affected (stay the same as the user's normal automap). The following list shows all the possible variables:</code></blockquote><blockquote><code>Variable	 Description</code></blockquote>
 ** <code>zoom	 Set a fixed zoom factor, where 1.0 shows the whole map, and larger values make the map bigger</code>
@@ Line 100: / Line 101: @@
 ==== <code>'''hud.automap_colors(table)'''</code> ====
-<blockquote>''<code>This function can be used to change some or all of the colors used when drawing the automap. The 'table' parameter is a Lua table where the names are automap parts and the values are the colors. For example: { grid = "#006666", wall = "#FFFFFF" }. Parts that are not present in the table are not affected (stay the same as before). Here is a list of all the automap parts that can be changed:</code>''</blockquote><blockquote>Automap Part	 Description</blockquote>
+<blockquote>''<code>This function can be used to change some or all of the colors used when drawing the automap. The 'table' parameter is a Lua table where the names are automap parts and the values are the colors. For example: { grid = "#006666", wall = "#FFFFFF" }. Parts that are not present in the table are not affected (stay the same as before). Here is a list of all the automap parts that can be changed:</code>''</blockquote><blockquote><code>Automap Part	 Description</code></blockquote>
 ** grid	 Grid lines
 ** wall	 One sided walls
@@ Line 135: / Line 136: @@
 ==== '''<code>player.armor(type)</code>''' ====
 <blockquote>''<code>For the given armor type, returns the amount the player is currently wearing. The 'type' parameter is a number in the range 1-5, but the following names can be used for more readable code:</code>''</blockquote>
-** ARMORS.green
+** <code>ARMORS.green</code>
-** ARMORS.blue
+** <code>ARMORS.blue</code>
-** ARMORS.purple
+** <code>ARMORS.purple</code>
-** ARMORS.yellow
+** <code>ARMORS.yellow</code>
-** ARMORS.red
+** <code>ARMORS.red</code>
 ==== '''<code>player.total_armor(type)</code>''' ====

@@ Line 39: / Line 39: @@
 <blockquote>''<code>This function returns the title of the map being played, mainly to be displayed on the automap.</code>''</blockquote>
-== Drawing Stuff ==
+== * Drawing Stuff ==
 ==== '''<code>hud.coord_sys(w, h)</code>''' ====
@@ Line 86: / Line 86: @@
 <blockquote>''<code>Renders the automap for the player on the screen, in a rectangle with the given coordinates. Note that no background is drawn, hence you can use this function to create an overlay automap (drawn over the top of the player's view). If you need a solid color behind it, use the '''hud.solid_box()''' function first.</code>''</blockquote><blockquote><code>The 'options' parameter is optional, when present it is a table containing a set of variables which modify the way the automap is drawn. Variables which are not present in the table are not affected (stay the same as the user's normal automap). The following list shows all the possible variables:</code></blockquote>
-==== Variable	 Description ====
+====       Variable	 Description ====
-* zoom	 Set a fixed zoom factor, where 1.0 shows the whole map, and larger values make the map bigger
+** <code>zoom	 Set a fixed zoom factor, where 1.0 shows the whole map, and larger values make the map bigger</code>
-* grid	 force the grid lines on/off
+** <code>grid	 force the grid lines on/off</code>
-* rotate	 force map rotation on/off
+** <code>rotate	 force map rotation on/off</code>
-* follow	 force follow-player mode on/off
+** <code>follow	 force follow-player mode on/off</code>
-* things	 draw all things
+** <code>things	 draw all things</code>
-* walls	 draw all walls (like IDDT cheat)
+** <code>walls	 draw all walls (like IDDT cheat)</code>
-* allmap	 draw walls like All-Map powerup
+** <code>allmap	 draw walls like All-Map powerup</code>
 ==== <code>'''hud.set_render_who(index)'''</code> ====
@@ Line 100: / Line 100: @@
 ==== <code>'''hud.automap_colors(table)'''</code> ====
-<blockquote>''<code>This function can be used to change some or all of the colors used when drawing the automap. The 'table' parameter is a Lua table where the names are automap parts and the values are the colors. For example: { grid = "#006666", wall = "#FFFFFF" }. Parts that are not present in the table are not affected (stay the same as before). Here is a list of all the automap parts that can be changed:</code>''</blockquote>
+<blockquote>''<code>This function can be used to change some or all of the colors used when drawing the automap. The 'table' parameter is a Lua table where the names are automap parts and the values are the colors. For example: { grid = "#006666", wall = "#FFFFFF" }. Parts that are not present in the table are not affected (stay the same as before). Here is a list of all the automap parts that can be changed:</code>''</blockquote><blockquote>Automap Part	 Description</blockquote>
 ** grid	 Grid lines
 ** wall	 One sided walls
@@ Line 116: / Line 115: @@
 ** scenery	 Scenery items
-== Audio Functions ==
+== * Audio Functions ==
 ==== '''<code>hud.play_sound(name)</code>''' ====
@@ Line 180: / Line 179: @@
 <blockquote>''<code>Returns the number of seconds remaining for the specified powerup, or zero when the player does not have it. The berserk powerup only counts down the red-screen effect, and returns -1 when that is finished. The automap powerup returns a large value when active and it never counts down. The result for invulnerability is not affected by the God-mode cheat.</code>''</blockquote>
-== Weapon Stuff ==
+== * Weapon Stuff ==
 ==== '''player.has_weapon(name)''' ====
@@ Line 251: / Line 250: @@
 <blockquote>''<code>Returns true if player is grinning (after picking up a weapon).</code>''</blockquote>
-== Miscellaneous ==
+== * Miscellaneous ==
 ==== '''<code>player.num_players()</code>''' ====