en-US/PSClearHost-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>Clear-HostRaindrop</command:name> <command:verb>Clear</command:verb> <command:noun>HostRaindrop</command:noun> <maml:description> <maml:para>Clears the host and displays a raindrop animation.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Clears the host and displays a raindrop animation.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Clear-HostRaindrop</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>Mode</maml:name> <maml:description> <maml:para>Type of Animation to use; If not set, the animation type will be randomly selected. Possible Modes are `Falling`, `Flipping`, or `Bricks`.</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>($players.Keys | Get-Random)</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none"> <maml:name>Speed</maml:name> <maml:description> <maml:para>The playback speed of the raindrop animation.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DebugSkipRender</maml:name> <maml:description> <maml:para>Skips rendering the animation to the host.</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="True (ByPropertyName)" position="1" aliases="none"> <maml:name>Mode</maml:name> <maml:description> <maml:para>Type of Animation to use; If not set, the animation type will be randomly selected. Possible Modes are `Falling`, `Flipping`, or `Bricks`.</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>($players.Keys | Get-Random)</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none"> <maml:name>Speed</maml:name> <maml:description> <maml:para>The playback speed of the raindrop animation.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Double</command:parameterValue> <dev:type> <maml:name>Double</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DebugSkipRender</maml:name> <maml:description> <maml:para>Skips rendering the animation to the host.</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>None</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>Clear-HostRaindrop -Mode 'Flipping' -Speed 0.5</dev:code> <dev:remarks> <maml:para>Clears the host and displays a Flipping raindrop animation with a playback speed of 0.5x.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Clear-HostRaindrop</dev:code> <dev:remarks> <maml:para>Clears the host and displays a raindrop animation.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>Clear-HostRaindrop -Speed 1.5 -Framerate 60</dev:code> <dev:remarks> <maml:para>Clears the host and displays a raindrop animation with a speed of 1.5 and a framerate of 60.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <dev:code>Clear-HostRaindrop -DebugSkipRender</dev:code> <dev:remarks> <maml:para>Clears the host and displays a raindrop animation, but skips rendering the animation to the host.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>https://github.com/jimbrig/PSClearHost</maml:linkText> <maml:uri>https://github.com/jimbrig/PSClearHost</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |