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

CptTwinkie at 20:08, 18 July 2022

2022-07-18T20:08:10Z

← Older revision		Revision as of 20:08, 18 July 2022
Line 14:		Line 14:
	Let’s start with adding the data to the definitions. Open MyObjectBuilder_SmartDiggerToolBehaviourDefinition.cs and add the following two variables to the definition:		Let’s start with adding the data to the definitions. Open MyObjectBuilder_SmartDiggerToolBehaviourDefinition.cs and add the following two variables to the definition:

	<~~source~~ lang="csharp" collapse="false">		<syntaxhighlight lang="csharp" collapse="false" line>
	// Name of the control as specified in Controls.sbc		// Name of the control as specified in Controls.sbc
	public string ControlName;		public string ControlName;
Line 20:		Line 20:
	// Format of the message displayed to the player.		// Format of the message displayed to the player.
	public string AltitudeFormat;		public string AltitudeFormat;
	</~~source~~>		</syntaxhighlight>


Line 26:		Line 26:
	Now that we updated the Object Builder to contain these two values, we can start to use it in the code. First, we have to load it into the definition. So open MySmartDiggerToolBehaviorDefinition.cs and add the following two variables:		Now that we updated the Object Builder to contain these two values, we can start to use it in the code. First, we have to load it into the definition. So open MySmartDiggerToolBehaviorDefinition.cs and add the following two variables:

	<~~source~~ lang="csharp" collapse="false">		<syntaxhighlight lang="csharp" collapse="false" line>
	// A hashed value of the control name, this is better for performance.		// A hashed value of the control name, this is better for performance.
	// Use string hashes for strings that are used as identifiers.		// Use string hashes for strings that are used as identifiers.
Line 34:		Line 34:
	// Use MyStringId for texts that are displayed to players.		// Use MyStringId for texts that are displayed to players.
	public MyStringId AltitudeFormat { get; private set; }		public MyStringId AltitudeFormat { get; private set; }
	</~~source~~>		</syntaxhighlight>


	And make the Init function look like this:		And make the Init function look like this:

	<~~source~~ lang="csharp" collapse="false">		<syntaxhighlight lang="csharp" collapse="false" line>
	// Called when the game loads up and creates definitions out of all the SBC files.		// Called when the game loads up and creates definitions out of all the SBC files.
	protected override void Init(MyObjectBuilder_DefinitionBase builder)		protected override void Init(MyObjectBuilder_DefinitionBase builder)
Line 53:		Line 53:
	AltitudeFormat = MyStringId.GetOrCompute(ob.AltitudeFormat);		AltitudeFormat = MyStringId.GetOrCompute(ob.AltitudeFormat);
	}		}
	</~~source~~>		</syntaxhighlight>


Line 59:		Line 59:
	Now that the definition is updated, we’re half-way there! All that’s left is integrating these values into the code in MySmartDiggerToolBehavior.cs and adding the data to Shovel.sbc. Let’s begin by integrating it into the code. Open MySmartDiggerToolBehavior.cs and find the Init method. Then, replace the MyStringHash.GetOrCompute(“ToggleShovel”) with m_definition.ControlName.		Now that the definition is updated, we’re half-way there! All that’s left is integrating these values into the code in MySmartDiggerToolBehavior.cs and adding the data to Shovel.sbc. Let’s begin by integrating it into the code. Open MySmartDiggerToolBehavior.cs and find the Init method. Then, replace the MyStringHash.GetOrCompute(“ToggleShovel”) with m_definition.ControlName.

	<~~source~~ lang="csharp" collapse="false">		<syntaxhighlight lang="csharp" collapse="false" line>
	// So this...		// So this...
	m_inputContext.Actions.Add(MyStringHash.GetOrCompute("ToggleShovel"), new MyInputContext.ActionBinding		m_inputContext.Actions.Add(MyStringHash.GetOrCompute("ToggleShovel"), new MyInputContext.ActionBinding
Line 65:		Line 65:
	// becomes this...		// becomes this...
	m_inputContext.Actions.Add(m_definition.ControlName, new MyInputContext.ActionBinding		m_inputContext.Actions.Add(m_definition.ControlName, new MyInputContext.ActionBinding
	</~~source~~>		</syntaxhighlight>


	Then, in ScanAltitude, replace the hardcoded “Altitude: {0:0.0}m” string with MyTexts.GetString(m_definition.AltitudeFormat):		Then, in ScanAltitude, replace the hardcoded “Altitude: {0:0.0}m” string with MyTexts.GetString(m_definition.AltitudeFormat):

	<~~source~~ lang="csharp" collapse="false">		<syntaxhighlight lang="csharp" collapse="false" line>
	// So this...		// So this...
	string message = string.Format("Altitude: {0:0.0}m", altitude);		string message = string.Format("Altitude: {0:0.0}m", altitude);
Line 76:		Line 76:
	// becomes this...		// becomes this...
	string message = string.Format(MyTexts.GetString(m_definition.AltitudeFormat), altitude);		string message = string.Format(MyTexts.GetString(m_definition.AltitudeFormat), altitude);
	</~~source~~>		</syntaxhighlight>


Line 82:		Line 82:
	All that’s left is to open up Shovel.sbc and add some fields! Which is what we’re going to be doing next. In the WoodenShovel and IronShovel behavior definitions, the ones we had to change the object builder and type for (lines 73/74 and lines 103/104) add two fields for each of them at the end of the definition:		All that’s left is to open up Shovel.sbc and add some fields! Which is what we’re going to be doing next. In the WoodenShovel and IronShovel behavior definitions, the ones we had to change the object builder and type for (lines 73/74 and lines 103/104) add two fields for each of them at the end of the definition:

	<~~source~~ lang="xml" collapse="false">		<syntaxhighlight lang="xml" collapse="false" line>
	<ControlName>ToggleShovel</ControlName>		<ControlName>ToggleShovel</ControlName>
	<AltitudeFormat>Altitude: {0:0.0}m</AltitudeFormat>		<AltitudeFormat>Altitude: {0:0.0}m</AltitudeFormat>
	</~~source~~>		</syntaxhighlight>

CptTwinkie at 12:51, 7 July 2018

2018-07-07T12:51:33Z

← 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, this tutorial continues on the Smart Shovel (Part 1) tutorial}}		{{SEO\|image_url=http://www.medievalengineerswiki.com/images/b/b7/KeenLogoBig.png\|description=Hello engineers, this tutorial continues on the Smart Shovel (Part 1) tutorial}}
	{{Keen:OCH}}		{{Keen:OCH}}

CptTwinkie at 12:31, 7 July 2018

2018-07-07T12:31:32Z

← 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, this tutorial continues on the Smart Shovel (Part 1) tutorial}}		{{SEO\|image_url=http://www.medievalengineerswiki.com/images/e/eb/KeenLogo.png\|description=Hello engineers, this tutorial continues on the Smart Shovel (Part 1) tutorial}}
	{{Keen:OCH}}		{{Keen:OCH}}

CptTwinkie at 10:53, 29 June 2018

2018-06-29T10:53:43Z

← 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, this tutorial continues on the Smart Shovel (Part 1) tutorial}}		{{SEO\|image_url=http://www.medievalengineerswiki.com/images/e/e6/KEEN_COMPASS_ONLY.png\|description=Hello engineers, this tutorial continues on the Smart Shovel (Part 1) tutorial}}
	{{:~~Official Content/~~OCH}}		{{Keen:OCH}}

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

2018-06-29T10:18:30Z

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

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

CptTwinkie at 10:18, 29 June 2018

2018-06-29T10:18:09Z

← Older revision		Revision as of 10:18, 29 June 2018
Line 5:		Line 5:
	Hello engineers,		Hello engineers,

	This tutorial continues on the [[~~Official_Content/~~Code_Example_-_Smart_Shovel_(Part_1)\|Smart Shovel (Part 1)]] tutorial, we expect you to have a fully functional version of the mod. If it’s not functioning right, please make sure you go back and make it work correctly first.		This tutorial continues on the [[Keen:Code_Example_-_Smart_Shovel_(Part_1)\|Smart Shovel (Part 1)]] tutorial, we expect you to have a fully functional version of the mod. If it’s not functioning right, please make sure you go back and make it work correctly first.
	After completing the first part, there are more things we can do to make the mod nicer. Let's put the message format and the input keybinding into the definition, instead of leaving it hard-coded.		After completing the first part, there are more things we can do to make the mod nicer. Let's put the message format and the input keybinding into the definition, instead of leaving it hard-coded.

CptTwinkie at 21:47, 1 June 2018

2018-06-01T21:47:34Z

← 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, this tutorial continues on the Smart Shovel (Part 1) tutorial}}
	{{:Official Content/OCH}}		{{:Official Content/OCH}}

CptTwinkie at 14:57, 30 May 2018

2018-05-30T14:57:51Z

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


	Hello engineers,		Hello engineers,

CptTwinkie at 17:54, 27 December 2017

2017-12-27T17:54:12Z

← Older revision		Revision as of 17:54, 27 December 2017
Line 6:		Line 6:

	{{Version <!-- Do not change the version until the entire page is up-to-date -->		{{Version <!-- Do not change the version until the entire page is up-to-date -->
	\|release=0		\|release=0\|major=5\|minor=X\|suppress=true}}
	\|major=5
	}}
	==New Definition Variables==		==New Definition Variables==
	Let’s start with adding the data to the definitions. Open MyObjectBuilder_SmartDiggerToolBehaviourDefinition.cs and add the following two variables to the definition:		Let’s start with adding the data to the definitions. Open MyObjectBuilder_SmartDiggerToolBehaviourDefinition.cs and add the following two variables to the definition:

CptTwinkie at 15:39, 17 December 2017

2017-12-17T15:39:46Z

← Older revision		Revision as of 15:39, 17 December 2017
Line 5:		Line 5:


			{{Version <!-- Do not change the version until the entire page is up-to-date -->
			\|release=0
			\|major=5
			}}
	==New Definition Variables==		==New Definition Variables==
	Let’s start with adding the data to the definitions. Open MyObjectBuilder_SmartDiggerToolBehaviourDefinition.cs and add the following two variables to the definition:		Let’s start with adding the data to the definitions. Open MyObjectBuilder_SmartDiggerToolBehaviourDefinition.cs and add the following two variables to the definition: