Getting Started with CSharp (Server-Side) - Revision history

JanHolger at 11:24, 9 August 2021

2021-08-09T11:24:50Z

← Older revision		Revision as of 11:24, 9 August 2021
Line 15:		Line 15:
	Currently, installing and adding the reference is not yet supported through NUGET. Until then, the installation must be done by manually adding the DLL in the server folder. Just go into your Server-Folder and locate the dotnet folder in there. Now go into that folder and open the runtime folder in that folder. Now the path should be something like this:		Currently, installing and adding the reference is not yet supported through NUGET. Until then, the installation must be done by manually adding the DLL in the server folder. Just go into your Server-Folder and locate the dotnet folder in there. Now go into that folder and open the runtime folder in that folder. Now the path should be something like this:
	<blockquote><code>~OnsetServer/dotnet/runtime</code></blockquote>		<blockquote><code>~OnsetServer/dotnet/runtime</code></blockquote>
	Now add the following ~~three~~ DLL files to your project as reference:		Now add the following two DLL files to your project as reference:
	* Onset.Server.dll		* Onset.Server.dll
	* Onset.Common.dll
	* Onset.Shared.dll		* Onset.Shared.dll

JanHolger at 21:16, 8 August 2021

2021-08-08T21:16:56Z

← Older revision		Revision as of 21:16, 8 August 2021
Line 15:		Line 15:
	Currently, installing and adding the reference is not yet supported through NUGET. Until then, the installation must be done by manually adding the DLL in the server folder. Just go into your Server-Folder and locate the dotnet folder in there. Now go into that folder and open the runtime folder in that folder. Now the path should be something like this:		Currently, installing and adding the reference is not yet supported through NUGET. Until then, the installation must be done by manually adding the DLL in the server folder. Just go into your Server-Folder and locate the dotnet folder in there. Now go into that folder and open the runtime folder in that folder. Now the path should be something like this:
	<blockquote><code>~OnsetServer/dotnet/runtime</code></blockquote>		<blockquote><code>~OnsetServer/dotnet/runtime</code></blockquote>
	Now add the following ~~two~~ DLL files to your project as reference:		Now add the following three DLL files to your project as reference:
	* Onset.Server.dll		* Onset.Server.dll
	* Onset.Common.dll		* Onset.Common.dll
			* Onset.Shared.dll

	==Ideas and Concepts==		==Ideas and Concepts==

DasDarki: /* Some Tricks */

2021-07-18T00:00:30Z

Some Tricks

← Older revision		Revision as of 00:00, 18 July 2021
Line 249:		Line 249:
	===Adding external Libraries===		===Adding external Libraries===
	To add and load external libraries, simply drag them into the package folder with the main library and drop them into package.json at "server_files". For simplicity a wildcard can be used: "*.dll". '''Keep in mind:''' This only works for precompiled mode!		To add and load external libraries, simply drag them into the package folder with the main library and drop them into package.json at "server_files". For simplicity a wildcard can be used: "*.dll". '''Keep in mind:''' This only works for precompiled mode!

			===Exporting NUGET Libraries to the Output Directory===
			This only applies to a normal C# project (.csproj): Open the .csproj with any editor. It should contain a so called '''PropertyGroup''' at the real beginning.
			Add the following line to that '''PropertyGroup''':
			<syntaxhighlight lang="xml">
			<CopyLocalLockFileAssemblies>true</CopyLocalLockFileAssemblies>
			</syntaxhighlight>
			After saving the *.csproj and building the project, the NUGET libraries should be present in the output directory.

DasDarki: /* Some Tricks */

2021-07-13T14:38:22Z

Some Tricks

← Older revision		Revision as of 14:38, 13 July 2021
Line 246:		Line 246:
	===Using Debug Symbols to see Line Numbers in the Stacktrace===		===Using Debug Symbols to see Line Numbers in the Stacktrace===
	This trick is exculsively to the precompiled option because the JIT automatically generates debug symbols. When compiling a DLL in debug mode the compiler will automatically generate a so called PDB (debug symbols) file (if you haven't disable the option). When dragging the DLL file into the package folder, you can drag the PDB file, too in order to get line numbers in the stacktraces.		This trick is exculsively to the precompiled option because the JIT automatically generates debug symbols. When compiling a DLL in debug mode the compiler will automatically generate a so called PDB (debug symbols) file (if you haven't disable the option). When dragging the DLL file into the package folder, you can drag the PDB file, too in order to get line numbers in the stacktraces.

			===Adding external Libraries===
			To add and load external libraries, simply drag them into the package folder with the main library and drop them into package.json at "server_files". For simplicity a wildcard can be used: "*.dll". '''Keep in mind:''' This only works for precompiled mode!

DasDarki: /* Some Tricks */

2021-07-13T10:48:37Z

Some Tricks

← Older revision		Revision as of 10:48, 13 July 2021
Line 243:		Line 243:
	dim.CreateVehicle(...);		dim.CreateVehicle(...);
	</syntaxhighlight>		</syntaxhighlight>

			===Using Debug Symbols to see Line Numbers in the Stacktrace===
			This trick is exculsively to the precompiled option because the JIT automatically generates debug symbols. When compiling a DLL in debug mode the compiler will automatically generate a so called PDB (debug symbols) file (if you haven't disable the option). When dragging the DLL file into the package folder, you can drag the PDB file, too in order to get line numbers in the stacktraces.

JanHolger: Fixed 2 typos

2021-07-03T01:19:41Z

Fixed 2 typos

← Older revision		Revision as of 01:19, 3 July 2021
Line 164:		Line 164:

	===How does it work?===		===How does it work?===
	Of course, to use it properly, you should understand how interoping actually works. The actual process is very simple: A selected function is exported from C# (or Lua) and stored in the Interop Manager in the server. The exported function is identified by a predefined name and the name of the ~~pacakge~~ from which the function originates. The function can then be imported by other packages via Package Name and Function Name and called at any time. Up to now only methods with one return value (or none) are allowed from C# sides.		Of course, to use it properly, you should understand how interoping actually works. The actual process is very simple: A selected function is exported from C# (or Lua) and stored in the Interop Manager in the server. The exported function is identified by a predefined name and the name of the package from which the function originates. The function can then be imported by other packages via Package Name and Function Name and called at any time. Up to now only methods with one return value (or none) are allowed from C# sides.

	===Exporting a Function===		===Exporting a Function===
Line 213:		Line 213:
	}		}
	</syntaxhighlight>		</syntaxhighlight>
	'''Step 3:''' Let Onset know, to use your custom factory instead (put this in the main class, or in a module but ~~than~~ you need to append Package)		'''Step 3:''' Let Onset know, to use your custom factory instead (put this in the main class, or in a module but then you need to append Package)
	<syntaxhighlight lang="C#">		<syntaxhighlight lang="C#">
	Server.OverrideEntityFactory(new MyVehicleFactory());		Server.OverrideEntityFactory(new MyVehicleFactory());

DasDarki: /* Preparation */

2021-06-30T18:05:01Z

Preparation

← Older revision		Revision as of 18:05, 30 June 2021
Line 8:		Line 8:
	* Minimum basic knowledge, recommended advanced knowledge of C#		* Minimum basic knowledge, recommended advanced knowledge of C#
	* A created project for a class library for .NET 5		* A created project for a class library for .NET 5

			===Settings===
			By default the server ships the C# runtime with it. Currently we are using .NET 5.0.x. If you like to change the version used by the runtime, you need to download a new runtime, go to the corresponding runtime folder and extract the runtime there. Then you just need to change the runtime version to your new version by setting the option in the server config (see here: [[server config]]).

	==Add the Onset Library as Reference==		==Add the Onset Library as Reference==

DasDarki: /* Commands */

2021-06-30T16:49:27Z

Commands

← Older revision		Revision as of 16:49, 30 June 2021
Line 96:		Line 96:
	}		}
	</syntaxhighlight>		</syntaxhighlight>
	~~Auch hier gilt~~, ~~dass die Registrierung~~ in ~~der Main Klasse sowie~~ in ~~den Modulen automatisch von statten geht~~. ~~Andere Klassen müssen auch hier manuell registriert werden~~. ~~Dabei gilt das gleiche Prinzip wie bei den~~ Events, ~~nur statt dem~~ '''EventManager''' ~~übernimmt dies hier der~~ '''CommandManager'''.		Again, the registration in the main class and in the modules is done automatically. Other classes must be registered also here manually. The same principle applies as with the Events, only instead of the '''EventManager''' this takes over here the '''CommandManager'''.

	==Modules==		==Modules==

DasDarki: /* Casting dimension IDs into a dimension object */

2021-05-19T20:58:38Z

Casting dimension IDs into a dimension object

← Older revision		Revision as of 20:58, 19 May 2021
Line 235:		Line 235:
	===Casting dimension IDs into a dimension object===		===Casting dimension IDs into a dimension object===
	In C# there is a '''Onset.Server.Dimension''' class which wraps around the unsigned integers (dimension IDs). With that you can cast these dimension objects to uints or uints into these dimension objects to help you at some point (like spawning vehicles directly into the given dimension). Please keep in mind: These dimension wrappers are using reflection to identify the right context which can influence the performance.		In C# there is a '''Onset.Server.Dimension''' class which wraps around the unsigned integers (dimension IDs). With that you can cast these dimension objects to uints or uints into these dimension objects to help you at some point (like spawning vehicles directly into the given dimension). Please keep in mind: These dimension wrappers are using reflection to identify the right context which can influence the performance.
			<syntaxhighlight lang="C#">
			uint dimID = 1;
			Dimension dim = (Dimension) dimID;
			dim.CreateVehicle(...);
			</syntaxhighlight>

DasDarki: /* A function is missing which is in the Lua API? */

2021-05-19T20:56:42Z

A function is missing which is in the Lua API?

← Older revision		Revision as of 20:56, 19 May 2021
Line 228:		Line 228:

	===A function is missing which is in the Lua API?===		===A function is missing which is in the Lua API?===
	Some functions didn't fit into any of the object-oriented classes so there is a '''Onset.Server.Util''' class which contains utilty methods or methods which haven't got any own ~~class~~.		Some functions didn't fit into any of the object-oriented classes so there is a '''Onset.Server.Util''' class which contains utilty methods or methods which haven't got any own classes.

	===Using predefined Enums for Constants===		===Using predefined Enums for Constants===