API - Revision history

Skizzerz: /* Reading API documentation */

2017-04-20T19:06:21Z

Reading API documentation

Skizzerz: /* Reading API documentation */

2017-04-20T19:01:24Z

Reading API documentation

Skizzerz at 19:00, 20 April 2017

2017-04-20T19:00:05Z

Skizzerz at 22:37, 19 April 2017

2017-04-19T22:37:02Z

Skizzerz at 22:34, 19 April 2017

2017-04-19T22:34:54Z

Skizzerz at 07:24, 9 April 2017

2017-04-09T07:24:59Z

Skizzerz at 05:28, 9 April 2017

2017-04-09T05:28:13Z

Skizzerz at 04:24, 9 April 2017

2017-04-09T04:24:27Z

Skizzerz: /* Configuring the roller */

2017-04-09T04:24:11Z

Configuring the roller

Skizzerz at 16:43, 8 April 2017

2017-04-08T16:43:45Z

@@ Line 19: / Line 19: @@
 Many icons are used in the API documentation. Hovering over these icons will give a tooltip indicating what the icon means. This library follows [http://semver.org/ Semantic Versioning] conventions. As such, backwards-incompatible changes will not be introduced into the public API on minor or point releases. The API documentation here documents both the public API as well as the internal (private) API, as it is intended to be useful for developers working on the library itself as well. Public API methods are marked with either public ({{public}}) or protected ({{protected}}) lock icons, whereas internal API methods are marked with internal ({{internal}}) or private ({{private}}) lock icons. Internal API may change in backwards-incompatible ways across minor or point releases. If you are using Reflection to access the internal API from code which consumes this library, it is your responsibility to test all updates before applying them.
-The public API is CLS compliant and will work with any programming language targeting .NET, whereas the internal API requires using C#.
+The public API (with exception of the Dice.Grammar namespace) is CLS compliant and will work with any programming language targeting .NET, whereas the internal API requires using C#.
 == See also ==

@@ Line 18: / Line 18: @@
 == Reading API documentation ==
 Many icons are used in the API documentation. Hovering over these icons will give a tooltip indicating what the icon means. This library follows [http://semver.org/ Semantic Versioning] conventions. As such, backwards-incompatible changes will not be introduced into the public API on minor or point releases. The API documentation here documents both the public API as well as the internal (private) API, as it is intended to be useful for developers working on the library itself as well. Public API methods are marked with either public ({{public}}) or protected ({{protected}}) lock icons, whereas internal API methods are marked with internal ({{internal}}) or private ({{private}}) lock icons. Internal API may change in backwards-incompatible ways across minor or point releases. If you are using Reflection to access the internal API from code which consumes this library, it is your responsibility to test all updates before applying them.
 == See also ==

@@ Line 15: / Line 15: @@
 == Adding functions ==
 To add functions, make use of the [[Dice/FunctionRegistry/RegisterType|FunctionRegistry.RegisterType]] or [[Dice/FunctionRegistry/RegisterFunction|FunctionRegistry.RegisterFunction]] methods. The first method (RegisterType) makes it easy to register numerous functions all at once.
 == See also ==

@@ Line 6: / Line 6: @@
 == Getting results ==
 The Roller.Roll method returns a [[Dice/RollResult|RollResult]] object, which contains the final roll value as well as the dice rolled. Generally, this is enough information to view and display results, however more fine-grained information can be obtained by walking through the roll tree. For example, in the dice expression {{c|(1d8)d6}}, a 1d8 is rolled, and then that many d6s are rolled. However, the RollResult will only contain the values of the d6s, it won't contain the value of the d8. You could figure it out by looking at the number of d6s there are, but it is also possible to directly inspect the d8 by walking the dice abstract syntax tree.
 == Configuring the roller ==

← Older revision		Revision as of 22:34, 19 April 2017
Line 12:		Line 12:
	== Adding functions ==		== Adding functions ==
	To add functions, make use of the [[Dice/FunctionRegistry/RegisterType\|FunctionRegistry.RegisterType]] or [[Dice/FunctionRegistry/RegisterFunction\|FunctionRegistry.RegisterFunction]] methods. The first method (RegisterType) makes it easy to register numerous functions all at once.		To add functions, make use of the [[Dice/FunctionRegistry/RegisterType\|FunctionRegistry.RegisterType]] or [[Dice/FunctionRegistry/RegisterFunction\|FunctionRegistry.RegisterFunction]] methods. The first method (RegisterType) makes it easy to register numerous functions all at once.
		+
		+	== See also ==
		+	* [[Dice]] namespace
		+	* [[Dice/AST\|Dice.AST]] namespace
		+	* [[Dice/Grammar\|Dice.Grammar]] namespace
		+	* [[Dice/PbP\|Dice.PbP]] namespace

← Older revision		Revision as of 07:24, 9 April 2017
Line 1:		Line 1:
−	After downloading the package via NuGet, you can use the following API in order to roll dice and view those dice results. All relevant classes are found the [[~~Dice/~~Dice\|Dice namespace]], which you can quickly access by adding {{cs\|using Dice;}} at the top of your files.	+	After downloading the package via NuGet, you can use the following API in order to roll dice and view those dice results. All relevant classes are found the [[Dice\|Dice namespace]], which you can quickly access by adding {{cs\|using Dice;}} at the top of your files.

	== Rolling dice ==		== Rolling dice ==

@@ Line 1: / Line 1: @@
-After downloading the package via NuGet, you can use the following API in order to roll dice and view those dice results. All relevant classes are found the [[API/Dice|Dice namespace]], which you can quickly access by adding {{cs|using Dice;}} at the top of your files.
+After downloading the package via NuGet, you can use the following API in order to roll dice and view those dice results. All relevant classes are found the [[Dice/Dice|Dice namespace]], which you can quickly access by adding {{cs|using Dice;}} at the top of your files.
 == Rolling dice ==
-To roll dice, use the [[API/Roller/Roll|Roller.Roll]] method. This method is static and is the main entry point to using the library.
+To roll dice, use the [[Dice/Roller/Roll|Roller.Roll]] method. This method is static and is the main entry point to using the library.
 == Getting results ==
-The Roller.Roll method returns a [[API/RollResult|RollResult]] object, which contains the final roll value as well as the dice rolled. Generally, this is enough information to view and display results, however more fine-grained information can be obtained by walking through the roll tree. For example, in the dice expression {{c|(1d8)d6}}, a 1d8 is rolled, and then that many d6s are rolled. However, the RollResult will only contain the values of the d6s, it won't contain the value of the d8. You could figure it out by looking at the number of d6s there are, but it is also possible to directly inspect the d8 by walking the dice abstract syntax tree.
+The Roller.Roll method returns a [[Dice/RollResult|RollResult]] object, which contains the final roll value as well as the dice rolled. Generally, this is enough information to view and display results, however more fine-grained information can be obtained by walking through the roll tree. For example, in the dice expression {{c|(1d8)d6}}, a 1d8 is rolled, and then that many d6s are rolled. However, the RollResult will only contain the values of the d6s, it won't contain the value of the d8. You could figure it out by looking at the number of d6s there are, but it is also possible to directly inspect the d8 by walking the dice abstract syntax tree.
 == Configuring the roller ==
-To configure roller settings, set the various properties on [[API/Roller/DefaultConfig|Roller.DefaultConfig]]. This lets you change the various dice limits as well as what is used to resolve macros.
+To configure roller settings, set the various properties on [[Dice/Roller/DefaultConfig|Roller.DefaultConfig]]. This lets you change the various dice limits as well as what is used to resolve macros.
 == Adding functions ==
-To add functions, make use of the [[API/FunctionRegistry/RegisterType|FunctionRegistry.RegisterType]] or [[API/FunctionRegistry/RegisterFunction|FunctionRegistry.RegisterFunction]] methods. The first method (RegisterType) makes it easy to register numerous functions all at once.
+To add functions, make use of the [[Dice/FunctionRegistry/RegisterType|FunctionRegistry.RegisterType]] or [[Dice/FunctionRegistry/RegisterFunction|FunctionRegistry.RegisterFunction]] methods. The first method (RegisterType) makes it easy to register numerous functions all at once.

← Older revision		Revision as of 04:24, 9 April 2017
Line 1:		Line 1:
−	After downloading the package via NuGet, you can use the following API in order to roll dice and view those dice results. All relevant classes are found the [[API/Dice\|Dice namespace]], which you can quickly access by adding {{cs\|using ~~namespace~~ Dice;}} at the top of your files.	+	After downloading the package via NuGet, you can use the following API in order to roll dice and view those dice results. All relevant classes are found the [[API/Dice\|Dice namespace]], which you can quickly access by adding {{cs\|using Dice;}} at the top of your files.

	== Rolling dice ==		== Rolling dice ==

← Older revision		Revision as of 16:43, 8 April 2017
Line 1:		Line 1:
−	After downloading the package via NuGet, you can use the following API in order to roll dice and view those dice results. All relevant classes are found the Dice namespace, which you can quickly access by adding {{cs\|using namespace Dice;}} at the top of your files.	+	After downloading the package via NuGet, you can use the following API in order to roll dice and view those dice results. All relevant classes are found the [[API/Dice\|Dice namespace]], which you can quickly access by adding {{cs\|using namespace Dice;}} at the top of your files.

	== Rolling dice ==		== Rolling dice ==