Dice/DieResult - Revision history

Skizzerz: /* Methods */

2017-05-15T16:47:53Z

Methods

2017-04-25T18:02:50Z

Constructors

2017-04-19T22:32:30Z

Properties

2017-04-18T22:50:57Z

2017-04-18T19:46:41Z

2017-04-18T19:38:37Z

2017-04-17T19:17:07Z

2017-04-15T06:57:08Z

2017-04-15T06:55:51Z

Remarks

2017-04-15T06:54:04Z

Properties

@@ Line 28: / Line 28: @@
 ! style="width: 5em" |
 ! Name !! Description
 |-
 | {{public}} {{method}} || [[/Drop|Drop()]] || Return a new DieResult based on the current one flagged as dropped.
@@ Line 44: / Line 46: @@
 |-
 | {{public}} {{method}} || [[/IsSpecialDie|IsSpecialDie(SpecialDie)]] || Checks if this die is a special die of the specified type.
 |-
 | {{public}} {{method}} || [[/Success|Success()]] || Return a new DieResult based on the current one flagged as a success.

@@ Line 14: / Line 14: @@
 ! style="width: 5em" |
 ! Name !! Description
 |-
 | {{public}} {{method}} || [[/DieResult (SpecialDie)|DieResult(SpecialDie)]] || Constructs a new DieResult corresponding to the given SpecialDie.
@@ Line 21: / Line 23: @@
 | {{private}} {{method}} || [[/DieResult (SerializationInfo, StreamingContext)|DieResult(SerializationInfo, StreamingContext)]] || Constructs a new DieResult with serialized data.
 |}
 == Methods ==

@@ Line 53: / Line 53: @@
 ! Name !! Description
 |-
-| {{public}} {{property}} || [[/DieType|Data]] || Gets or sets string data associated with a roll.
+| {{public}} {{property}} || [[/Data|Data]] || Gets or sets string data associated with a roll.
 |-
 | {{public}} {{property}} || [[/DieType|DieType]] || Gets or sets what type of die was rolled.

@@ Line 7: / Line 7: @@
 <syntaxhighlight lang="C#">
 [Serializable]
-public struct DieResult : ISerializable
+public struct DieResult : ISerializable, IEquatable<DieResult>
 </syntaxhighlight>
@@ Line 31: / Line 31: @@
 | {{public}} {{method}} || [[/Drop|Drop()]] || Return a new DieResult based on the current one flagged as dropped.
 |-
-| {{public}} {{method}} || [[/Equals|Equals(object)]] || Compare two DieResults and return whether or not they are equal. Overridden from Object.Equals(object).
+| {{public}} {{method}} || [[/Equals (DieResult)|Equals(DieResult)]] || Compare two DieResults and return whether or not they are equal.
 |-
 | {{public}} {{method}} || [[/Failure|Failure()]] || Return a new DieResult based on the current one flagged as a failure.

@@ Line 36: / Line 36: @@
 |-
 | {{public}} {{method}} || [[/GetHashCode|GetHashCode()]] || Gets a hash code for the DieResult. Overridden from Object.GetHashCode().
 |-
 | {{public}} {{method}} || [[/IsLiveDie|IsLiveDie()]] || Checks if the die is not a special die and has not been dropped.
@@ Line 42: / Line 44: @@
 |-
 | {{public}} {{method}} || [[/Success|Success()]] || Return a new DieResult based on the current one flagged as a success.
 |}

← Older revision		Revision as of 06:55, 15 April 2017
Line 58:		Line 58:

	== Remarks ==		== Remarks ==
−	The NumSides property is only non-zero if DieType is {{cs\|DieType.Normal}} or {{cs\|DieType.Fudge}}. If DieType is {{cs\|DieType.Special}}, then Value can be cast into a [[Dice/SpecialDie\|SpecialDie enum]] value.	+	The NumSides property is only non-zero if DieType is {{cs\|DieType.Normal}} or {{cs\|DieType.Fudge}}. If DieType is {{cs\|DieType.Special}}, then Value can be cast into a [[Dice/SpecialDie\|SpecialDie enum]] value, however it is usually better to access the SpecialDie property instead as typecasts are unnecessary with that property.
		+
		+	The property setters are provided for dice construction purposes. Since DieResult is a value type, attempting to call a setter on a DieResult instance will result in a new instance being constructed rather than the existing instance being mutated (unless the instance is a {{cs\|ref}} or {{cs\|out}} parameter).

@@ Line 34: / Line 34: @@
 ! Name !! Description
 |-
-| {{public}} {{property}} || [[/DieType|DieType]] || What type of die was rolled.
+| {{public}} {{property}} || [[/DieType|DieType]] || Gets or sets what type of die was rolled.
 |-
-| {{public}} {{property}} || [[/Flags|Flags]] || Any special flags giving more information about the roll.
+| {{public}} {{property}} || [[/Flags|Flags]] || Gets or sets any special flags giving more information about the roll.
 |-
-| {{public}} {{property}} || [[/NumSides|NumSides]] || How many sides the die had.
+| {{public}} {{property}} || [[/NumSides|NumSides]] || Gets or sets how many sides the die had.
 |-
-| {{public}} {{property}} || [[/Value|Value]] || What the result of the roll was.
+| {{public}} {{property}} || [[/SpecialDie|SpecialDie]] || Gets or sets what type of special die this is. Calling this is an error if DieType != DieType.SpecialDie.
 |}