en-US/MazeRats-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>Add-XP</command:name> <command:verb>Add</command:verb> <command:noun>XP</command:noun> <maml:description> <maml:para>Add experience points to a player.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Given a player and XP gained, it will add it to the existing points and if approriate level the player up.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-XP</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Player</maml:name> <maml:description> <maml:para>This is a MazeRat player you created with New-MazeRat</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">MazeRat</command:parameterValue> <dev:type> <maml:name>MazeRat</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>XP</maml:name> <maml:description> <maml:para>Experience points gained.</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>0</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Player</maml:name> <maml:description> <maml:para>This is a MazeRat player you created with New-MazeRat</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">MazeRat</command:parameterValue> <dev:type> <maml:name>MazeRat</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>XP</maml:name> <maml:description> <maml:para>Experience points gained.</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>0</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <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>Add-XP -Player $joe -XP 10 Choose an ability to bump! Leveled up! Level 4 Total XP: 18</dev:code> <dev:remarks> <maml:para>Give PC `$Joe` 10 additional XP.</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>Complete-AbilityBump</command:name> <command:verb>Complete</command:verb> <command:noun>AbilityBump</command:noun> <maml:description> <maml:para>Bump a players ability</maml:para> </maml:description> </command:details> <maml:description> <maml:para>If a player has gained enough skill in an ability, you can bump their total.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Complete-AbilityBump</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Player</maml:name> <maml:description> <maml:para>This should be a player object created by New-MazeRat</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">MazeRat</command:parameterValue> <dev:type> <maml:name>MazeRat</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Ability</maml:name> <maml:description> <maml:para>An ability to bump (Dexterity, Strength, or Will)</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Strength</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Dexterity</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Will</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">Abilities</command:parameterValue> <dev:type> <maml:name>Abilities</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="1" aliases="none"> <maml:name>Player</maml:name> <maml:description> <maml:para>This should be a player object created by New-MazeRat</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">MazeRat</command:parameterValue> <dev:type> <maml:name>MazeRat</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Ability</maml:name> <maml:description> <maml:para>An ability to bump (Dexterity, Strength, or Will)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Abilities</command:parameterValue> <dev:type> <maml:name>Abilities</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <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>Complete-AbilityBump -Player $P -Ability Strength</dev:code> <dev:remarks> <maml:para>Increasing player ($p) strength ability. If the player has more ability points you will be prompted.</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>Invoke-Spell</command:name> <command:verb>Invoke</command:verb> <command:noun>Spell</command:noun> <maml:description> <maml:para>Uses a player spell if they know it.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This allows you to use a MazeRat players Spells. It will return text saying that they used their spell.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-Spell</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Player</maml:name> <maml:description> <maml:para>This should be a player object created by New-MazeRat</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">MazeRat</command:parameterValue> <dev:type> <maml:name>MazeRat</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Spell</maml:name> <maml:description> <maml:para>This should be a spell that is listed in the Players spell array.</maml:para> <maml:para>You can check by checking $player.Spells</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Magic</command:parameterValue> <dev:type> <maml:name>Magic</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="1" aliases="none"> <maml:name>Player</maml:name> <maml:description> <maml:para>This should be a player object created by New-MazeRat</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">MazeRat</command:parameterValue> <dev:type> <maml:name>MazeRat</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Spell</maml:name> <maml:description> <maml:para>This should be a spell that is listed in the Players spell array.</maml:para> <maml:para>You can check by checking $player.Spells</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Magic</command:parameterValue> <dev:type> <maml:name>Magic</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <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>Invoke-Spell $p -Spell 'Shielding Blast' Hester Bettleman casts Shielding Blast!</dev:code> <dev:remarks> <maml:para>$p is Hester Bettleman and he used his Shielding Blast spell</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Invoke-Spell $p -Spell 'Shielding Blast' Hester Bettleman doesn't know that spell... They do know:</dev:code> <dev:remarks> <maml:para>Hester Bettleman ($p) tried using Shielding Blast spell but didn't know it.</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-MazeMonster</command:name> <command:verb>New</command:verb> <command:noun>MazeMonster</command:noun> <maml:description> <maml:para>Creates a new monster for your encounters.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Randomly generates a monsters.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-MazeMonster</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Health</maml:name> <maml:description> <maml:para>The type of health we want from this Monster.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Weak</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Typical</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Tough</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Hulking</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Colossal</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">Health</command:parameterValue> <dev:type> <maml:name>Health</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="10" aliases="none"> <maml:name>Ability</maml:name> <maml:description> <maml:para>Optional ability for your monster.</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="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Armor</maml:name> <maml:description> <maml:para>How heavily protected is your character?</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Unarmored</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">LightProtection</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ModerateProtection</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">HeavyProtection</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">NighImpervious</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">Armor</command:parameterValue> <dev:type> <maml:name>Armor</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>AttackBonus</maml:name> <maml:description> <maml:para>How skilled is this character?</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Untrained</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Trained</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Dangerous</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Masterful</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Lethal</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">AttackBonus</command:parameterValue> <dev:type> <maml:name>AttackBonus</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Strength</maml:name> <maml:description> <maml:para>Weak, Average, Strong, Powerful, Monstrous</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Weak</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Average</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Strong</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Powerful</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Monstrous</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">StrBonus</command:parameterValue> <dev:type> <maml:name>StrBonus</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>Dexterity</maml:name> <maml:description> <maml:para>How dexterous is this character?</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Slow</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Average</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Nimble</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Swift</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Blurred</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">DexBonus</command:parameterValue> <dev:type> <maml:name>DexBonus</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"> <maml:name>Will</maml:name> <maml:description> <maml:para>Dimwitted, Average, Clever, Brilliant, Genius</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Dimwitted</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Average</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Clever</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Brilliant</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Genius</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">WilBonus</command:parameterValue> <dev:type> <maml:name>WilBonus</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="7" aliases="none"> <maml:name>MonsterBase</maml:name> <maml:description> <maml:para>Is this monster Aerial, Terrestrial, or Aquatic?</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Aerial</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Terrestrial</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Aquatic</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">MonsterBase</command:parameterValue> <dev:type> <maml:name>MonsterBase</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>([Enum]::GetValues([MonsterBase]) | Get-Random)</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="8" aliases="none"> <maml:name>Feature</maml:name> <maml:description> <maml:para>What kind of feature does the monster have?</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="9" aliases="none"> <maml:name>Trait</maml:name> <maml:description> <maml:para>What kind of trait does this monster have?</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:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Health</maml:name> <maml:description> <maml:para>The type of health we want from this Monster.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Health</command:parameterValue> <dev:type> <maml:name>Health</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Armor</maml:name> <maml:description> <maml:para>How heavily protected is your character?</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Armor</command:parameterValue> <dev:type> <maml:name>Armor</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>AttackBonus</maml:name> <maml:description> <maml:para>How skilled is this character?</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AttackBonus</command:parameterValue> <dev:type> <maml:name>AttackBonus</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Strength</maml:name> <maml:description> <maml:para>Weak, Average, Strong, Powerful, Monstrous</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StrBonus</command:parameterValue> <dev:type> <maml:name>StrBonus</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>Dexterity</maml:name> <maml:description> <maml:para>How dexterous is this character?</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">DexBonus</command:parameterValue> <dev:type> <maml:name>DexBonus</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"> <maml:name>Will</maml:name> <maml:description> <maml:para>Dimwitted, Average, Clever, Brilliant, Genius</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">WilBonus</command:parameterValue> <dev:type> <maml:name>WilBonus</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="7" aliases="none"> <maml:name>MonsterBase</maml:name> <maml:description> <maml:para>Is this monster Aerial, Terrestrial, or Aquatic?</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">MonsterBase</command:parameterValue> <dev:type> <maml:name>MonsterBase</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>([Enum]::GetValues([MonsterBase]) | Get-Random)</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="8" aliases="none"> <maml:name>Feature</maml:name> <maml:description> <maml:para>What kind of feature does the monster have?</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="9" aliases="none"> <maml:name>Trait</maml:name> <maml:description> <maml:para>What kind of trait does this monster have?</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="10" aliases="none"> <maml:name>Ability</maml:name> <maml:description> <maml:para>Optional ability for your monster.</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:parameters> <command:inputTypes /> <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>New-MazeMonster Returns a MazeMonster</dev:code> <dev:remarks> <maml:para></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-MazeRat</command:name> <command:verb>New</command:verb> <command:noun>MazeRat</command:noun> <maml:description> <maml:para>Creates a new character.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Generate a new character quickly with minimal options.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-MazeRat</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Their name. You can generate one via `New-RatName` if you'd like.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Gender</maml:name> <maml:description> <maml:para>Using the default tables, this currently accepts Male or Female but in future versions this will expand.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Male</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Female</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">Gender</command:parameterValue> <dev:type> <maml:name>Gender</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>([Enum]::GetValues([Gender]) | Get-Random)</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Class</maml:name> <maml:description> <maml:para>The social class this character belongs to.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">UpperClass</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">LowerClass</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">SocialClass</command:parameterValue> <dev:type> <maml:name>SocialClass</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>([Enum]::GetValues([SocialClass]) | Get-Random)</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>Their name. You can generate one via `New-RatName` if you'd like.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Gender</maml:name> <maml:description> <maml:para>Using the default tables, this currently accepts Male or Female but in future versions this will expand.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Gender</command:parameterValue> <dev:type> <maml:name>Gender</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>([Enum]::GetValues([Gender]) | Get-Random)</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Class</maml:name> <maml:description> <maml:para>The social class this character belongs to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SocialClass</command:parameterValue> <dev:type> <maml:name>SocialClass</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>([Enum]::GetValues([SocialClass]) | Get-Random)</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <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>New-MazeRat Name : Hester Bettleman Level : 1 XP : 0 Strength : 1 Dexterity : 2 Will : 0 Attack : 0 Armor : 0 Health : 4 MaxHealth : 4 SpellSlots : 0 Appearance : Boney PhysicalDetail : Bronze skinned Background : Galley slave Clothing : Undersized Personality : Stubborn Mannerism : Monotone Spells : {Shielding Blast}</dev:code> <dev:remarks> <maml:para>Generating a Random character with no parameters.</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-RatName</command:name> <command:verb>New</command:verb> <command:noun>RatName</command:noun> <maml:description> <maml:para>Create a new character name.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Creates a new name based on the original table in MazeRats.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-RatName</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Gender</maml:name> <maml:description> <maml:para>Gender</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Male</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Female</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">Gender</command:parameterValue> <dev:type> <maml:name>Gender</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Class</maml:name> <maml:description> <maml:para>Social Rank</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">UpperClass</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">LowerClass</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">SocialClass</command:parameterValue> <dev:type> <maml:name>SocialClass</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="1" aliases="none"> <maml:name>Gender</maml:name> <maml:description> <maml:para>Gender</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Gender</command:parameterValue> <dev:type> <maml:name>Gender</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Class</maml:name> <maml:description> <maml:para>Social Rank</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">SocialClass</command:parameterValue> <dev:type> <maml:name>SocialClass</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <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>New-RatName Trillby Crumpling</dev:code> <dev:remarks> <maml:para>Creates a random name to be used by PC or NPC.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Specify a URI to a help page, this will show when Get-Help -Online is used.</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </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-Spell</command:name> <command:verb>New</command:verb> <command:noun>Spell</command:noun> <maml:description> <maml:para>Create a new spell for your PC or NPC to use/discover.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Creates a spell.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-Spell</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Mutation</maml:name> <maml:description> <maml:para>Should the spell has a mutation.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Omen</maml:name> <maml:description> <maml:para>Should the spell result in an Omen.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</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="1" aliases="none"> <maml:name>Mutation</maml:name> <maml:description> <maml:para>Should the spell has a mutation.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>Omen</maml:name> <maml:description> <maml:para>Should the spell result in an Omen.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <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>$spell = New-Spell PS C:\> $spell</dev:code> <dev:remarks> <maml:para>PhysicalEffect : PhysicalElement : PhysicalForm : Trap EtherealEffect : EtherealElement : Warp EtherealForm : Mutation : Insanity : Omen :</maml:para> <maml:para>PS C:\> $spell.ToString() Warp Trap</maml:para> <maml:para>Create a new spell and save it to a variable.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> </helpItems> |