RPGDice

0.1.1

en-US/RPGDice-help.xml

<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh">
  <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
    <command:details>
      <command:name>New-Dice</command:name>
      <command:verb>New</command:verb>
      <command:noun>Dice</command:noun>
      <maml:description>
        <maml:para>Quickly create a new type of dice!</maml:para>
      </maml:description>
    </command:details>
    <maml:description>
      <maml:para>Easily generate new and custom dice. From pre-defined dice to completely custom dice.</maml:para>
    </maml:description>
    <command:syntax>
      <command:syntaxItem>
        <maml:name>New-Dice</maml:name>
        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
          <maml:name>List</maml:name>
          <maml:description>
            <maml:para>Easily create a custom die for your RPG games. The first item in the array is the minimum, and the last is the maximum.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue>
          <dev:type>
            <maml:name>String[]</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>None</dev:defaultValue>
        </command:parameter>
      </command:syntaxItem>
      <command:syntaxItem>
        <maml:name>New-Dice</maml:name>
        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
          <maml:name>Sides</maml:name>
          <maml:description>
            <maml:para>The number of sides you want your dice to have.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">Int16</command:parameterValue>
          <dev:type>
            <maml:name>Int16</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>None</dev:defaultValue>
        </command:parameter>
      </command:syntaxItem>
    </command:syntax>
    <command:parameters>
      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
        <maml:name>List</maml:name>
        <maml:description>
          <maml:para>Easily create a custom die for your RPG games. The first item in the array is the minimum, and the last is the maximum.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue>
        <dev:type>
          <maml:name>String[]</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>None</dev:defaultValue>
      </command:parameter>
      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
        <maml:name>Sides</maml:name>
        <maml:description>
          <maml:para>The number of sides you want your dice to have.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">Int16</command:parameterValue>
        <dev:type>
          <maml:name>Int16</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>None</dev:defaultValue>
      </command:parameter>
    </command:parameters>
    <command:inputTypes>
      <command:inputType>
        <dev:type>
          <maml:name>None</maml:name>
        </dev:type>
        <maml:description>
          <maml:para></maml:para>
        </maml:description>
      </command:inputType>
    </command:inputTypes>
    <command:returnValues>
      <command:returnValue>
        <dev:type>
          <maml:name>System.Object</maml:name>
        </dev:type>
        <maml:description>
          <maml:para></maml:para>
        </maml:description>
      </command:returnValue>
    </command:returnValues>
    <maml:alertSet>
      <maml:alert>
        <maml:para></maml:para>
      </maml:alert>
    </maml:alertSet>
    <command:examples>
      <command:example>
        <maml:title>-------------------------- Example 1 --------------------------</maml:title>
        <dev:code>PS C:\&gt; New-Dice</dev:code>
        <dev:remarks>
          <maml:para>Generates a standard D6 dice.</maml:para>
        </dev:remarks>
      </command:example>
      <command:example>
        <maml:title>-------------------------- Example 1 --------------------------</maml:title>
        <dev:code>PS C:\&gt; New-Dice -List @('Fail','Success')</dev:code>
        <dev:remarks>
          <maml:para>Generates a success and fail dice.</maml:para>
        </dev:remarks>
      </command:example>
      <command:example>
        <maml:title>-------------------------- Example 1 --------------------------</maml:title>
        <dev:code>PS C:\&gt; New-Dice -Sides 20</dev:code>
        <dev:remarks>
          <maml:para>Generates a standard D20 dice.</maml:para>
        </dev:remarks>
      </command:example>
    </command:examples>
    <command:relatedLinks />
  </command:command>
  <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
    <command:details>
      <command:name>New-DiceRoll</command:name>
      <command:verb>New</command:verb>
      <command:noun>DiceRoll</command:noun>
      <maml:description>
        <maml:para>Quickly get a dice roll out come!</maml:para>
      </maml:description>
    </command:details>
    <maml:description>
      <maml:para>Get the outcome of a dice roll. You can use a predifined dice or just tell it the dice type.</maml:para>
    </maml:description>
    <command:syntax>
      <command:syntaxItem>
        <maml:name>New-DiceRoll</maml:name>
        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
          <maml:name>Dice</maml:name>
          <maml:description>
            <maml:para>This is a dice object you created with `New-Dice`.</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">Dice</command:parameterValue>
          <dev:type>
            <maml:name>Dice</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>None</dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
          <maml:name>NoCrits</maml:name>
          <maml:description>
            <maml:para>An optional flag to mute the critical miss/hit message.</maml:para>
          </maml:description>
          <dev:type>
            <maml:name>SwitchParameter</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>False</dev:defaultValue>
        </command:parameter>
      </command:syntaxItem>
      <command:syntaxItem>
        <maml:name>New-DiceRoll</maml:name>
        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
          <maml:name>DiceType</maml:name>
          <maml:description>
            <maml:para>A quick way to roll a specific type of dice.</maml:para>
          </maml:description>
          <command:parameterValueGroup>
            <command:parameterValue required="false" command:variableLength="false">D2</command:parameterValue>
            <command:parameterValue required="false" command:variableLength="false">D4</command:parameterValue>
            <command:parameterValue required="false" command:variableLength="false">D6</command:parameterValue>
            <command:parameterValue required="false" command:variableLength="false">D8</command:parameterValue>
            <command:parameterValue required="false" command:variableLength="false">D10</command:parameterValue>
            <command:parameterValue required="false" command:variableLength="false">D12</command:parameterValue>
            <command:parameterValue required="false" command:variableLength="false">D20</command:parameterValue>
          </command:parameterValueGroup>
          <command:parameterValue required="true" variableLength="false">DiceType</command:parameterValue>
          <dev:type>
            <maml:name>DiceType</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>None</dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
          <maml:name>NoCrits</maml:name>
          <maml:description>
            <maml:para>An optional flag to mute the critical miss/hit message.</maml:para>
          </maml:description>
          <dev:type>
            <maml:name>SwitchParameter</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>False</dev:defaultValue>
        </command:parameter>
      </command:syntaxItem>
    </command:syntax>
    <command:parameters>
      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
        <maml:name>Dice</maml:name>
        <maml:description>
          <maml:para>This is a dice object you created with `New-Dice`.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">Dice</command:parameterValue>
        <dev:type>
          <maml:name>Dice</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>None</dev:defaultValue>
      </command:parameter>
      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
        <maml:name>DiceType</maml:name>
        <maml:description>
          <maml:para>A quick way to roll a specific type of dice.</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">DiceType</command:parameterValue>
        <dev:type>
          <maml:name>DiceType</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>None</dev:defaultValue>
      </command:parameter>
      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
        <maml:name>NoCrits</maml:name>
        <maml:description>
          <maml:para>An optional flag to mute the critical miss/hit message.</maml:para>
        </maml:description>
        <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
        <dev:type>
          <maml:name>SwitchParameter</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>False</dev:defaultValue>
      </command:parameter>
    </command:parameters>
    <command:inputTypes>
      <command:inputType>
        <dev:type>
          <maml:name>None</maml:name>
        </dev:type>
        <maml:description>
          <maml:para></maml:para>
        </maml:description>
      </command:inputType>
    </command:inputTypes>
    <command:returnValues>
      <command:returnValue>
        <dev:type>
          <maml:name>System.Object</maml:name>
        </dev:type>
        <maml:description>
          <maml:para></maml:para>
        </maml:description>
      </command:returnValue>
    </command:returnValues>
    <maml:alertSet>
      <maml:alert>
        <maml:para></maml:para>
      </maml:alert>
    </maml:alertSet>
    <command:examples>
      <command:example>
        <maml:title>-------------------------- Example 1 --------------------------</maml:title>
        <dev:code>PS C:\&gt; New-DiceRoll</dev:code>
        <dev:remarks>
          <maml:para>Assume you mean a D6 and gives you a return. Will tell you if it's a critical miss on a 1 or a critical hit on a 6.</maml:para>
        </dev:remarks>
      </command:example>
      <command:example>
        <maml:title>-------------------------- Example 2 --------------------------</maml:title>
        <dev:code>PS C:\&gt; New-DiceRoll -NoCrit</dev:code>
        <dev:remarks>
          <maml:para>Assume you mean a D6 and gives you a return. Will ignore critical hit/miss.</maml:para>
        </dev:remarks>
      </command:example>
      <command:example>
        <maml:title>-------------------------- Example 3 --------------------------</maml:title>
        <dev:code>PS C:\&gt; New-DiceRoll -DiceType D20</dev:code>
        <dev:remarks>
          <maml:para>Roll a D20.</maml:para>
        </dev:remarks>
      </command:example>
      <command:example>
        <maml:title>-------------------------- Example 4 --------------------------</maml:title>
        <dev:code>PS C:\&gt; New-DiceRoll -Dice $d</dev:code>
        <dev:remarks>
          <maml:para>Will roll the custom dice you created (`$d`) with `New-Dice`.</maml:para>
        </dev:remarks>
      </command:example>
    </command:examples>
    <command:relatedLinks />
  </command:command>
</helpItems>