Creating a GameMode - Revision history

Scratch at 10:33, 31 July 2017

2017-07-31T10:33:49Z

Scratch at 15:07, 27 June 2017

2017-06-27T15:07:06Z

Scratch: /* Versus */

2017-06-27T11:08:16Z

‎Versus

Scratch at 10:58, 27 June 2017

2017-06-27T10:58:37Z

Scratch at 09:09, 27 June 2017

2017-06-27T09:09:05Z

Scratch at 09:03, 27 June 2017

2017-06-27T09:03:21Z

Scratch at 14:46, 24 June 2017

2017-06-24T14:46:15Z

Scratch at 14:43, 24 June 2017

2017-06-24T14:43:12Z

Scratch at 13:53, 24 June 2017

2017-06-24T13:53:30Z

Scratch at 13:52, 24 June 2017

2017-06-24T13:52:45Z

← Older revision		Revision as of 10:33, 31 July 2017
Line 165:		Line 165:
	</pre>		</pre>

−	[[Category:~~Guides~~]]	+	[[Category:Tutorials]]

← Older revision		Revision as of 15:07, 27 June 2017
Line 1:		Line 1:
−	~~{{NewBuild\|The minimal example using <code>BaseGameMode</code> described here will cause null reference exceptions if <code>GetHUD()</code> returns null.}}~~
−
	Gamemodes define rules about what should happen on a level. They are set in a level file. Typically when making a gamemode, you'll want to inherit the class from either <code>BaseGameMode</code>, <code>VersusGameMode</code>, or <code>TeamVersusGameMode</code>. Or, if you're just adding something very simple to an existing gamemode, you can also inherit from <code>Campaign</code>, <code>Survival</code>, <code>Deathmatch</code>, etc.		Gamemodes define rules about what should happen on a level. They are set in a level file. Typically when making a gamemode, you'll want to inherit the class from either <code>BaseGameMode</code>, <code>VersusGameMode</code>, or <code>TeamVersusGameMode</code>. Or, if you're just adding something very simple to an existing gamemode, you can also inherit from <code>Campaign</code>, <code>Survival</code>, <code>Deathmatch</code>, etc.

@@ Line 61: / Line 61: @@
 == Versus ==
 We provide a few base gamemodes for versus, in particular <code>VersusGameMode</code> and <code>TeamVersusGameMode</code>. The former is for free-for-all based versus modes (like Deathmatch), and the latter is for team based versus modes (like Team Deathmatch).
 <pre class="prettyprint">
-//
+[GameMode]
 </pre>

@@ Line 117: / Line 117: @@
 int SomeNumber;
 </pre>
 == Functions ==

@@ Line 6: / Line 6: @@
 = Base =
 There are several ways you can set up the base of a gamemode.
 == Minimal gamemode ==
 The most minimal gamemode you can make is this:
@@ Line 71: / Line 69: @@
 == Default HUD ==
 If you are using BaseGameMode, you probably also want to add a default HUD so you know what's happening. To do this, we have to do a few things:
@@ Line 106: / Line 103: @@
 Additionally, you can create a class that inherits from <code>HUD</code> and use that instead, if you want to modify any behavior inside of the default HUD. '''Note''': This is not how you add new HUD elements. If you want to add new HUD elements, see [[Creating an interface]].
 == Functions ==

@@ Line 4: / Line 4: @@
 These scripts are typically saved in your scenario in a <code>scripts/gamemodes</code> folder.
 == Minimal gamemode ==
@@ Line 41: / Line 45: @@
 </pre>
-At this point you probably also want to add a HUD so you know what's happening. To do this, we have to do a few things:
+== Custom campaign ==
 * Instantiate a <code>HUD</code> object using the GUI builder
-* Return the object in the <code>GetHUD()</code> method
+* Return the object in the gamemode's <code>GetHUD()</code> method
 * Update the HUD in the <code>UpdateWidgets(...)</code> method
 * Render the HUD in the <code>RenderWidgets(...)</code> method
@@ Line 74: / Line 105: @@
 </pre>
-Additionally, you can create a class that inherits from <code>HUD</code> and use that instead, if you want to modify any behavior inside of the default HUD.
+Additionally, you can create a class that inherits from <code>HUD</code> and use that instead, if you want to modify any behavior inside of the default HUD. '''Note''': This is not how you add new HUD elements. If you want to add new HUD elements, see [[Creating an interface]].
 == Functions ==

@@ Line 2: / Line 2: @@
 Gamemodes define rules about what should happen on a level. They are set in a level file. Typically when making a gamemode, you'll want to inherit the class from either <code>BaseGameMode</code>, <code>VersusGameMode</code>, or <code>TeamVersusGameMode</code>. Or, if you're just adding something very simple to an existing gamemode, you can also inherit from <code>Campaign</code>, <code>Survival</code>, <code>Deathmatch</code>, etc.
 == Minimal gamemode ==
@@ Line 19: / Line 21: @@
 Note the <code>[GameMode]</code> preprocessor that describes our <code>BasicGamemode</code> class. This tells the engine that this class is a gamemode that should show up in the editor and be a playable gamemode.
 The above will simply spawn the player in the map without any weapons or HUD. If we wanted to give the player a few weapons for example, we'd add an override for <code>SpawnPlayer</code> provided by <code>BaseGameMode</code>:

@@ Line 7: / Line 7: @@
 The most minimal gamemode you can make is this:
-<pre>
+<pre class="prettyprint">
 [GameMode]
 class BasicGamemode : BaseGameMode
@@ Line 22: / Line 22: @@
 The above will simply spawn the player in the map without any weapons or HUD. If we wanted to give the player a few weapons for example, we'd add an override for <code>SpawnPlayer</code> provided by <code>BaseGameMode</code>:
-<pre>
+<pre class="prettyprint">
 void SpawnPlayer(int i, vec2 pos = vec2(), int unitId = 0, uint team = 0) override
+{
@@ Line 46: / Line 46: @@
 This looks roughly like this:
-<pre>
+<pre class="prettyprint">
 HUD@ m_hud;
@@ Line 75: / Line 75: @@
 If you want to base your gamemode on the default <code>Campaign</code> gamemode, setting it up is as smple as inheriting from <code>Campaign</code>:
-<pre>
+<pre class="prettyprint">
 [GameMode]
 class MyOwnCampaign : Campaign
@@ Line 91: / Line 91: @@
 We provide a few base gamemodes for versus, in particular <code>VersusGameMode</code> and <code>TeamVersusGameMode</code>. The former is for free-for-all based versus modes (like Deathmatch), and the latter is for team based versus modes (like Team Deathmatch).
-<pre>
+<pre class="prettyprint">
 //
 </pre>

← Older revision		Revision as of 13:53, 24 June 2017
Line 1:		Line 1:
−	{{NewBuild\|The minimal example using <code>BaseGameMode</code> described here will cause null reference exceptions.}}	+	{{NewBuild\|The minimal example using <code>BaseGameMode</code> described here will cause null reference exceptions if <code>GetHUD()</code> returns null.}}

	Gamemodes define rules about what should happen on a level. They are set in a level file. Typically when making a gamemode, you'll want to inherit the class from either <code>BaseGameMode</code>, <code>VersusGameMode</code>, or <code>TeamVersusGameMode</code>. Or, if you're just adding something very simple to an existing gamemode, you can also inherit from <code>Campaign</code>, <code>Survival</code>, <code>Deathmatch</code>, etc.		Gamemodes define rules about what should happen on a level. They are set in a level file. Typically when making a gamemode, you'll want to inherit the class from either <code>BaseGameMode</code>, <code>VersusGameMode</code>, or <code>TeamVersusGameMode</code>. Or, if you're just adding something very simple to an existing gamemode, you can also inherit from <code>Campaign</code>, <code>Survival</code>, <code>Deathmatch</code>, etc.

← Older revision		Revision as of 13:52, 24 June 2017
Line 71:		Line 71:

	Additionally, you can create a class that inherits from <code>HUD</code> and use that instead, if you want to modify any behavior inside of the default HUD.		Additionally, you can create a class that inherits from <code>HUD</code> and use that instead, if you want to modify any behavior inside of the default HUD.
		+
		+	== Custom campaign ==
		+	If you want to base your gamemode on the default <code>Campaign</code> gamemode, setting it up is as smple as inheriting from <code>Campaign</code>:
		+
		+	<pre>
		+	[GameMode]
		+	class MyOwnCampaign : Campaign
		+	{
		+	MyOwnCampaign(Scene@ scene)
		+	{
		+	super(scene);
		+	}
		+	}
		+	</pre>
		+
		+	Your gamemode will then work exactly like the official Campaign gamemode. You can then override methods to modify any of the gamemode behavior.
		+
		+	== Versus ==
		+	We provide a few base gamemodes for versus, in particular <code>VersusGameMode</code> and <code>TeamVersusGameMode</code>. The former is for free-for-all based versus modes (like Deathmatch), and the latter is for team based versus modes (like Team Deathmatch).
		+
		+	<pre>
		+	//
		+	</pre>

	== Functions ==		== Functions ==