Mod Examples - Revision history

F: Minor edit to force page regen

2018-08-09T13:26:24Z

Minor edit to force page regen

← Older revision		Revision as of 13:26, 9 August 2018
Line 1:		Line 1:
	This page demonstrates examples of modifying and extending fCraft.		This page demonstrates examples of modifying and extending fCraft via source code modification.

	==Hooking up custom code==		==Hooking up custom code==

F: /* Adding a new command */ Command -> CommandReader

2014-01-21T22:56:09Z

Adding a new command: Command -> CommandReader

← Older revision		Revision as of 22:56, 21 January 2014
Line 87:		Line 87:

	// Command handler - must implement CommandHandler delegate		// Command handler - must implement CommandHandler delegate
	void BleepHandler( Player player, ~~Command~~ cmd ) {		void BleepHandler( Player player, CommandReader cmd ) {
	int numberOfBleeps = 10;		int numberOfBleeps = 10;

Line 114:		Line 114:
	CommandManager.RegisterCustomCommand( CdBleep );		CommandManager.RegisterCustomCommand( CdBleep );
	</syntaxhighlight>		</syntaxhighlight>


	==Reacting to server shutdown==		==Reacting to server shutdown==

F at 22:54, 21 January 2014

2014-01-21T22:54:42Z

← Older revision		Revision as of 22:54, 21 January 2014
Line 172:		Line 172:

	Related methods: <code>Player.SelectionAddMark(...)</code>, <code>Player.SelectionExecute()</code>, <code>Player.SelectionResetMarks()</code>, <code>Player.SelectionCancel()</code>		Related methods: <code>Player.SelectionAddMark(...)</code>, <code>Player.SelectionExecute()</code>, <code>Player.SelectionResetMarks()</code>, <code>Player.SelectionCancel()</code>


			==Adding custom permissions==
			To add a new permission:
			* Add a new constant to <code>Permissions</code> enum (<i>fCraft/Player/Permissions.cs</i>)
			* Give the new permission to some default ranks (at least to the highest rank), in <code>Config.DefineDefaultRanks()</code> (<i>fCraft/System/Config.cs</i>)
			* Add a tooltip explaining the permission in ConfigGUI's <code>MainForm.FillToolTipsRanks()</code> (<i>ConfigGUI/MainForm.ToolTip.cs</i>)

			To add a per-rank limit to the new permission:
			* For every rank that has this permission, add a default limit to <code>Config.DefineDefaultRanks()</code> (<i>fCraft/System/Config.cs</i>)
			* Add a way to set the limit in ConfigGUI's <code>MainForm.FillPermissionLimitBoxes()</code> (<i>ConfigGUI/MainForm.cs</i>)
			* Add a tooltip explaining the permission limit in <code>MainForm.FillToolTipsRanks()</code> (<i>ConfigGUI/MainForm.ToolTip.cs</i>)

	[[Category:Dev]]		[[Category:Dev]]

F: /* Starting selections */

2014-01-08T05:04:31Z

Starting selections

← Older revision		Revision as of 05:04, 8 January 2014
Line 170:		Line 170:
	</syntaxhighlight>		</syntaxhighlight>
	Related properties: <code>Player.DisableClickToMark</code>, <code>Player.IsMakingSelection</code>, <code>Player.SelectionMarkCount</code>, <code>Player.SelectionMarksExpected</code>, <code>Player.IsRepeatingSelection</code>		Related properties: <code>Player.DisableClickToMark</code>, <code>Player.IsMakingSelection</code>, <code>Player.SelectionMarkCount</code>, <code>Player.SelectionMarksExpected</code>, <code>Player.IsRepeatingSelection</code>

	Related methods: <code>Player.SelectionAddMark(...)</code>, <code>Player.SelectionExecute()</code>, <code>Player.SelectionResetMarks()</code>, <code>Player.SelectionCancel()</code>		Related methods: <code>Player.SelectionAddMark(...)</code>, <code>Player.SelectionExecute()</code>, <code>Player.SelectionResetMarks()</code>, <code>Player.SelectionCancel()</code>

	[[Category:Dev]]		[[Category:Dev]]

F: /* Starting selections */

2014-01-08T05:04:18Z

Starting selections

← Older revision		Revision as of 05:04, 8 January 2014
Line 134:		Line 134:
	==Starting selections==		==Starting selections==
	If you need the player to mark one or more coordinates for you (for example for a draw command), you'll be using the Selection API. Call player.StartSelection(...) to initiate a selection, and return control to fCraft. If/when player marks the required number of blocks, your callback will be called. If player cancels, disconnects, or starts another selection, then your callback will not be invoked.		If you need the player to mark one or more coordinates for you (for example for a draw command), you'll be using the Selection API. Call player.StartSelection(...) to initiate a selection, and return control to fCraft. If/when player marks the required number of blocks, your callback will be called. If player cancels, disconnects, or starts another selection, then your callback will not be invoked.

			Also note that while a player is in selection mode <code>Player.PlacingBlock</code> and <code>Player.PlacedBlock</code> events are not fired for clicks. <code>Player.Clicking</code> and <code>Player.Clicked</code> events are still fired.

	<syntaxhighlight lang="csharp">		<syntaxhighlight lang="csharp">
	// This is where you start/set up the selection.		// This is where you start/set up the selection.
Line 166:		Line 169:

	</syntaxhighlight>		</syntaxhighlight>
			Related properties: <code>Player.DisableClickToMark</code>, <code>Player.IsMakingSelection</code>, <code>Player.SelectionMarkCount</code>, <code>Player.SelectionMarksExpected</code>, <code>Player.IsRepeatingSelection</code>
			Related methods: <code>Player.SelectionAddMark(...)</code>, <code>Player.SelectionExecute()</code>, <code>Player.SelectionResetMarks()</code>, <code>Player.SelectionCancel()</code>

	[[Category:Dev]]		[[Category:Dev]]

F: Added example of selection API

2014-01-08T04:59:16Z

Added example of selection API

@@ Line 129: / Line 129: @@
+     }
+}
 </syntaxhighlight>
 [[Category:Dev]]

F: /* Hooking up custom code */

2013-08-25T10:47:06Z

Hooking up custom code

← Older revision		Revision as of 10:47, 25 August 2013
Line 2:		Line 2:

	==Hooking up custom code==		==Hooking up custom code==
	{{warning\|This method of modding fCraft's code directly will be obsoleted when the plugin system is done}}		{{warning\|This method of modding fCraft's code directly will be obsoleted if/when the plugin system is done}}
	Until the proper Plugin API is finished, I recommend minimizing edits to fCraft's existing files, and trying to contain all custom code in your own namespace/files. You will need to make at least one change to Server.cs though, to add your code to run on startup. Use that very first call to subscribe to various events. For detailed information about the startup procedure, see [[API: Startup]].		Until the proper Plugin API is finished, I recommend minimizing edits to fCraft's existing files, and trying to contain all custom code in your own namespace/files. You will need to make at least one change to Server.cs though, to add your code to run on startup. Use that very first call to subscribe to various events. For detailed information about the startup procedure, see [[API: Startup]].
	<syntaxhighlight lang="csharp">		<syntaxhighlight lang="csharp">
Line 28:		Line 28:
	}		}
	</syntaxhighlight>		</syntaxhighlight>


	==Calling custom code at regular intervals==		==Calling custom code at regular intervals==

75.70.55.0 at 17:53, 27 March 2012

2012-03-27T17:53:32Z

← Older revision		Revision as of 17:53, 27 March 2012
Line 2:		Line 2:

	==Hooking up custom code==		==Hooking up custom code==
			{{warning\|This method of modding fCraft's code directly will be obsoleted when the plugin system is done}}
	Until the proper Plugin API is finished, I recommend minimizing edits to fCraft's existing files, and trying to contain all custom code in your own namespace/files. You will need to make at least one change to Server.cs though, to add your code to run on startup. Use that very first call to subscribe to various events. For detailed information about the startup procedure, see [[API: Startup]].		Until the proper Plugin API is finished, I recommend minimizing edits to fCraft's existing files, and trying to contain all custom code in your own namespace/files. You will need to make at least one change to Server.cs though, to add your code to run on startup. Use that very first call to subscribe to various events. For detailed information about the startup procedure, see [[API: Startup]].
	<syntaxhighlight lang="csharp">		<syntaxhighlight lang="csharp">

F at 02:48, 25 February 2012

2012-02-25T02:48:57Z

← Older revision		Revision as of 02:48, 25 February 2012
Line 87:		Line 87:

	// Command handler - must implement CommandHandler delegate		// Command handler - must implement CommandHandler delegate
	void BleepHandler( Player player, ~~CommandReader~~ cmd ) {		void BleepHandler( Player player, Command cmd ) {
	int numberOfBleeps = 10;		int numberOfBleeps = 10;

F at 02:36, 25 February 2012

2012-02-25T02:36:10Z

← Older revision		Revision as of 02:36, 25 February 2012
Line 27:		Line 27:
	}		}
	</syntaxhighlight>		</syntaxhighlight>


	==Calling custom code at regular intervals==		==Calling custom code at regular intervals==
Line 69:		Line 70:
	}		}
	</syntaxhighlight>		</syntaxhighlight>


	==Adding a new command==		==Adding a new command==
Line 112:		Line 114:
	CommandManager.RegisterCustomCommand( CdBleep );		CommandManager.RegisterCustomCommand( CdBleep );
	</syntaxhighlight>		</syntaxhighlight>


	==Reacting to server shutdown==		==Reacting to server shutdown==