EN-US/Modrify.Fallout4.dll-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>Copy-FalloutRecordAsDeepCopy</command:name> <command:verb>Copy</command:verb> <command:noun>FalloutRecordAsDeepCopy</command:noun> <maml:description> <maml:para>Copy a record as a new record into a mod file, preserving the FormKey.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Copies the selected record into a mod as a new record, preserving the FormKey. Requires a mod object to have been created with Get-FalloutMod, New-FalloutMod, or pull from the load order Get-ModLoadOrder/Get-ModPriorityOrder.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Copy-FalloutRecordAsDeepCopy</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Record</maml:name> <maml:description> <maml:para>The record to be copied.</maml:para> <maml:para>This can be created by going into a mod group or by using Get-FalloutMajorRecords.</maml:para> <maml:para>For example, to get NPCs from a mod, use:</maml:para> <maml:para></maml:para> <maml:para>(Get-FalloutMod 'Fallout4.esm').Npc</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IFallout4MajorRecordGetter</command:parameterValue> <dev:type> <maml:name>IFallout4MajorRecordGetter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="DestinationMod, TargetMod"> <maml:name>Mod</maml:name> <maml:description> <maml:para>The mod object. Created with Get-FalloutMod, New-FalloutMod, or pulled from the load order Get-ModLoadOrder/Get-ModPriorityOrder.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IFallout4Mod</command:parameterValue> <dev:type> <maml:name>IFallout4Mod</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="named" aliases="DestinationMod, TargetMod"> <maml:name>Mod</maml:name> <maml:description> <maml:para>The mod object. Created with Get-FalloutMod, New-FalloutMod, or pulled from the load order Get-ModLoadOrder/Get-ModPriorityOrder.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IFallout4Mod</command:parameterValue> <dev:type> <maml:name>IFallout4Mod</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Record</maml:name> <maml:description> <maml:para>The record to be copied.</maml:para> <maml:para>This can be created by going into a mod group or by using Get-FalloutMajorRecords.</maml:para> <maml:para>For example, to get NPCs from a mod, use:</maml:para> <maml:para></maml:para> <maml:para>(Get-FalloutMod 'Fallout4.esm').Npc</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IFallout4MajorRecordGetter</command:parameterValue> <dev:type> <maml:name>IFallout4MajorRecordGetter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Mutagen.Bethesda.Fallout4.IFallout4MajorRecordGetter</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Mutagen.Bethesda.Fallout4.Fallout4MajorRecord</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>$mod = New-FalloutMod -ModKey 'TestMod.esp' Get-FalloutMajorRecord -Mod 'Fallout4.esm' -RecordType Npc | Copy-FalloutRecordAsDeepCopy -Mod $mod</dev:code> <dev:remarks> <maml:para>This will copy all Npcs from the Fallout 4 master file into TestMod as new records, preserving the FormKey.</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>Copy-FalloutRecordAsNewRecord</command:name> <command:verb>Copy</command:verb> <command:noun>FalloutRecordAsNewRecord</command:noun> <maml:description> <maml:para>Copy a record as a new record into a mod file.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Copies the selected record into a mod as a new record. Requires a mod object to have been created with Get-FalloutMod, New-FalloutMod, or pull from the load order Get-ModLoadOrder/Get-ModPriorityOrder.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Copy-FalloutRecordAsNewRecord</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Record</maml:name> <maml:description> <maml:para>The record to be copied.</maml:para> <maml:para>This can be created by going into a mod group or by using Get-FalloutMajorRecords.</maml:para> <maml:para>For example, to get NPCs from a mod, use:</maml:para> <maml:para></maml:para> <maml:para>(Get-FalloutMod 'Fallout4.esm').Npc</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IFallout4MajorRecordGetter</command:parameterValue> <dev:type> <maml:name>IFallout4MajorRecordGetter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="DestinationMod, TargetMod"> <maml:name>Mod</maml:name> <maml:description> <maml:para>The mod object. Created with Get-FalloutMod, New-FalloutMod, or pulled from the load order Get-ModLoadOrder/Get-ModPriorityOrder.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IFallout4Mod</command:parameterValue> <dev:type> <maml:name>IFallout4Mod</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="named" aliases="DestinationMod, TargetMod"> <maml:name>Mod</maml:name> <maml:description> <maml:para>The mod object. Created with Get-FalloutMod, New-FalloutMod, or pulled from the load order Get-ModLoadOrder/Get-ModPriorityOrder.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IFallout4Mod</command:parameterValue> <dev:type> <maml:name>IFallout4Mod</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Record</maml:name> <maml:description> <maml:para>The record to be copied.</maml:para> <maml:para>This can be created by going into a mod group or by using Get-FalloutMajorRecords.</maml:para> <maml:para>For example, to get NPCs from a mod, use:</maml:para> <maml:para></maml:para> <maml:para>(Get-FalloutMod 'Fallout4.esm').Npc</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IFallout4MajorRecordGetter</command:parameterValue> <dev:type> <maml:name>IFallout4MajorRecordGetter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Mutagen.Bethesda.Fallout4.IFallout4MajorRecordGetter</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Mutagen.Bethesda.Fallout4.Fallout4MajorRecord</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>$mod = New-FalloutMod -ModKey 'TestMod.esp' Get-FalloutMajorRecord -Mod 'Fallout4.esm' -RecordType Npc | Copy-FalloutRecordAsNewRecord -Mod $mod</dev:code> <dev:remarks> <maml:para>This will copy all Npcs from the Fallout 4 master file into TestMod as new records. This is actually quite fast.</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>Copy-FalloutRecordAsOverride</command:name> <command:verb>Copy</command:verb> <command:noun>FalloutRecordAsOverride</command:noun> <maml:description> <maml:para>Copy a record as an override into a mod file.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Copies the selected record into a mod as an override. Requires a mod object to have been created with GetFalloutMod, NewFalloutMod, or pull from the load order Get-ModLoadOrder/Get-ModPriorityOrder.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Copy-FalloutRecordAsOverride</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Record</maml:name> <maml:description> <maml:para>The record to be copied.</maml:para> <maml:para>This can be created by going into a mod group or by using Get-FalloutMajorRecords.</maml:para> <maml:para>For example, to get NPCs from a mod, use:</maml:para> <maml:para></maml:para> <maml:para>(Get-FalloutMod 'Fallout4.esm').Npc</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IFallout4MajorRecordGetter</command:parameterValue> <dev:type> <maml:name>IFallout4MajorRecordGetter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="DestinationMod, TargetMod"> <maml:name>Mod</maml:name> <maml:description> <maml:para>The mod object. Created with GetFalloutMod, NewFalloutMod, or pulled from the load order Get-ModLoadOrder/Get-ModPriorityOrder.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IFallout4Mod</command:parameterValue> <dev:type> <maml:name>IFallout4Mod</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="named" aliases="DestinationMod, TargetMod"> <maml:name>Mod</maml:name> <maml:description> <maml:para>The mod object. Created with GetFalloutMod, NewFalloutMod, or pulled from the load order Get-ModLoadOrder/Get-ModPriorityOrder.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IFallout4Mod</command:parameterValue> <dev:type> <maml:name>IFallout4Mod</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Record</maml:name> <maml:description> <maml:para>The record to be copied.</maml:para> <maml:para>This can be created by going into a mod group or by using Get-FalloutMajorRecords.</maml:para> <maml:para>For example, to get NPCs from a mod, use:</maml:para> <maml:para></maml:para> <maml:para>(Get-FalloutMod 'Fallout4.esm').Npc</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IFallout4MajorRecordGetter</command:parameterValue> <dev:type> <maml:name>IFallout4MajorRecordGetter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Mutagen.Bethesda.Fallout4.IFallout4MajorRecordGetter</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Mutagen.Bethesda.Fallout4.Fallout4MajorRecord</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>$mod = NewFalloutMod -ModKey 'TestMod.esp' GetFalloutMajorRecord -Mod 'Fallout4.esm' -RecordType Npc | CopyFalloutRecordAsOverride -Mod $mod</dev:code> <dev:remarks> <maml:para>This will copy all Npcs from the Fallout 4 master file into TestMod as an override. This is actually quite fast.</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>Get-FalloutMajorRecords</command:name> <command:verb>Get</command:verb> <command:noun>FalloutMajorRecords</command:noun> <maml:description> <maml:para>Returns major records from a Fallout 4 mod.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns major records from the specific Fallout 4 mod. Either all records or the specified type of records.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-FalloutMajorRecords</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Mod</maml:name> <maml:description> <maml:para>A Fallout4Mod object either created with New-FalloutMod, Get-FalloutMod, or pull from the load order with Get-ModLoadOrder/Get-ModPriorityOrder</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IFallout4ModGetter</command:parameterValue> <dev:type> <maml:name>IFallout4ModGetter</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>RecordType</maml:name> <maml:description> <maml:para>The type of record to be returned. Use tab-completion to see the full list.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">ActionRecord</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Activator</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ActorValueInformation</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ADamageType</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AddonNode</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Ammunition</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">APlacedTrap</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Armor</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ArmorAddon</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ArtObject</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AStoryManagerNode</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Book</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">CameraPath</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">CameraShot</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Cell</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Climate</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">CollisionLayer</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ColorRecord</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">CombatStyle</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Container</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">DialogBranch</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">DialogResponses</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">DialogTopic</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Door</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">EffectShader</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">EncounterZone</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">EquipType</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Explosion</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Faction</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Furniture</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">GameSetting</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Global</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Grass</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Hazard</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">HeadPart</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Holotape</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">IdleAnimation</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">IdleMarker</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ImageSpace</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ImageSpaceAdapter</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Impact</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Ingestible</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Ingredient</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">InstanceNamingRules</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Key</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Keyword</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">LeveledItem</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">LeveledNpc</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Light</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">LoadScreen</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Location</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">MagicEffect</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">MaterialObject</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">MaterialSwap</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">MaterialType</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Message</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">MiscItem</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">MovableStatic</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">MusicTrack</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">MusicType</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">NavigationMesh</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Npc</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ObjectEffect</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AObjectModification</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Package</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">PackIn</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Perk</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">PlacedNpc</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">PlacedObject</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Projectile</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Quest</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Race</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Region</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Relationship</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Scene</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ShaderParticleGeometry</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">SoundCategory</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">SoundDescriptor</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">SoundOutputModel</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Static</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">StaticCollection</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">TalkingActivator</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Terminal</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">TextureSet</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Transform</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Tree</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">VisualEffect</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">VoiceType</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Water</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Weapon</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Weather</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Worldspace</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Zoom</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AttractionRule</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Component</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">LocationReferenceType</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AnimationSoundTagSet</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Class</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Debris</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">FormList</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ImpactDataSet</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">LeveledSpell</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Outfit</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">SoundMarker</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AcousticSpace</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ReverbParameters</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">LandscapeTexture</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Spell</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Footstep</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">FootstepSet</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">GodRays</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">LensFlare</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Flora</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">BodyPartData</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">MovementType</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">DualCastData</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ConstructibleObject</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AimModel</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">BendableSpline</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">NavigationMeshInfoMap</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">LightingTemplate</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Layer</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ReferenceGroup</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Landscape</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AnimatedObject</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">DefaultObjectManager</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">DefaultObject</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">DialogView</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AssociationType</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AudioEffectChain</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">SoundKeywordMapping</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">SceneCollection</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AudioCategorySnapshot</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">NavigationMeshObstacleManager</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ObjectVisibilityManager</command:parameterValue> </command:parameterValueGroup> <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>Get-FalloutMajorRecords</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>ModKey</maml:name> <maml:description> <maml:para>The name of a mod to pull. The cmdlet will look for the mod in the data folder.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ModKey</command:parameterValue> <dev:type> <maml:name>ModKey</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>RecordType</maml:name> <maml:description> <maml:para>The type of record to be returned. Use tab-completion to see the full list.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">ActionRecord</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Activator</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ActorValueInformation</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ADamageType</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AddonNode</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Ammunition</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">APlacedTrap</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Armor</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ArmorAddon</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ArtObject</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AStoryManagerNode</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Book</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">CameraPath</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">CameraShot</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Cell</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Climate</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">CollisionLayer</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ColorRecord</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">CombatStyle</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Container</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">DialogBranch</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">DialogResponses</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">DialogTopic</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Door</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">EffectShader</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">EncounterZone</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">EquipType</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Explosion</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Faction</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Furniture</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">GameSetting</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Global</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Grass</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Hazard</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">HeadPart</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Holotape</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">IdleAnimation</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">IdleMarker</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ImageSpace</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ImageSpaceAdapter</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Impact</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Ingestible</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Ingredient</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">InstanceNamingRules</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Key</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Keyword</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">LeveledItem</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">LeveledNpc</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Light</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">LoadScreen</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Location</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">MagicEffect</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">MaterialObject</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">MaterialSwap</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">MaterialType</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Message</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">MiscItem</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">MovableStatic</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">MusicTrack</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">MusicType</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">NavigationMesh</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Npc</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ObjectEffect</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AObjectModification</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Package</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">PackIn</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Perk</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">PlacedNpc</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">PlacedObject</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Projectile</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Quest</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Race</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Region</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Relationship</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Scene</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ShaderParticleGeometry</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">SoundCategory</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">SoundDescriptor</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">SoundOutputModel</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Static</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">StaticCollection</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">TalkingActivator</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Terminal</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">TextureSet</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Transform</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Tree</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">VisualEffect</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">VoiceType</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Water</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Weapon</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Weather</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Worldspace</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Zoom</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AttractionRule</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Component</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">LocationReferenceType</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AnimationSoundTagSet</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Class</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Debris</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">FormList</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ImpactDataSet</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">LeveledSpell</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Outfit</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">SoundMarker</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AcousticSpace</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ReverbParameters</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">LandscapeTexture</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Spell</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Footstep</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">FootstepSet</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">GodRays</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">LensFlare</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Flora</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">BodyPartData</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">MovementType</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">DualCastData</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ConstructibleObject</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AimModel</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">BendableSpline</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">NavigationMeshInfoMap</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">LightingTemplate</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Layer</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ReferenceGroup</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Landscape</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AnimatedObject</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">DefaultObjectManager</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">DefaultObject</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">DialogView</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AssociationType</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AudioEffectChain</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">SoundKeywordMapping</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">SceneCollection</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AudioCategorySnapshot</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">NavigationMeshObstacleManager</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ObjectVisibilityManager</command:parameterValue> </command:parameterValueGroup> <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="True (ByValue)" position="0" aliases="none"> <maml:name>Mod</maml:name> <maml:description> <maml:para>A Fallout4Mod object either created with New-FalloutMod, Get-FalloutMod, or pull from the load order with Get-ModLoadOrder/Get-ModPriorityOrder</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IFallout4ModGetter</command:parameterValue> <dev:type> <maml:name>IFallout4ModGetter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>ModKey</maml:name> <maml:description> <maml:para>The name of a mod to pull. The cmdlet will look for the mod in the data folder.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ModKey</command:parameterValue> <dev:type> <maml:name>ModKey</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>RecordType</maml:name> <maml:description> <maml:para>The type of record to be returned. Use tab-completion to see the full list.</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:inputType> <dev:type> <maml:name>Mutagen.Bethesda.Fallout4.IFallout4ModGetter</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.Collections.Generic.IEnumerable`1[[Mutagen.Bethesda.Plugins.Records.IMajorRecordGetter, Mutagen.Bethesda.Core, Version=0.42.0.0, Culture=neutral, PublicKeyToken=null]]</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>Get-FalloutMajorRecords -ModKey 'Fallout4.esm' -RecordType Npc</dev:code> <dev:remarks> <maml:para>Gets all NPCs from the Fallout 4 master file.</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>Get-Fallout4Mod</command:name> <command:verb>Get</command:verb> <command:noun>Fallout4Mod</command:noun> <maml:description> <maml:para>Returns a Fallout 4 Mod object, optionally readonly.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns a Fallout 4 Mod object either by path or mod name and optionally read only, which is more performant.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-Fallout4Mod</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FileSystem</maml:name> <maml:description> <maml:para>{{ Fill FileSystem Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IFileSystem</command:parameterValue> <dev:type> <maml:name>IFileSystem</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>ImportMask</maml:name> <maml:description> <maml:para>{{ Fill ImportMask Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">GroupMask</command:parameterValue> <dev:type> <maml:name>GroupMask</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ModKey</maml:name> <maml:description> <maml:para>This is the file name of the mod. For example: "Unofficial Fallout 4 Patch.esp"</maml:para> <maml:para>If this parameter is used, the mod will be searched for in the data folder.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ModKey</command:parameterValue> <dev:type> <maml:name>ModKey</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>Parallel</maml:name> <maml:description> <maml:para>{{ Fill Parallel Description }}</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>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>StringsParam</maml:name> <maml:description> <maml:para>{{ Fill StringsParam Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringsReadParameters</command:parameterValue> <dev:type> <maml:name>StringsReadParameters</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-Fallout4Mod</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FileSystem</maml:name> <maml:description> <maml:para>{{ Fill FileSystem Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IFileSystem</command:parameterValue> <dev:type> <maml:name>IFileSystem</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>ImportMask</maml:name> <maml:description> <maml:para>{{ Fill ImportMask Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">GroupMask</command:parameterValue> <dev:type> <maml:name>GroupMask</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ModKey</maml:name> <maml:description> <maml:para>This is the file name of the mod. For example: "Unofficial Fallout 4 Patch.esp"</maml:para> <maml:para>If this parameter is used, the mod will be searched for in the data folder.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ModKey</command:parameterValue> <dev:type> <maml:name>ModKey</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>Parallel</maml:name> <maml:description> <maml:para>{{ Fill Parallel Description }}</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ReadOnly</maml:name> <maml:description> <maml:para>Optionally return the mod as readonly, which is much more performant. Useful for reporting purposes.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>StringsParam</maml:name> <maml:description> <maml:para>{{ Fill StringsParam Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringsReadParameters</command:parameterValue> <dev:type> <maml:name>StringsReadParameters</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-Fallout4Mod</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FileSystem</maml:name> <maml:description> <maml:para>{{ Fill FileSystem Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IFileSystem</command:parameterValue> <dev:type> <maml:name>IFileSystem</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>ImportMask</maml:name> <maml:description> <maml:para>{{ Fill ImportMask Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">GroupMask</command:parameterValue> <dev:type> <maml:name>GroupMask</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>Parallel</maml:name> <maml:description> <maml:para>{{ Fill Parallel Description }}</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>The fully qualified path to the mod file.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ModPath</command:parameterValue> <dev:type> <maml:name>ModPath</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ReadOnly</maml:name> <maml:description> <maml:para>Optionally return the mod as readonly, which is much more performant. Useful for reporting purposes.</maml:para> </maml:description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>StringsParam</maml:name> <maml:description> <maml:para>{{ Fill StringsParam Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringsReadParameters</command:parameterValue> <dev:type> <maml:name>StringsReadParameters</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-Fallout4Mod</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>FileSystem</maml:name> <maml:description> <maml:para>{{ Fill FileSystem Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IFileSystem</command:parameterValue> <dev:type> <maml:name>IFileSystem</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>ImportMask</maml:name> <maml:description> <maml:para>{{ Fill ImportMask Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">GroupMask</command:parameterValue> <dev:type> <maml:name>GroupMask</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>Parallel</maml:name> <maml:description> <maml:para>{{ Fill Parallel Description }}</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>The fully qualified path to the mod file.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ModPath</command:parameterValue> <dev:type> <maml:name>ModPath</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>StringsParam</maml:name> <maml:description> <maml:para>{{ Fill StringsParam Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringsReadParameters</command:parameterValue> <dev:type> <maml:name>StringsReadParameters</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>FileSystem</maml:name> <maml:description> <maml:para>{{ Fill FileSystem Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IFileSystem</command:parameterValue> <dev:type> <maml:name>IFileSystem</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>ImportMask</maml:name> <maml:description> <maml:para>{{ Fill ImportMask Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">GroupMask</command:parameterValue> <dev:type> <maml:name>GroupMask</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ModKey</maml:name> <maml:description> <maml:para>This is the file name of the mod. For example: "Unofficial Fallout 4 Patch.esp"</maml:para> <maml:para>If this parameter is used, the mod will be searched for in the data folder.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ModKey</command:parameterValue> <dev:type> <maml:name>ModKey</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>Parallel</maml:name> <maml:description> <maml:para>{{ Fill Parallel Description }}</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>The fully qualified path to the mod file.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ModPath</command:parameterValue> <dev:type> <maml:name>ModPath</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ReadOnly</maml:name> <maml:description> <maml:para>Optionally return the mod as readonly, which is much more performant. Useful for reporting purposes.</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:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>StringsParam</maml:name> <maml:description> <maml:para>{{ Fill StringsParam Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">StringsReadParameters</command:parameterValue> <dev:type> <maml:name>StringsReadParameters</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>Mutagen.Bethesda.Fallout4.IFallout4ModDisposableGetter</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>Mutagen.Bethesda.Fallout4.IFallout4Mod</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>Get-FalloutMod -ModKey HearthFires.esm -ReadOnly</dev:code> <dev:remarks> <maml:para>Returns a Fallout 4 Mod object that will contain all of the data in HearthFires.esm, specifically read only.</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>Get-FalloutWinningContextOverrides</command:name> <command:verb>Get</command:verb> <command:noun>FalloutWinningContextOverrides</command:noun> <maml:description> <maml:para>Returns the winning overrides with additional context.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns an array of winning overrides contexts for the specified type for your entire load order. This is actually quite fast.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-FalloutWinningContextOverrides</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeDeletedRecords</maml:name> <maml:description> <maml:para>If true, includes deleted records.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RecordType</maml:name> <maml:description> <maml:para>The type of record to search for. Use tab completion to see the full list.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">ActionRecord</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Activator</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ActorValueInformation</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ADamageType</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AddonNode</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Ammunition</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">APlacedTrap</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Armor</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ArmorAddon</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ArtObject</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AStoryManagerNode</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Book</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">CameraPath</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">CameraShot</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Cell</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Climate</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">CollisionLayer</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ColorRecord</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">CombatStyle</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Container</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">DialogBranch</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">DialogResponses</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">DialogTopic</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Door</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">EffectShader</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">EncounterZone</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">EquipType</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Explosion</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Faction</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Furniture</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">GameSetting</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Global</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Grass</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Hazard</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">HeadPart</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Holotape</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">IdleAnimation</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">IdleMarker</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ImageSpace</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ImageSpaceAdapter</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Impact</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Ingestible</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Ingredient</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">InstanceNamingRules</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Key</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Keyword</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">LeveledItem</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">LeveledNpc</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Light</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">LoadScreen</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Location</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">MagicEffect</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">MaterialObject</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">MaterialSwap</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">MaterialType</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Message</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">MiscItem</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">MovableStatic</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">MusicTrack</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">MusicType</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">NavigationMesh</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Npc</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ObjectEffect</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AObjectModification</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Package</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">PackIn</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Perk</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">PlacedNpc</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">PlacedObject</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Projectile</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Quest</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Race</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Region</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Relationship</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Scene</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ShaderParticleGeometry</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">SoundCategory</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">SoundDescriptor</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">SoundOutputModel</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Static</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">StaticCollection</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">TalkingActivator</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Terminal</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">TextureSet</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Transform</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Tree</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">VisualEffect</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">VoiceType</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Water</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Weapon</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Weather</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Worldspace</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Zoom</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AttractionRule</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Component</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">LocationReferenceType</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AnimationSoundTagSet</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Class</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Debris</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">FormList</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ImpactDataSet</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">LeveledSpell</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Outfit</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">SoundMarker</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AcousticSpace</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ReverbParameters</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">LandscapeTexture</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Spell</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Footstep</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">FootstepSet</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">GodRays</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">LensFlare</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Flora</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">BodyPartData</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">MovementType</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">DualCastData</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ConstructibleObject</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AimModel</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">BendableSpline</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">NavigationMeshInfoMap</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">LightingTemplate</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Layer</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ReferenceGroup</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Landscape</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AnimatedObject</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">DefaultObjectManager</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">DefaultObject</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">DialogView</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AssociationType</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AudioEffectChain</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">SoundKeywordMapping</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">SceneCollection</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AudioCategorySnapshot</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">NavigationMeshObstacleManager</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ObjectVisibilityManager</command:parameterValue> </command:parameterValueGroup> <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="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeDeletedRecords</maml:name> <maml:description> <maml:para>If true, includes deleted records.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RecordType</maml:name> <maml:description> <maml:para>The type of record to search for. Use tab completion to see the full list.</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: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.Collections.Generic.IEnumerable`1[[Mutagen.Bethesda.Plugins.Records.IMajorRecordGetter, Mutagen.Bethesda.Core, Version=0.42.0.0, Culture=neutral, PublicKeyToken=null]]</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>Get-FalloutWinningContextOverrides -RecordType Npc</dev:code> <dev:remarks> <maml:para>Returns the Winning Context Override for all Npcs present in your load order.</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>Get-FalloutWinningOverrides</command:name> <command:verb>Get</command:verb> <command:noun>FalloutWinningOverrides</command:noun> <maml:description> <maml:para>Returns winning overrides for your entire load order.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns an array of winning overrides of the specified type for your entire load order. This is actually a very fast cmdlet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-FalloutWinningOverrides</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeDeletedRecords</maml:name> <maml:description> <maml:para>If true, returns deleted records as well.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RecordType</maml:name> <maml:description> <maml:para>{{ Fill RecordType Description }}</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">ActionRecord</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Activator</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ActorValueInformation</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ADamageType</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AddonNode</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Ammunition</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">APlacedTrap</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Armor</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ArmorAddon</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ArtObject</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AStoryManagerNode</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Book</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">CameraPath</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">CameraShot</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Cell</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Climate</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">CollisionLayer</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ColorRecord</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">CombatStyle</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Container</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">DialogBranch</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">DialogResponses</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">DialogTopic</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Door</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">EffectShader</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">EncounterZone</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">EquipType</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Explosion</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Faction</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Furniture</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">GameSetting</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Global</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Grass</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Hazard</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">HeadPart</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Holotape</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">IdleAnimation</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">IdleMarker</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ImageSpace</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ImageSpaceAdapter</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Impact</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Ingestible</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Ingredient</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">InstanceNamingRules</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Key</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Keyword</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">LeveledItem</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">LeveledNpc</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Light</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">LoadScreen</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Location</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">MagicEffect</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">MaterialObject</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">MaterialSwap</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">MaterialType</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Message</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">MiscItem</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">MovableStatic</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">MusicTrack</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">MusicType</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">NavigationMesh</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Npc</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ObjectEffect</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AObjectModification</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Package</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">PackIn</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Perk</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">PlacedNpc</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">PlacedObject</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Projectile</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Quest</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Race</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Region</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Relationship</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Scene</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ShaderParticleGeometry</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">SoundCategory</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">SoundDescriptor</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">SoundOutputModel</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Static</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">StaticCollection</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">TalkingActivator</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Terminal</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">TextureSet</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Transform</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Tree</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">VisualEffect</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">VoiceType</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Water</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Weapon</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Weather</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Worldspace</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Zoom</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AttractionRule</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Component</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">LocationReferenceType</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AnimationSoundTagSet</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Class</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Debris</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">FormList</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ImpactDataSet</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">LeveledSpell</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Outfit</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">SoundMarker</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AcousticSpace</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ReverbParameters</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">LandscapeTexture</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Spell</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Footstep</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">FootstepSet</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">GodRays</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">LensFlare</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Flora</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">BodyPartData</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">MovementType</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">DualCastData</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ConstructibleObject</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AimModel</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">BendableSpline</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">NavigationMeshInfoMap</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">LightingTemplate</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Layer</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ReferenceGroup</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Landscape</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AnimatedObject</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">DefaultObjectManager</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">DefaultObject</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">DialogView</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AssociationType</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AudioEffectChain</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">SoundKeywordMapping</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">SceneCollection</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AudioCategorySnapshot</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">NavigationMeshObstacleManager</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">ObjectVisibilityManager</command:parameterValue> </command:parameterValueGroup> <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="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeDeletedRecords</maml:name> <maml:description> <maml:para>If true, returns deleted records as well.</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>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RecordType</maml:name> <maml:description> <maml:para>{{ Fill RecordType Description }}</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: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.Collections.Generic.IEnumerable`1[[Mutagen.Bethesda.Plugins.Records.IMajorRecordGetter, Mutagen.Bethesda.Core, Version=0.42.0.0, Culture=neutral, PublicKeyToken=null]]</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>Get-FalloutWinningOverrides -RecordType Npc</dev:code> <dev:remarks> <maml:para>Returns the winning override for all NPCs.</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-FalloutMod</command:name> <command:verb>New</command:verb> <command:noun>FalloutMod</command:noun> <maml:description> <maml:para>Creates a new Fallout 4 mod in memory.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns a new Fallout 4 mod in memory. Use Get-FalloutMod to retrieve existing mods from disk.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-FalloutMod</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ModKey</maml:name> <maml:description> <maml:para>The name of the mod.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ModKey</command:parameterValue> <dev:type> <maml:name>ModKey</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="named" aliases="none"> <maml:name>ModKey</maml:name> <maml:description> <maml:para>The name of the mod.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ModKey</command:parameterValue> <dev:type> <maml:name>ModKey</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>Mutagen.Bethesda.Fallout4.IFallout4Mod</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>New-FalloutMod -Modkey 'TestMod.esp'</dev:code> <dev:remarks> <maml:para>Creates a new mod in memory called 'TestMod.esp'</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>Write-FalloutMod</command:name> <command:verb>Write</command:verb> <command:noun>FalloutMod</command:noun> <maml:description> <maml:para>Writes a Fallout4Mod object to disk.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Writes the data stored in a Fallout4Mod object to disk.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Write-FalloutMod</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BinaryWriteParameters</maml:name> <maml:description> <maml:para>The [Mutagen.Bethesda.Plugins.Binary.Parameters.BinaryWriteParameters] object to pass to the mod writer.</maml:para> <maml:para>In the future there will be a function to create this object type. For now, use:</maml:para> <maml:para></maml:para> <maml:para>$bwp = [Mutagen.Bethesda.Plugins.Binary.Parameters.BinaryWriteParameters]::new()</maml:para> <maml:para># If the modkey to write to is different then the modkey provided on mod creation, ignore that error</maml:para> <maml:para>$bwp.ModKey = [Mutagen.Bethesda.Plugins.Binary.Parameters.ModKeyOption]::NoCheck</maml:para> <maml:para>Write-FalloutMod -Mod $mod -Path "$((Get-ModrifyGame).DataFolderPath)\TestMod.esp"</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BinaryWriteParameters</command:parameterValue> <dev:type> <maml:name>BinaryWriteParameters</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>FileSystem</maml:name> <maml:description> <maml:para>{{ Fill FileSystem Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IFileSystem</command:parameterValue> <dev:type> <maml:name>IFileSystem</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Mod</maml:name> <maml:description> <maml:para>The mod object to write. Can be created from scratch with New-FalloutMod or retrieved from disk with Get-FalloutMod.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IMod</command:parameterValue> <dev:type> <maml:name>IMod</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>ParallelWriteParameters</maml:name> <maml:description> <maml:para>{{ Fill ParallelWriteParameters Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ParallelWriteParameters</command:parameterValue> <dev:type> <maml:name>ParallelWriteParameters</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>The fully qualified file path to write to.</maml:para> <maml:para>The data folder can be retrieved with:</maml:para> <maml:para></maml:para> <maml:para>(Get-ModrifyGame).DataFolderPath</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">FileInfo</command:parameterValue> <dev:type> <maml:name>FileInfo</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>SkipCompressionFix</maml:name> <maml:description> <maml:para>Currently Mutagen does not support writting mods that have the compression flag enabled so Write-FalloutMod will cycle through each record and ensure that flag is disabled.</maml:para> <maml:para>Use this flag to disable that functionality.</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>BinaryWriteParameters</maml:name> <maml:description> <maml:para>The [Mutagen.Bethesda.Plugins.Binary.Parameters.BinaryWriteParameters] object to pass to the mod writer.</maml:para> <maml:para>In the future there will be a function to create this object type. For now, use:</maml:para> <maml:para></maml:para> <maml:para>$bwp = [Mutagen.Bethesda.Plugins.Binary.Parameters.BinaryWriteParameters]::new()</maml:para> <maml:para># If the modkey to write to is different then the modkey provided on mod creation, ignore that error</maml:para> <maml:para>$bwp.ModKey = [Mutagen.Bethesda.Plugins.Binary.Parameters.ModKeyOption]::NoCheck</maml:para> <maml:para>Write-FalloutMod -Mod $mod -Path "$((Get-ModrifyGame).DataFolderPath)\TestMod.esp"</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BinaryWriteParameters</command:parameterValue> <dev:type> <maml:name>BinaryWriteParameters</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>FileSystem</maml:name> <maml:description> <maml:para>{{ Fill FileSystem Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IFileSystem</command:parameterValue> <dev:type> <maml:name>IFileSystem</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Mod</maml:name> <maml:description> <maml:para>The mod object to write. Can be created from scratch with New-FalloutMod or retrieved from disk with Get-FalloutMod.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">IMod</command:parameterValue> <dev:type> <maml:name>IMod</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>ParallelWriteParameters</maml:name> <maml:description> <maml:para>{{ Fill ParallelWriteParameters Description }}</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">ParallelWriteParameters</command:parameterValue> <dev:type> <maml:name>ParallelWriteParameters</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>The fully qualified file path to write to.</maml:para> <maml:para>The data folder can be retrieved with:</maml:para> <maml:para></maml:para> <maml:para>(Get-ModrifyGame).DataFolderPath</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">FileInfo</command:parameterValue> <dev:type> <maml:name>FileInfo</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>SkipCompressionFix</maml:name> <maml:description> <maml:para>Currently Mutagen does not support writting mods that have the compression flag enabled so Write-FalloutMod will cycle through each record and ensure that flag is disabled.</maml:para> <maml:para>Use this flag to disable that functionality.</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>Mutagen.Bethesda.Plugins.Records.IMod</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># Create a new mod $mod = New-FalloutMod -ModKey 'TestMod.esp' # find the human race $humanRace = Get-FalloutMajorRecords -ModKey Fallout4.esm -RecordType Race | Where-Object {$_.EditorID -eq 'HumanRace'} # Get all human NPCs $humanNpcs = Get-FalloutMajorRecords -ModKey Fallout4.esm -RecordType Npc | Where-Object {$_.Race -eq $humanRace} # copy all nord NPCs as overrides into the new mod $overrides = $humanNpcs | Copy-FalloutRecordAsOverride -Mod $mod # do something to the humans $overrides | %{ ... } # Write the new data to a file in the data directory Write-FalloutMod -Mod $mod -Path "$((Get-ModrifyGame).DataFolderPath)\TestMod.esp"</dev:code> <dev:remarks> <maml:para>This example gets all Human NPCs using Get-FalloutMajorRecords and filtering with Where-Object.</maml:para> <maml:para>This will only return Races and NPCs from the Fallout4.esm master file. If you wish to get the winning overrides from your entire load order, use: Get-FalloutWinningOverrides instead.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> </helpItems> |