Keen:Code Example - Smart Shovel (Part 1) - Revision history

CptTwinkie at 20:07, 18 July 2022

2022-07-18T20:07:24Z

← Older revision		Revision as of 20:07, 18 July 2022
Line 53:		Line 53:
	In your Data folder, create a file called Controls.sbc and put the following snippet of XML in there:		In your Data folder, create a file called Controls.sbc and put the following snippet of XML in there:

	<~~source~~ lang="xml" collapse="false">		<syntaxhighlight lang="xml" collapse="false" line>
	<?xml version="1.0"?>		<?xml version="1.0"?>
	<Definitions xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">		<Definitions xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
Line 66:		Line 66:

	</Definitions>		</Definitions>
	</~~source~~>		</syntaxhighlight>


Line 99:		Line 99:

	<center><font style="font-size:80%; color: #BBB;">MyObjectBuilder_SmartDiggerToolBehaviorDefinition.cs</font></center>		<center><font style="font-size:80%; color: #BBB;">MyObjectBuilder_SmartDiggerToolBehaviorDefinition.cs</font></center>
	<~~source~~ lang="csharp" collapse="false">		<syntaxhighlight lang="csharp" collapse="false" line>
	using ObjectBuilders.Definitions.Tools;		using ObjectBuilders.Definitions.Tools;
	using System.Xml.Serialization;		using System.Xml.Serialization;
Line 115:		Line 115:
	}		}
	}		}
	</~~source~~>		</syntaxhighlight>

	<center><font style="font-size:80%; color: #BBB;">MySmartDiggerToolBehaviorDefinition.cs</font></center>		<center><font style="font-size:80%; color: #BBB;">MySmartDiggerToolBehaviorDefinition.cs</font></center>
	<~~source~~ lang="csharp" collapse="false">		<syntaxhighlight lang="csharp" collapse="false" line>
	using System;		using System;
	using Medieval.Definitions.Tools;		using Medieval.Definitions.Tools;
Line 142:		Line 142:
	}		}
	}		}
	</~~source~~>		</syntaxhighlight>

	<center><font style="font-size:80%; color: #BBB;">MySmartDiggerToolBehavior.cs</font></center>		<center><font style="font-size:80%; color: #BBB;">MySmartDiggerToolBehavior.cs</font></center>
	<~~source~~ lang="csharp" collapse="false">		<syntaxhighlight lang="csharp" collapse="false" line>
	using Medieval.Definitions.Tools;		using Medieval.Definitions.Tools;
	using Medieval.GameSystems.Tools;		using Medieval.GameSystems.Tools;
Line 183:		Line 183:
	}		}
	}		}
	</~~source~~>		</syntaxhighlight>


Line 211:		Line 211:
	Let’s start with the first element, in the MyObjectBuilder_HandItemDefinition for WoodenShovel, inside the <StanceToBehavior> tag at line 34, we find the BehaviorId. Right now, it’s Type says MyObjectBuilder_DiggerToolBehaviorDefinition, we want it to say MyObjectBuilder_SmartDiggerToolBehaviorDefinition so that it refers to the correct object builder class. So replace it! Then, find the same entry for the IronShovel and repeat this process.		Let’s start with the first element, in the MyObjectBuilder_HandItemDefinition for WoodenShovel, inside the <StanceToBehavior> tag at line 34, we find the BehaviorId. Right now, it’s Type says MyObjectBuilder_DiggerToolBehaviorDefinition, we want it to say MyObjectBuilder_SmartDiggerToolBehaviorDefinition so that it refers to the correct object builder class. So replace it! Then, find the same entry for the IronShovel and repeat this process.

	<~~source~~ lang="xml" collapse="false">		<syntaxhighlight lang="xml" collapse="false" line>
	<!-- So this... -->		<!-- So this... -->
	<BehaviorId Type="MyObjectBuilder_DiggerToolBehaviorDefinition" Subtype="WoodenShovel"/>		<BehaviorId Type="MyObjectBuilder_DiggerToolBehaviorDefinition" Subtype="WoodenShovel"/>
Line 225:		Line 225:
	<!-- becomes this... -->		<!-- becomes this... -->
	<BehaviorId Type="MyObjectBuilder_SmartDiggerToolBehaviorDefinition" Subtype="IronShovel"/>		<BehaviorId Type="MyObjectBuilder_SmartDiggerToolBehaviorDefinition" Subtype="IronShovel"/>
	</~~source~~>		</syntaxhighlight>


Line 232:		Line 232:
	Replace the first two lines with the new object builder for each entry.		Replace the first two lines with the new object builder for each entry.

	<~~source~~ lang="xml" collapse="false">		<syntaxhighlight lang="xml" collapse="false" line>
	<!-- So this... -->		<!-- So this... -->
	<Definition xsi:type="MyObjectBuilder_DiggerToolBehaviorDefinition">		<Definition xsi:type="MyObjectBuilder_DiggerToolBehaviorDefinition">
Line 252:		Line 252:

	<!-- etc. -->		<!-- etc. -->
	</~~source~~>		</syntaxhighlight>


Line 260:		Line 260:
	Let’s start by adding the input handling to the shovel, as this is one of the new features in the game, and it’s really simple to set up! Open up MySmartDiggerToolBehavior.cs and after the m_definition variable declaration, put the following code:		Let’s start by adding the input handling to the shovel, as this is one of the new features in the game, and it’s really simple to set up! Open up MySmartDiggerToolBehavior.cs and after the m_definition variable declaration, put the following code:

	<~~source~~ lang="csharp" collapse="false">		<syntaxhighlight lang="csharp" collapse="false" line>
	// This is the input context object used for handling player input.		// This is the input context object used for handling player input.
	private MyInputContext m_inputContext = null;		private MyInputContext m_inputContext = null;
	</~~source~~>		</syntaxhighlight>


	Then in the Init function, after m_definition gets assigned, add the following bit of code:		Then in the Init function, after m_definition gets assigned, add the following bit of code:

	<~~source~~ lang="csharp" collapse="false">		<syntaxhighlight lang="csharp" collapse="false" line>
	// Creates a new input context, let’s call it MagicShovel for now.		// Creates a new input context, let’s call it MagicShovel for now.
	m_inputContext = new MyInputContext("MagicShovel");		m_inputContext = new MyInputContext("MagicShovel");
Line 281:		Line 281:
	Action = ScanAltitude		Action = ScanAltitude
	});		});
	</~~source~~>		</syntaxhighlight>


	And then add the following three functions into the class’ body, after the Init function has its closing }.		And then add the following three functions into the class’ body, after the Init function has its closing }.

	<~~source~~ lang="csharp" collapse="false">		<syntaxhighlight lang="csharp" collapse="false" line>
	// Called when the tool is equipped.		// Called when the tool is equipped.
	public override void Activate()		public override void Activate()
Line 311:		Line 311:
	((IMyUtilities)MyAPIUtilities.Static).ShowNotification("Button was pressed!", 1000, null, Color.Red);		((IMyUtilities)MyAPIUtilities.Static).ShowNotification("Button was pressed!", 1000, null, Color.Red);
	}		}
	</~~source~~>		</syntaxhighlight>


Line 323:		Line 323:
	We are going to replace the ScanAltitude function. So delete the body of the function, and replace it with this code. Change it so that the function looks like this:		We are going to replace the ScanAltitude function. So delete the body of the function, and replace it with this code. Change it so that the function looks like this:

	<~~source~~ lang="csharp" collapse="false">		<syntaxhighlight lang="csharp" collapse="false" line>
	// Called when the player presses the new shovel key.		// Called when the player presses the new shovel key.
	private void ScanAltitude(ref MyInputContext.ActionEvent action)		private void ScanAltitude(ref MyInputContext.ActionEvent action)
Line 340:		Line 340:
	((IMyUtilities)MyAPIUtilities.Static).ShowNotification(message, 1000, null, Color.Yellow);		((IMyUtilities)MyAPIUtilities.Static).ShowNotification(message, 1000, null, Color.Yellow);
	}		}
	</~~source~~>		</syntaxhighlight>

CptTwinkie at 12:51, 7 July 2018

2018-07-07T12:51:34Z

← Older revision		Revision as of 12:51, 7 July 2018
Line 1:		Line 1:
	{{SEO\|image_url=http://www.medievalengineerswiki.com/images/e/eb/~~KeenLogo~~.png\|description=Hello engineers, in this two-part tutorial, we will go through the basics of making a simple mod that includes some of the new functionality added in 0.5, like custom data classes and our new tool system.}}		{{SEO\|image_url=http://www.medievalengineerswiki.com/images/b/b7/KeenLogoBig.png\|description=Hello engineers, in this two-part tutorial, we will go through the basics of making a simple mod that includes some of the new functionality added in 0.5, like custom data classes and our new tool system.}}
	{{Keen:OCH}}		{{Keen:OCH}}

CptTwinkie at 12:31, 7 July 2018

2018-07-07T12:31:27Z

← Older revision		Revision as of 12:31, 7 July 2018
Line 1:		Line 1:
	{{SEO\|image_url=http://www.medievalengineerswiki.com/images/e/e6/~~KEEN_COMPASS_ONLY~~.png\|description=Hello engineers, in this two-part tutorial, we will go through the basics of making a simple mod that includes some of the new functionality added in 0.5, like custom data classes and our new tool system.}}		{{SEO\|image_url=http://www.medievalengineerswiki.com/images/e/eb/KeenLogo.png\|description=Hello engineers, in this two-part tutorial, we will go through the basics of making a simple mod that includes some of the new functionality added in 0.5, like custom data classes and our new tool system.}}
	{{Keen:OCH}}		{{Keen:OCH}}

CptTwinkie at 10:53, 29 June 2018

2018-06-29T10:53:40Z

← Older revision		Revision as of 10:53, 29 June 2018
Line 1:		Line 1:
	{{SEO\|image_url=http://www.medievalengineerswiki.com/images/e/e6/KEEN_COMPASS_ONLY.png\|description=Hello engineers, in this two-part tutorial, we will go through the basics of making a simple mod that includes some of the new functionality added in 0.5, like custom data classes and our new tool system.}}		{{SEO\|image_url=http://www.medievalengineerswiki.com/images/e/e6/KEEN_COMPASS_ONLY.png\|description=Hello engineers, in this two-part tutorial, we will go through the basics of making a simple mod that includes some of the new functionality added in 0.5, like custom data classes and our new tool system.}}
	{{:~~Official Content/~~OCH}}		{{Keen:OCH}}

CptTwinkie at 10:19, 29 June 2018

2018-06-29T10:19:10Z

← Older revision		Revision as of 10:19, 29 June 2018
Line 16:		Line 16:
	Tools required for this mod:		Tools required for this mod:

	* Some text editor, like notepad or notepad++ will suffice. If you want to use more advanced features such as code completion, you can use [[~~Official_Content/~~Visual_Studio_Setup_Guide\|Visual Studio]].		* Some text editor, like notepad or notepad++ will suffice. If you want to use more advanced features such as code completion, you can use [[Keen:Visual_Studio_Setup_Guide\|Visual Studio]].
	* A cup of coffee/tea or some other beverage of choice. ;)		* A cup of coffee/tea or some other beverage of choice. ;)

Line 96:		Line 96:
	These three files will contain your code, here are the contents of each file. These files are described further in this guide:		These three files will contain your code, here are the contents of each file. These files are described further in this guide:

	[[~~Official_Content/~~Mod_Code_Structure_Overview\|Mod Code Structure Overview]]		[[Keen:Mod_Code_Structure_Overview\|Mod Code Structure Overview]]

	<center><font style="font-size:80%; color: #BBB;">MyObjectBuilder_SmartDiggerToolBehaviorDefinition.cs</font></center>		<center><font style="font-size:80%; color: #BBB;">MyObjectBuilder_SmartDiggerToolBehaviorDefinition.cs</font></center>
Line 361:		Line 361:
	For a fun exercise in understanding, try to do the same thing to the pickaxe. Can you figure it out?		For a fun exercise in understanding, try to do the same thing to the pickaxe. Can you figure it out?

	Good luck, have fun modding it, and we’ll see you in [[~~Official_Content/~~Code_Example_-_Smart_Shovel_(Part_2)\|part two]] of the tutorial!		Good luck, have fun modding it, and we’ll see you in [[Keen:Code_Example_-_Smart_Shovel_(Part_2)\|part two]] of the tutorial!
	[[Category:Keen_Modding_Guides]]		[[Category:Keen_Modding_Guides]]

CptTwinkie: CptTwinkie moved page Official Content/Code Example - Smart Shovel (Part 1) to Keen:Code Example - Smart Shovel (Part 1)

2018-06-29T10:17:24Z

CptTwinkie moved page Official Content/Code Example - Smart Shovel (Part 1) to Keen:Code Example - Smart Shovel (Part 1)

← Older revision		Revision as of 10:17, 29 June 2018
(No difference)

CptTwinkie at 21:47, 1 June 2018

2018-06-01T21:47:59Z

← Older revision		Revision as of 21:47, 1 June 2018
Line 1:		Line 1:
			{{SEO\|image_url=http://www.medievalengineerswiki.com/images/e/e6/KEEN_COMPASS_ONLY.png\|description=Hello engineers, in this two-part tutorial, we will go through the basics of making a simple mod that includes some of the new functionality added in 0.5, like custom data classes and our new tool system.}}
	{{:Official Content/OCH}}		{{:Official Content/OCH}}

CptTwinkie at 14:57, 30 May 2018

2018-05-30T14:57:47Z

← Older revision		Revision as of 14:57, 30 May 2018
Line 1:		Line 1:
			{{:Official Content/OCH}}


	Hello engineers,		Hello engineers,

CptTwinkie: /* Definitions */

2018-04-13T10:40:50Z

Definitions

← Older revision		Revision as of 10:40, 13 April 2018
Line 213:		Line 213:
	<!-- becomes this... -->		<!-- becomes this... -->
	<BehaviorId Type="MyObjectBuilder_SmartDiggerToolBehaviorDefinition" Subtype="WoodenShovel"/>		<BehaviorId Type="MyObjectBuilder_SmartDiggerToolBehaviorDefinition" Subtype="WoodenShovel"/>



	<!-- and this... -->		<!-- and this... -->
Line 234:		Line 236:
	<Definition xsi:type="MyObjectBuilder_SmartDiggerToolBehaviorDefinition">		<Definition xsi:type="MyObjectBuilder_SmartDiggerToolBehaviorDefinition">
	<Id Type="MyObjectBuilder_SmartDiggerToolBehaviorDefinition" Subtype="WoodenShovel"/>		<Id Type="MyObjectBuilder_SmartDiggerToolBehaviorDefinition" Subtype="WoodenShovel"/>



	<!-- and this... -->		<!-- and this... -->
Line 248:		Line 252:

	With this out of the way, load up the game, your world, and now it should be working! If the shovel is available in the game, and you can use it, that means we didn’t break it! That means we’re now finally at the point where we can start making the functionality of the mod!		With this out of the way, load up the game, your world, and now it should be working! If the shovel is available in the game, and you can use it, that means we didn’t break it! That means we’re now finally at the point where we can start making the functionality of the mod!


	==Input Handling==		==Input Handling==

CptTwinkie at 10:37, 13 April 2018

2018-04-13T10:37:44Z

← Older revision		Revision as of 10:37, 13 April 2018
Line 16:		Line 16:

	==Creating A New Mod==		==Creating A New Mod==
	First, we will have to create the appropriate folder structure for the mod. Go to %appdata%\MedievalEngineers\Mods, you will probably see a folder containing many .sbm files, provided you used mods in the past, and it will probably look something similar to this:		<center>First, we will have to create the appropriate folder structure for the mod. Go to %appdata%\MedievalEngineers\Mods, you will probably see a folder containing many .sbm files, provided you used mods in the past, and it will probably look something similar to this:</center>
	[[File:SmartShovel3.png\|center\|600px\|SmartShovelFolders]]		[[File:SmartShovel3.png\|center\|600px\|SmartShovelFolders]]


	Click on New Folder, or right-click to create a new folder, and make a folder called SmartShovel. Inside this folder, we will create another folder called Data, and inside Data we will create another folder called Scripts.		<center>Click on New Folder, or right-click to create a new folder, and make a folder called SmartShovel. Inside this folder, we will create another folder called Data, and inside Data we will create another folder called Scripts.</center>


Line 33:		Line 33:


	If you load up the game now and go to new world -> setup mods, you should now see your mod in the left list. Double-click it to move it to the right list, and click Ok.		<center>If you load up the game now and go to new world -> setup mods, you should now see your mod in the left list. Double-click it to move it to the right list, and click Ok. </center>
	[[File:SmartShovel2.png\|center\|600px\|frameless\|SmartShovelMods]]		[[File:SmartShovel2.png\|center\|600px\|frameless\|SmartShovelMods]]


	Then, make sure the world is set to Creative, and Online Mode is set to Offline, otherwise, the mod won’t load.		<center>Then, make sure the world is set to Creative, and Online Mode is set to Offline, otherwise, the mod won’t load.</center>
	[[File:SmartShovel1.png\|center\|600px\|frameless\|SmartShovelWorldSettings]]		[[File:SmartShovel1.png\|center\|600px\|frameless\|SmartShovelWorldSettings]]


	Click Ok, and watch it load up the world! Great, but obviously, this doesn’t actually do anything. So let’s get to solving this.		<center>Click Ok, and watch it load up the world! Great, but obviously, this doesn’t actually do anything. So let’s get to solving this. </center>