Modding:level blueprint (0.9.9.7) - Revision history

Yaflhdztioxo at 23:25, 21 April 2013

2013-04-21T23:25:31Z

Yaflhdztioxo at 22:50, 21 April 2013

2013-04-21T22:50:05Z

Yaflhdztioxo: /* Engine Hooks */

2012-12-24T00:35:35Z

‎Engine Hooks

Yaflhdztioxo at 19:58, 22 December 2012

2012-12-22T19:58:07Z

Show changes

Yaflhdztioxo: /* Engine Hooks */

2012-12-22T19:49:54Z

‎Engine Hooks

Yaflhdztioxo: /* Engine Hooks */

2012-12-22T19:19:20Z

‎Engine Hooks

Yaflhdztioxo: /* Blueprint */

2012-12-22T18:52:06Z

‎Blueprint

Yaflhdztioxo at 17:28, 22 December 2012

2012-12-22T17:28:26Z

Yaflhdztioxo: moved Modding:level (0.9.9.7) to Modding:level blueprint (0.9.9.7)

2012-12-22T17:15:30Z

moved Modding:level (0.9.9.7) to Modding:level blueprint (0.9.9.7)

Yaflhdztioxo: moved Modding:Level (0.9.9.7) to Modding:level (0.9.9.7)

2012-12-22T16:03:46Z

moved Modding:Level (0.9.9.7) to Modding:level (0.9.9.7)

@@ Line 7: / Line 7: @@
    |es=background: #333;
    |c1=font-family:monospace; text-align:right; vertical-align:top; padding:0px 2px;
-   |c2=padding:0px 2px;
+   |c2=vertical-align:top; padding:0px 2px;
    |c3=padding:0px 2px;
    |<u>id</u>  |{{modarg|string}}|The unique identifier used by the engine for this level. Passed as the first argument when registering a blueprint.

← Older revision		Revision as of 22:50, 21 April 2013
Line 1:		Line 1:
−	The level [[Modding:blueprint\|blueprint]] is used to define the properties of fixed special levels. This is in contrast to the [[Modding:generator\|generator]] blueprint which is used to construct random levels. Both tend to make heavy use of the [[Modding:level_API\|level API]], [[Modding:~~level_MapNode~~\|level object]], and [[Modding:generator_API\|generator API]].	+	The level [[Modding:blueprint\|blueprint]] is used to define the properties of fixed special levels. This is in contrast to the [[Modding:generator\|generator]] blueprint which is used to construct random levels. Both tend to make heavy use of the [[Modding:level_API\|level API]], [[Modding:level_object\|level object]], and [[Modding:generator_API\|generator API]].

	== Blueprint ==		== Blueprint ==

@@ Line 52: / Line 52: @@
    |{{modarg|void}}    |[[#level_onuse           |OnUse           ]] ({{modarg|item}}, {{modarg|being}})
    |{{modarg|boolean}} |[[#level_onusecheck      |OnUseCheck      ]] ({{modarg|item}}, {{modarg|being}})
-   |{{modarg|void}}    |[[#level_onkill          |OnKill          ]] ()
+   |{{modarg|void}}    |[[#level_onkill          |OnKill          ]] ({{modarg|being}})
    |{{modarg|void}}    |[[#level_onkillall       |OnKillAll       ]] ()
    |{{modarg|void}}    |[[#level_onenter         |OnEnter         ]] ()
@@ Line 106: / Line 106: @@
 ----
 {{Anchor|level_onkill}}
-;OnKill()
+;OnKill({{modarg|being}})
 :Triggered whenever an enemy is killed.
 ----

@@ Line 61: / Line 61: @@
    |{{modarg|boolean}} |[[#level_cangenerate     |canGenerate     ]] ()
    |{{modarg|void}}    |[[#level_onregister      |OnRegister      ]] ()
-   |{{modarg|void}}    |[[#level_oncreate        |OnCreate        ]] ()
+   |{{modarg|void}}    |[[#level_oncreate        |OnCreate        ]] ({{modarg|being}})
-   |{{modarg|void}}    |[[#level_ondie           |OnDie           ]] ()
+  |{{modarg|void}}    |[[#level_oncreate        |OnCreate        ]] ({{modarg|item}})
-   |{{modarg|boolean}} |[[#level_ondiecheck      |OnDieCheck      ]] ()
+   |{{modarg|void}}    |[[#level_ondie           |OnDie           ]] ({{modarg|being}})
-   |{{modarg|void}}    |[[#level_onpickup        |OnPickup        ]] ()
+   |{{modarg|boolean}} |[[#level_ondiecheck      |OnDieCheck      ]] ({{modarg|being}})
-   |{{modarg|boolean}} |[[#level_onpickupcheck   |OnPickupCheck   ]] ()
+   |{{modarg|void}}    |[[#level_onpickup        |OnPickup        ]] ({{modarg|item}}, {{modarg|being}})
-   |{{modarg|void}}    |[[#level_onuse           |OnUse           ]] ()
+   |{{modarg|boolean}} |[[#level_onpickupcheck   |OnPickupCheck   ]] ({{modarg|item}}, {{modarg|being}})
-   |{{modarg|boolean}} |[[#level_onusecheck      |OnUseCheck      ]] ()
+   |{{modarg|void}}    |[[#level_onuse           |OnUse           ]] ({{modarg|item}}, {{modarg|being}})
    |{{modarg|void}}    |[[#level_onkill          |OnKill          ]] ()
    |{{modarg|void}}    |[[#level_onkillall       |OnKillAll       ]] ()
    |{{modarg|void}}    |[[#level_onenter         |OnEnter         ]] ()
-   |{{modarg|void}}    |[[#level_onfire          |OnFire          ]] ()
+   |{{modarg|boolean}} |[[#level_onfire          |OnFire          ]] ({{modarg|item}}, {{modarg|being}})
-   |{{modarg|void}}    |[[#level_onfired         |OnFired         ]] ()
+   |{{modarg|void}}    |[[#level_onfired         |OnFired         ]] ({{modarg|being}})
    |{{modarg|void}}    |[[#level_onexit          |OnExit          ]] ()
    |{{modarg|void}}    |[[#level_ontick          |OnTick          ]] ()
@@ Line 87: / Line 88: @@
 {{Anchor|level_cangenerate}}
 ;canGenerate() &rarr; '''boolean'''
-:xxx
+:This function determines if a level can show up in a given game.  If the function returns false the level will not appear.  A common requirement is the difficulty be set to at least a certain value.
 ----
 {{Anchor|level_onregister}}
 ;OnRegister()
-:xxx
+:This function should store level specific objects (such as items, cells, medals, and badges).  It is called by the engine during its loading phase.  Using this hook is not necessary (there are plenty of other places to define objects) but it is considered good practice.
 ----
 {{Anchor|level_oncreate}}
-;OnCreate()
+;OnCreate({{modarg|being}})
-:xxx
+;OnCreate({{modarg|item}})
 ----
 {{Anchor|level_ondie}}
-;OnDie()
+;OnDie({{modarg|being}})
-:xxx
+:A hook chained to the [[Modding:being blueprint#being_ondie|being]] OnDie method.
 ----
 {{Anchor|level_ondiecheck}}
-;OnDieCheck() &rarr; '''boolean'''
+;OnDieCheck({{modarg|being}}) &rarr; '''boolean'''
-:xxx
+:A hook chained to the [[Modding:being blueprint#being_ondiecheck|being]] OnDieCheck method.
 ----
 {{Anchor|level_onpickup}}
-;OnPickup()
+;OnPickup({{modarg|item}}, {{modarg|being}})
-:xxx
+:A hook chained to the [[Modding:item blueprint#item_onpickup|item]] OnPickup method.
 ----
 {{Anchor|level_onpickupcheck}}
-;OnPickupCheck() &rarr; '''boolean'''
+;OnPickupCheck({{modarg|item}}, {{modarg|being}}) &rarr; '''boolean'''
-:xxx
+:A hook chained to the [[Modding:item blueprint#item_onpickupcheck|item]] OnPickupCheck method.
 ----
 {{Anchor|level_onuse}}
-;OnUse()
+;OnUse({{modarg|item}}, {{modarg|being}})
-:xxx
+:A hook chained to the [[Modding:item blueprint#item_onuse|item]] OnUse method.
 ----
 {{Anchor|level_onusecheck}}
-;OnUseCheck() &rarr; '''boolean'''
+;OnUseCheck({{modarg|item}}, {{modarg|being}}) &rarr; '''boolean'''
-:xxx
+:A hook chained to the [[Modding:item blueprint#item_onusecheck|item]] OnUseCheck method.
 ----
 {{Anchor|level_onkill}}
@@ Line 134: / Line 136: @@
 ----
 {{Anchor|level_onfire}}
-;OnFire()
+;OnFire({{modarg|item}}, {{modarg|being}})
-:xxx
+:A hook chained to the [[Modding:item blueprint#item_onfire|item]] OnFire method.
 ----
 {{Anchor|level_onfired}}
-;OnFired()
+;OnFired({{modarg|being}})
-:xxx
+:A hook chained to the [[Modding:item blueprint#item_onfired|item]] OnFired method.
 ----
 {{Anchor|level_onexit}}
 ;OnExit()
-:xxx
+:Triggered when the player leaves a level.  This is a good place to assign level specific badges or medals as well as the best place to generate history entries for the mortem generation.
 ----
 {{Anchor|level_ontick}}

@@ Line 53: / Line 53: @@
 == Engine Hooks ==
-{|class="wikitable" style="border: 2px solid darkred; border-spacing: 0; font-size: 90%; margin: 0.25em 0.5em;"
- ! colspan="2" style="background: darkred; color: yellow; font-size: 120%; text-align: center"|'''Level Hooks'''
+{{drltable|Level Hooks|2|{{Table2Col
- {{Table2Col
    |es=background: #333;
-   |c1=font-weight:bold; text-align:right; vertical-align:top; padding:0px 2px;
+   |c1=font-family:monospace; text-align:right; vertical-align:top; padding:0px 2px;
    |c2=padding:0px 2px;
-   |void|[[#level_Create|Create]]()
+   |{{modarg|void}}    |[[#level_create          |<u>Create</u>   ]] ()
-   |void|[[#level_OnTick|OnTick]]()
+   |{{modarg|boolean}} |[[#level_cangenerate     |canGenerate     ]] ()
-   |void|[[#level_OnEnter|OnEnter]]()
+  |{{modarg|void}}    |[[#level_onregister      |OnRegister      ]] ()
-   |void|[[#level_OnExit|OnExit]]()
+   |{{modarg|void}}    |[[#level_oncreate        |OnCreate        ]] ()
-   |void|[[#level_OnKill|OnKill]]()
+   |{{modarg|void}}    |[[#level_ondie           |OnDie           ]] ()
-   |void|[[#level_OnKillAll|OnKillAll]]()
+   |{{modarg|boolean}} |[[#level_ondiecheck      |OnDieCheck      ]] ()
-   |boolean|[[#level_IsCompleted|IsCompleted]]()
+  |{{modarg|void}}    |[[#level_onpickup        |OnPickup        ]] ()
- }}
+  |{{modarg|boolean}} |[[#level_onpickupcheck   |OnPickupCheck   ]] ()
-|}
+  |{{modarg|void}}    |[[#level_onuse           |OnUse           ]] ()
-{{Anchor|level_Create}}
-;Create()
+{{Anchor|level_create}}
-:This function should create the layout of the level. It also usually sets up the initial being and item locations. The player's initial location should be set here using Level.player.
+;Create()
 ----
-{{Anchor|level_OnTick}}
+{{Anchor|level_onfire}}
-;OnTick()
+;OnFire()
-:This is called every 0.1s of game time. This will happen many times for each of the player's moves, so be careful about putting intense calculations here.
+:xxx
 ----
-{{Anchor|level_OnEnter}}
+{{Anchor|level_onfired}}
-;OnEnter()
+;OnFired()
-:This is triggered just after the player enters the level.
+:xxx
 ----
-{{Anchor|level_OnExit}}
+{{Anchor|level_onexit}}
 ;OnExit()
-:This is triggered when the player leaves the level.
+:xxx
 ----
-{{Anchor|level_OnKill}}
+{{Anchor|level_ontick}}
-;OnKill()
+;OnTick()
-:This hook is triggered whenever an enemy is killed.
+:Triggered every 0.1s of game time. This will happen many times for each of the player's moves so be careful about putting intense calculations here.
 ----
-{{Anchor|level_OnKillAll}}
+{{Anchor|level_oncompletedcheck}}
-;OnKillAll()
+;OnCompletedCheck() &rarr; '''boolean'''
-:After OnKill has triggered, if there are no enemies left on the level, the OnKillAll will be triggered. It is possible for OnKillAll to trigger again later if more enemies are spawned. By default, the "relatively safe" message is displayed.
+:Called by the engine when trying to determine if a special level should be counted as 'completed' for statistics purposes.  This is only called for special levels, not scripted levels.  By default a level is considered complete if all enemies are dead.
 ----
-{{Anchor|level_IsCompleted}}
+{{Anchor|level_onnuked}}
-;IsCompleted() &rarr; '''boolean'''
+;OnNuked()
-:The game calls this hook to determine if the game statistics should count the level as completed. This is only called for special levels, not scripted levels. By default, all enemies must be dead for the level to be complete.
+:Triggered when a nuke is detonated.
 == Properties ==

@@ Line 2: / Line 2: @@
 == Blueprint ==
-Levels prototypes are only used for special levels and scripted levels, not random levels. They are declared using the Levels function with the ID as the first argument, and a prototype table as the second argument. They are stored by ID in a global table called levels.
+Level blueprints are registered with the ''register_level'' procedure. Registered blueprints are stored in a global Lua table called ''levels''.
-{|class="wikitable" style="border: 2px solid darkred; border-spacing: 0; font-size: 90%; margin: 0.25em 0.5em;"
- ! colspan="3" style="background: darkred; color: yellow; font-size: 120%; text-align: center"|'''Level Prototype'''
+{{drltable|Level Blueprint|3|{{Table3Col
- {{Table3Col
    |es=background: #333;
-   |c1=font-weight:bold; text-align:right; vertical-align:top; padding:0px 2px;
+   |c1=font-family:monospace; text-align:right; vertical-align:top; padding:0px 2px;
-   |c2=vertical-align:top; padding:0px 2px;
+   |c2=padding:0px 2px;
    |c3=padding:0px 2px;
-   |string|ID|The unique identifier used by the engine for this level. Instead of being included in the table, this must be passed as the first argument to the Levels function.
+   |<u>id</u>  |{{modarg|string}}|The unique identifier used by the engine for this level. Passed as the first argument when registering a blueprint.
-   |string|name|The name displayed in the HUD.
+   |<u>name</u>|{{modarg|string}}|The level name displayed in the HUD.
-   |string|welcome|Optional message displayed on level entry.
+   |entry      |{{modarg|string}}|Message recorded to mortem on level entry.
-   |integer|chance|Optional percent chance the level will appear. Defaults to 100.
+   |welcome    |{{modarg|string}}|Message displayed on level entry.
-   |[[Modding:Functions$function_resolve_range|Range]]|level|Level range where the level may appear.
+   |level      |{{modarg|range}} |dlevel range where the level may appear.
-   |string|entry|Optional mortem history message for level entry.
+   |<u>Create</u>   |{{modarg|function}}|
- }}
+  |canGenerate     |{{modarg|function}}|
-|}
+  |OnRegister      |{{modarg|function}}|
 === Flags ===
 {{drltable|Level Flags|2|{{Table2Col
@@ Line 34: / Line 51: @@
    |}}
 }}
 == Engine Hooks ==
 {|class="wikitable" style="border: 2px solid darkred; border-spacing: 0; font-size: 90%; margin: 0.25em 0.5em;"

@@ Line 1: / Line 1: @@
-Level objects define the properties of fixed special levels. The level API, however, is a general purpose API for manipulating the level. This is used both for map generation (along with the [[Modding:Generator#API|generator API]]) and for changing the level on the fly. The Level variable also has some general properties that don't necessarily correspond to special levels in particular.
+The level [[Modding:blueprint|blueprint]] is used to define the properties of fixed special levels. This is in contrast to the [[Modding:generator|generator]] blueprint which is used to construct random levels.  Both tend to make heavy use of the [[Modding:level_API|level API]], [[Modding:level_MapNode|level object]], and [[Modding:generator_API|generator API]].
-== Prototype ==
+== Blueprint ==
 Levels prototypes are only used for special levels and scripted levels, not random levels. They are declared using the Levels function with the ID as the first argument, and a prototype table as the second argument. They are stored by ID in a global table called levels.
 {|class="wikitable" style="border: 2px solid darkred; border-spacing: 0; font-size: 90%; margin: 0.25em 0.5em;"