diff --git a/.editorconfig b/.editorconfig index 9a561d9..04ddef5 100644 --- a/.editorconfig +++ b/.editorconfig @@ -121,7 +121,7 @@ csharp_style_conditional_delegate_call = true # Предпочтения модификатора csharp_prefer_static_anonymous_function = true csharp_prefer_static_local_function = true -csharp_preferred_modifier_order = public, private, protected, file, static, extern, internal, virtual, abstract, override, sealed, readonly, new, unsafe, required, volatile, async:suggestion +csharp_preferred_modifier_order = public, private, protected, internal, file, static, extern, virtual, abstract, override, sealed, readonly, new, unsafe, required, volatile, async:suggestion csharp_style_prefer_readonly_struct = true csharp_style_prefer_readonly_struct_member = true @@ -287,3 +287,4 @@ dotnet_style_operator_placement_when_wrapping = beginning_of_line tab_width = 4 indent_size = 4 dotnet_diagnostic.ca1822.severity = none +dotnet_diagnostic.IDE0305.severity = none diff --git a/.gitignore b/.gitignore index d8c840f..f0924ae 100644 --- a/.gitignore +++ b/.gitignore @@ -367,3 +367,5 @@ FodyWeavers.xsd .env .aider* + +erd/.dump.sh \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AbstractCompendium.Count(ICollection_string_).md b/Documentation/Pf2eDataScrapper/AbstractCompendium.Count(ICollection_string_).md new file mode 100644 index 0000000..3e9023b --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractCompendium.Count(ICollection_string_).md @@ -0,0 +1,21 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers](Pf2eDataScrapper.Importers.md 'Pf2eDataScrapper\.Importers').[AbstractCompendium](AbstractCompendium.md 'Pf2eDataScrapper\.Importers\.AbstractCompendium') + +## AbstractCompendium\.Count\(ICollection\\) Method + +Возвращает количество элементов для указанного типа данных\. + +```csharp +public abstract int Count(System.Collections.Generic.ICollection type); +``` +#### Parameters + + + +`type` [System\.Collections\.Generic\.ICollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1')[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1') + +Типы данных\. + +#### Returns +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') +Количество элементов\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AbstractCompendium.Dir.md b/Documentation/Pf2eDataScrapper/AbstractCompendium.Dir.md new file mode 100644 index 0000000..8eb207a --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractCompendium.Dir.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers](Pf2eDataScrapper.Importers.md 'Pf2eDataScrapper\.Importers').[AbstractCompendium](AbstractCompendium.md 'Pf2eDataScrapper\.Importers\.AbstractCompendium') + +## AbstractCompendium\.Dir Property + +Путь к хранению исходных данных\. + +```csharp +public string Dir { get; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AbstractCompendium.Iterate(ICollection_string_).md b/Documentation/Pf2eDataScrapper/AbstractCompendium.Iterate(ICollection_string_).md new file mode 100644 index 0000000..0319d31 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractCompendium.Iterate(ICollection_string_).md @@ -0,0 +1,21 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers](Pf2eDataScrapper.Importers.md 'Pf2eDataScrapper\.Importers').[AbstractCompendium](AbstractCompendium.md 'Pf2eDataScrapper\.Importers\.AbstractCompendium') + +## AbstractCompendium\.Iterate\(ICollection\\) Method + +Получение итератора сущностей\. Если указан тип [type](AbstractCompendium.Iterate(ICollection_string_).md#Pf2eDataScrapper.Importers.AbstractCompendium.Iterate(System.Collections.Generic.ICollection_string_).type 'Pf2eDataScrapper\.Importers\.AbstractCompendium\.Iterate\(System\.Collections\.Generic\.ICollection\\)\.type') \- то только указанного типа\. + +```csharp +public abstract System.Collections.Generic.IEnumerable> Iterate(System.Collections.Generic.ICollection type); +``` +#### Parameters + + + +`type` [System\.Collections\.Generic\.ICollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1')[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1') + +Типы сущностей, которые нужно получить\. + +#### Returns +[System\.Collections\.Generic\.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System\.Collections\.Generic\.IEnumerable\`1')[System\.Tuple<](https://docs.microsoft.com/en-us/dotnet/api/System.Tuple-2 'System\.Tuple\`2')[AbstractCompendiumItem](AbstractCompendiumItem.md 'Pf2eDataScrapper\.Importers\.AbstractCompendiumItem')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Tuple-2 'System\.Tuple\`2')[Newtonsoft\.Json\.Linq\.JObject](https://docs.microsoft.com/en-us/dotnet/api/Newtonsoft.Json.Linq.JObject 'Newtonsoft\.Json\.Linq\.JObject')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Tuple-2 'System\.Tuple\`2')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System\.Collections\.Generic\.IEnumerable\`1') +Итератор сущностей\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AbstractCompendium.Repository.md b/Documentation/Pf2eDataScrapper/AbstractCompendium.Repository.md new file mode 100644 index 0000000..8477acf --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractCompendium.Repository.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers](Pf2eDataScrapper.Importers.md 'Pf2eDataScrapper\.Importers').[AbstractCompendium](AbstractCompendium.md 'Pf2eDataScrapper\.Importers\.AbstractCompendium') + +## AbstractCompendium\.Repository Property + +Репозиторий данных\. + +```csharp +public abstract Pf2eDataScrapper.Importers.Repositories.AbstractImporterRepository Repository { get; } +``` + +#### Property Value +[AbstractImporterRepository](AbstractImporterRepository.md 'Pf2eDataScrapper\.Importers\.Repositories\.AbstractImporterRepository') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AbstractCompendium.md b/Documentation/Pf2eDataScrapper/AbstractCompendium.md new file mode 100644 index 0000000..73d559c --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractCompendium.md @@ -0,0 +1,26 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers](Pf2eDataScrapper.Importers.md 'Pf2eDataScrapper\.Importers') + +## AbstractCompendium Class + +Компендиум данных\. + +```csharp +internal abstract class AbstractCompendium +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 AbstractCompendium + +Derived +↳ [AonprdCompendium](AonprdCompendium.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Compendium\.AonprdCompendium') +↳ [FoundryEnCompendium](FoundryEnCompendium.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium\.FoundryEnCompendium') + +| Properties | | +| :--- | :--- | +| [Dir](AbstractCompendium.Dir.md 'Pf2eDataScrapper\.Importers\.AbstractCompendium\.Dir') | Путь к хранению исходных данных\. | +| [Repository](AbstractCompendium.Repository.md 'Pf2eDataScrapper\.Importers\.AbstractCompendium\.Repository') | Репозиторий данных\. | + +| Methods | | +| :--- | :--- | +| [Count\(ICollection<string>\)](AbstractCompendium.Count(ICollection_string_).md 'Pf2eDataScrapper\.Importers\.AbstractCompendium\.Count\(System\.Collections\.Generic\.ICollection\\)') | Возвращает количество элементов для указанного типа данных\. | +| [Iterate\(ICollection<string>\)](AbstractCompendium.Iterate(ICollection_string_).md 'Pf2eDataScrapper\.Importers\.AbstractCompendium\.Iterate\(System\.Collections\.Generic\.ICollection\\)') | Получение итератора сущностей\. Если указан тип [type](AbstractCompendium.Iterate(ICollection_string_).md#Pf2eDataScrapper.Importers.AbstractCompendium.Iterate(System.Collections.Generic.ICollection_string_).type 'Pf2eDataScrapper\.Importers\.AbstractCompendium\.Iterate\(System\.Collections\.Generic\.ICollection\\)\.type') \- то только указанного типа\. | diff --git a/Documentation/Pf2eDataScrapper/AbstractCompendiumItem.Id.md b/Documentation/Pf2eDataScrapper/AbstractCompendiumItem.Id.md new file mode 100644 index 0000000..649ce2f --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractCompendiumItem.Id.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers](Pf2eDataScrapper.Importers.md 'Pf2eDataScrapper\.Importers').[AbstractCompendiumItem](AbstractCompendiumItem.md 'Pf2eDataScrapper\.Importers\.AbstractCompendiumItem') + +## AbstractCompendiumItem\.Id Property + +Идентификатор сущности\. + +```csharp +public abstract string Id { get; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AbstractCompendiumItem.ToString().md b/Documentation/Pf2eDataScrapper/AbstractCompendiumItem.ToString().md new file mode 100644 index 0000000..c526a2c --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractCompendiumItem.ToString().md @@ -0,0 +1,14 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers](Pf2eDataScrapper.Importers.md 'Pf2eDataScrapper\.Importers').[AbstractCompendiumItem](AbstractCompendiumItem.md 'Pf2eDataScrapper\.Importers\.AbstractCompendiumItem') + +## AbstractCompendiumItem\.ToString\(\) Method + +Строковое представление имени сущности\. + +```csharp +public override string ToString(); +``` + +#### Returns +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') +Строковое представление\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AbstractCompendiumItem.Type.md b/Documentation/Pf2eDataScrapper/AbstractCompendiumItem.Type.md new file mode 100644 index 0000000..5e0b031 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractCompendiumItem.Type.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers](Pf2eDataScrapper.Importers.md 'Pf2eDataScrapper\.Importers').[AbstractCompendiumItem](AbstractCompendiumItem.md 'Pf2eDataScrapper\.Importers\.AbstractCompendiumItem') + +## AbstractCompendiumItem\.Type Property + +Тип сущности\. + +```csharp +public abstract string Type { get; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AbstractCompendiumItem.md b/Documentation/Pf2eDataScrapper/AbstractCompendiumItem.md new file mode 100644 index 0000000..46999b4 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractCompendiumItem.md @@ -0,0 +1,25 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers](Pf2eDataScrapper.Importers.md 'Pf2eDataScrapper\.Importers') + +## AbstractCompendiumItem Class + +Абстрактная ссылка на сущность\. + +```csharp +internal abstract class AbstractCompendiumItem +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 AbstractCompendiumItem + +Derived +↳ [AonprdCompendiumItem](AonprdCompendiumItem.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Compendium\.AonprdCompendiumItem') +↳ [FoundryEnCompendiumItem](FoundryEnCompendiumItem.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium\.FoundryEnCompendiumItem') + +| Properties | | +| :--- | :--- | +| [Id](AbstractCompendiumItem.Id.md 'Pf2eDataScrapper\.Importers\.AbstractCompendiumItem\.Id') | Идентификатор сущности\. | +| [Type](AbstractCompendiumItem.Type.md 'Pf2eDataScrapper\.Importers\.AbstractCompendiumItem\.Type') | Тип сущности\. | + +| Methods | | +| :--- | :--- | +| [ToString\(\)](AbstractCompendiumItem.ToString().md 'Pf2eDataScrapper\.Importers\.AbstractCompendiumItem\.ToString\(\)') | Строковое представление имени сущности\. | diff --git a/Documentation/Pf2eDataScrapper/AbstractEntityProcessor.AbstractEntityProcessor(ProcessorInput,StringHelper,DatabaseHelper,AonprdBuilderGlobals).md b/Documentation/Pf2eDataScrapper/AbstractEntityProcessor.AbstractEntityProcessor(ProcessorInput,StringHelper,DatabaseHelper,AonprdBuilderGlobals).md new file mode 100644 index 0000000..cecffd4 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractEntityProcessor.AbstractEntityProcessor(ProcessorInput,StringHelper,DatabaseHelper,AonprdBuilderGlobals).md @@ -0,0 +1,40 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors').[AbstractEntityProcessor](AbstractEntityProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.AbstractEntityProcessor') + +## AbstractEntityProcessor\(ProcessorInput, StringHelper, DatabaseHelper, AonprdBuilderGlobals\) Constructor + +Абстрактный класс\-обработчик сущностей, полученных из Архивов Нефиса\. +Класс предназначен для обработки данных с помощью различных обработчиков, +для которых указан атрибут [ProcessorAttribute](ProcessorAttribute.md 'Pf2eDataScrapper\.Processors\.Attributes\.ProcessorAttribute')\. + +```csharp +protected AbstractEntityProcessor(Pf2eDataScrapper.Processors.ProcessorInput input, Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.StringHelper stringHelper, Pf2eDataScrapper.Helpers.DatabaseHelper helper, Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.AonprdBuilderGlobals globals); +``` +#### Parameters + + + +`input` [ProcessorInput](ProcessorInput.md 'Pf2eDataScrapper\.Processors\.ProcessorInput') + +Объект обработки вводимого JSON\. + + + +`stringHelper` [StringHelper](StringHelper.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.StringHelper') + +\[DI\] Помощник обработки строк\. + + + +`helper` [DatabaseHelper](DatabaseHelper.md 'Pf2eDataScrapper\.Helpers\.DatabaseHelper') + +\[DI\] Помощник работы с БД\. + + + +`globals` [AonprdBuilderGlobals](AonprdBuilderGlobals.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.AonprdBuilderGlobals') + +\[DI\] Глобальные параметра обработки Архивов Нефиса\. + +### See Also +- [ProcessorAttribute](ProcessorAttribute.md 'Pf2eDataScrapper\.Processors\.Attributes\.ProcessorAttribute') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AbstractEntityProcessor.Add().md b/Documentation/Pf2eDataScrapper/AbstractEntityProcessor.Add().md new file mode 100644 index 0000000..75b8958 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractEntityProcessor.Add().md @@ -0,0 +1,10 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors').[AbstractEntityProcessor](AbstractEntityProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.AbstractEntityProcessor') + +## AbstractEntityProcessor\.Add\(\) Method + +Добавление основной сущности в контекст базы данных\. + +```csharp +protected abstract void Add(); +``` \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AbstractEntityProcessor.AddEntity().md b/Documentation/Pf2eDataScrapper/AbstractEntityProcessor.AddEntity().md new file mode 100644 index 0000000..b7bfa24 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractEntityProcessor.AddEntity().md @@ -0,0 +1,10 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors').[AbstractEntityProcessor](AbstractEntityProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.AbstractEntityProcessor') + +## AbstractEntityProcessor\.AddEntity\(\) Method + +Генерация основных полей корневой сущности\. + +```csharp +protected virtual void AddEntity(); +``` \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AbstractEntityProcessor.AddExternal().md b/Documentation/Pf2eDataScrapper/AbstractEntityProcessor.AddExternal().md new file mode 100644 index 0000000..ade037c --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractEntityProcessor.AddExternal().md @@ -0,0 +1,10 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors').[AbstractEntityProcessor](AbstractEntityProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.AbstractEntityProcessor') + +## AbstractEntityProcessor\.AddExternal\(\) Method + +Генерация внешних ссылок сущности\. + +```csharp +protected virtual void AddExternal(); +``` \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AbstractEntityProcessor.AddSource().md b/Documentation/Pf2eDataScrapper/AbstractEntityProcessor.AddSource().md new file mode 100644 index 0000000..17a2906 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractEntityProcessor.AddSource().md @@ -0,0 +1,10 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors').[AbstractEntityProcessor](AbstractEntityProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.AbstractEntityProcessor') + +## AbstractEntityProcessor\.AddSource\(\) Method + +Генерация источников сущности\. + +```csharp +protected virtual void AddSource(); +``` \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AbstractEntityProcessor.AddTraits().md b/Documentation/Pf2eDataScrapper/AbstractEntityProcessor.AddTraits().md new file mode 100644 index 0000000..0667c1f --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractEntityProcessor.AddTraits().md @@ -0,0 +1,10 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors').[AbstractEntityProcessor](AbstractEntityProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.AbstractEntityProcessor') + +## AbstractEntityProcessor\.AddTraits\(\) Method + +Генерация списка признаков сущности\. + +```csharp +protected virtual void AddTraits(); +``` \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AbstractEntityProcessor.AddedDescription.md b/Documentation/Pf2eDataScrapper/AbstractEntityProcessor.AddedDescription.md new file mode 100644 index 0000000..e967251 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractEntityProcessor.AddedDescription.md @@ -0,0 +1,51 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors').[AbstractEntityProcessor](AbstractEntityProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.AbstractEntityProcessor') + +## AbstractEntityProcessor\.AddedDescription Method + +| Overloads | | +| :--- | :--- | +| [AddedDescription\(string\)](AbstractEntityProcessor.AddedDescription.md#Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.AbstractEntityProcessor.AddedDescription(string) 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.AbstractEntityProcessor\.AddedDescription\(string\)') | Создание строкового представления объекта по указанному пути для добавления к описанию сущности\. | +| [AddedDescription\(ICollection<string>\)](AbstractEntityProcessor.AddedDescription.md#Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.AbstractEntityProcessor.AddedDescription(System.Collections.Generic.ICollection_string_) 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.AbstractEntityProcessor\.AddedDescription\(System\.Collections\.Generic\.ICollection\\)') | Создание строкового представления объектов по указанным путям для добавления к описанию сущности\. | + + + +## AbstractEntityProcessor\.AddedDescription\(string\) Method + +Создание строкового представления объекта по указанному пути для добавления к описанию сущности\. + +```csharp +protected string AddedDescription(string path); +``` +#### Parameters + + + +`path` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +Путь к добавляемому объекту\. + +#### Returns +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') +Строковое представление для добавления к описанию сущности\. + + + +## AbstractEntityProcessor\.AddedDescription\(ICollection\\) Method + +Создание строкового представления объектов по указанным путям для добавления к описанию сущности\. + +```csharp +protected string AddedDescription(System.Collections.Generic.ICollection paths); +``` +#### Parameters + + + +`paths` [System\.Collections\.Generic\.ICollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1')[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1') + +Список путей к добавляемым объектам\. + +#### Returns +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') +Строковое представление для добавления к описанию сущности\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AbstractEntityProcessor.AddedDescriptionPaths().md b/Documentation/Pf2eDataScrapper/AbstractEntityProcessor.AddedDescriptionPaths().md new file mode 100644 index 0000000..8d57bae --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractEntityProcessor.AddedDescriptionPaths().md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors').[AbstractEntityProcessor](AbstractEntityProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.AbstractEntityProcessor') + +## AbstractEntityProcessor\.AddedDescriptionPaths\(\) Method + +Получение списка полей, которые должны быть добавлены в описание\. + +```csharp +protected virtual System.Collections.Generic.ICollection AddedDescriptionPaths(); +``` + +#### Returns +[System\.Collections\.Generic\.ICollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1')[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AbstractEntityProcessor.Check().md b/Documentation/Pf2eDataScrapper/AbstractEntityProcessor.Check().md new file mode 100644 index 0000000..af05325 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractEntityProcessor.Check().md @@ -0,0 +1,10 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors').[AbstractEntityProcessor](AbstractEntityProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.AbstractEntityProcessor') + +## AbstractEntityProcessor\.Check\(\) Method + +Проверки необходимости импорта сущности\. + +```csharp +public virtual void Check(); +``` \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AbstractEntityProcessor.Entity.md b/Documentation/Pf2eDataScrapper/AbstractEntityProcessor.Entity.md new file mode 100644 index 0000000..9e0a89c --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractEntityProcessor.Entity.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors').[AbstractEntityProcessor](AbstractEntityProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.AbstractEntityProcessor') + +## AbstractEntityProcessor\.Entity Property + +Корневая сущность\. + +```csharp +public Pf2eModel.Model.Base.Entity Entity { get; } +``` + +#### Property Value +[Pf2eModel\.Model\.Base\.Entity](https://docs.microsoft.com/en-us/dotnet/api/Pf2eModel.Model.Base.Entity 'Pf2eModel\.Model\.Base\.Entity') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AbstractEntityProcessor.GenerateJsonString(ICollection_string_).md b/Documentation/Pf2eDataScrapper/AbstractEntityProcessor.GenerateJsonString(ICollection_string_).md new file mode 100644 index 0000000..e95ce5c --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractEntityProcessor.GenerateJsonString(ICollection_string_).md @@ -0,0 +1,21 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors').[AbstractEntityProcessor](AbstractEntityProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.AbstractEntityProcessor') + +## AbstractEntityProcessor\.GenerateJsonString\(ICollection\\) Method + +Генерация JSON\-строки из объектов, располагаюхися по путям, указанным в [paths](AbstractEntityProcessor.GenerateJsonString(ICollection_string_).md#Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.AbstractEntityProcessor.GenerateJsonString(System.Collections.Generic.ICollection_string_).paths 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.AbstractEntityProcessor\.GenerateJsonString\(System\.Collections\.Generic\.ICollection\\)\.paths')\. + +```csharp +protected string GenerateJsonString(System.Collections.Generic.ICollection paths); +``` +#### Parameters + + + +`paths` [System\.Collections\.Generic\.ICollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1')[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1') + +Коллекция путей, из которых необходимо достатить объекты\. + +#### Returns +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') +JSON\-строка\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AbstractEntityProcessor.GetDescription().md b/Documentation/Pf2eDataScrapper/AbstractEntityProcessor.GetDescription().md new file mode 100644 index 0000000..a728163 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractEntityProcessor.GetDescription().md @@ -0,0 +1,14 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors').[AbstractEntityProcessor](AbstractEntityProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.AbstractEntityProcessor') + +## AbstractEntityProcessor\.GetDescription\(\) Method + +Сгенерировать описание сущности\. + +```csharp +protected virtual string GetDescription(); +``` + +#### Returns +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') +Описание сущности \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AbstractEntityProcessor.Object.md b/Documentation/Pf2eDataScrapper/AbstractEntityProcessor.Object.md new file mode 100644 index 0000000..626bd64 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractEntityProcessor.Object.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors').[AbstractEntityProcessor](AbstractEntityProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.AbstractEntityProcessor') + +## AbstractEntityProcessor\.Object Property + +Основная сущность\. + +```csharp +public abstract Pf2eModel.Model.IEntity Object { get; } +``` + +#### Property Value +[Pf2eModel\.Model\.IEntity](https://docs.microsoft.com/en-us/dotnet/api/Pf2eModel.Model.IEntity 'Pf2eModel\.Model\.IEntity') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AbstractEntityProcessor.Process().md b/Documentation/Pf2eDataScrapper/AbstractEntityProcessor.Process().md new file mode 100644 index 0000000..ba33527 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractEntityProcessor.Process().md @@ -0,0 +1,12 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors').[AbstractEntityProcessor](AbstractEntityProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.AbstractEntityProcessor') + +## AbstractEntityProcessor\.Process\(\) Method + +Основной метод обработки данных\. + +```csharp +public override void Process(); +``` + +Implements [Process\(\)](IProcessor.Process().md 'Pf2eDataScrapper\.Processors\.Definitions\.IProcessor\.Process\(\)') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AbstractEntityProcessor.Save().md b/Documentation/Pf2eDataScrapper/AbstractEntityProcessor.Save().md new file mode 100644 index 0000000..dfbf8fe --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractEntityProcessor.Save().md @@ -0,0 +1,12 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors').[AbstractEntityProcessor](AbstractEntityProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.AbstractEntityProcessor') + +## AbstractEntityProcessor\.Save\(\) Method + +Метод для сохранения изменений в базе данных\. + +```csharp +public override void Save(); +``` + +Implements [Save\(\)](IProcessor.Save().md 'Pf2eDataScrapper\.Processors\.Definitions\.IProcessor\.Save\(\)') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AbstractEntityProcessor.Type.md b/Documentation/Pf2eDataScrapper/AbstractEntityProcessor.Type.md new file mode 100644 index 0000000..95a07ad --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractEntityProcessor.Type.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors').[AbstractEntityProcessor](AbstractEntityProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.AbstractEntityProcessor') + +## AbstractEntityProcessor\.Type Property + +Тип сущности\. + +```csharp +public abstract Pf2eModel.Model.Enum.EntityType Type { get; } +``` + +#### Property Value +[Pf2eModel\.Model\.Enum\.EntityType](https://docs.microsoft.com/en-us/dotnet/api/Pf2eModel.Model.Enum.EntityType 'Pf2eModel\.Model\.Enum\.EntityType') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AbstractEntityProcessor.md b/Documentation/Pf2eDataScrapper/AbstractEntityProcessor.md new file mode 100644 index 0000000..360037e --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractEntityProcessor.md @@ -0,0 +1,60 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors') + +## AbstractEntityProcessor Class + +Абстрактный класс\-обработчик сущностей, полученных из Архивов Нефиса\. +Класс предназначен для обработки данных с помощью различных обработчиков, +для которых указан атрибут [ProcessorAttribute](ProcessorAttribute.md 'Pf2eDataScrapper\.Processors\.Attributes\.ProcessorAttribute')\. + +```csharp +internal abstract class AbstractEntityProcessor : Pf2eDataScrapper.Processors.Definitions.AbstractInputProcessor +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [AbstractInputProcessor](AbstractInputProcessor.md 'Pf2eDataScrapper\.Processors\.Definitions\.AbstractInputProcessor') 🡒 AbstractEntityProcessor + +Derived +↳ [AbstractSubclassProcessor](AbstractSubclassProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.AbstractSubclassProcessor') +↳ [ActionProcessor](ActionProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.ActionProcessor') +↳ [AncestryProcessor](AncestryProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.AncestryProcessor') +↳ [ArchetypeProcessor](ArchetypeProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.ArchetypeProcessor') +↳ [BackgroundProcessor](BackgroundProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.BackgroundProcessor') +↳ [ClassProcessor](ClassProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.ClassProcessor') +↳ [FeatProcessor](FeatProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.FeatProcessor') +↳ [HeritageProcessor](HeritageProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.HeritageProcessor') +↳ [LanguageProcessor](LanguageProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.LanguageProcessor') +↳ [RitualProcessor](RitualProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.RitualProcessor') +↳ [RuleProcessor](RuleProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules\.RuleProcessor') +↳ [SkillActionsProcessor](SkillActionsProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.SkillActionsProcessor') +↳ [SpellProcessor](SpellProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.SpellProcessor') +↳ [TraitProcessor](TraitProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.TraitProcessor') +↳ [VersitileHeritageProcessor](VersitileHeritageProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.VersitileHeritageProcessor') + +### See Also +- [ProcessorAttribute](ProcessorAttribute.md 'Pf2eDataScrapper\.Processors\.Attributes\.ProcessorAttribute') + +| Constructors | | +| :--- | :--- | +| [AbstractEntityProcessor\(ProcessorInput, StringHelper, DatabaseHelper, AonprdBuilderGlobals\)](AbstractEntityProcessor.AbstractEntityProcessor(ProcessorInput,StringHelper,DatabaseHelper,AonprdBuilderGlobals).md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.AbstractEntityProcessor\.AbstractEntityProcessor\(Pf2eDataScrapper\.Processors\.ProcessorInput, Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.StringHelper, Pf2eDataScrapper\.Helpers\.DatabaseHelper, Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.AonprdBuilderGlobals\)') | Абстрактный класс\-обработчик сущностей, полученных из Архивов Нефиса\. Класс предназначен для обработки данных с помощью различных обработчиков, для которых указан атрибут [ProcessorAttribute](ProcessorAttribute.md 'Pf2eDataScrapper\.Processors\.Attributes\.ProcessorAttribute')\. | + +| Properties | | +| :--- | :--- | +| [Entity](AbstractEntityProcessor.Entity.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.AbstractEntityProcessor\.Entity') | Корневая сущность\. | +| [Object](AbstractEntityProcessor.Object.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.AbstractEntityProcessor\.Object') | Основная сущность\. | +| [Type](AbstractEntityProcessor.Type.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.AbstractEntityProcessor\.Type') | Тип сущности\. | + +| Methods | | +| :--- | :--- | +| [Add\(\)](AbstractEntityProcessor.Add().md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.AbstractEntityProcessor\.Add\(\)') | Добавление основной сущности в контекст базы данных\. | +| [AddedDescription\(string\)](AbstractEntityProcessor.AddedDescription.md#Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.AbstractEntityProcessor.AddedDescription(string) 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.AbstractEntityProcessor\.AddedDescription\(string\)') | Создание строкового представления объекта по указанному пути для добавления к описанию сущности\. | +| [AddedDescription\(ICollection<string>\)](AbstractEntityProcessor.AddedDescription.md#Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.AbstractEntityProcessor.AddedDescription(System.Collections.Generic.ICollection_string_) 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.AbstractEntityProcessor\.AddedDescription\(System\.Collections\.Generic\.ICollection\\)') | Создание строкового представления объектов по указанным путям для добавления к описанию сущности\. | +| [AddedDescriptionPaths\(\)](AbstractEntityProcessor.AddedDescriptionPaths().md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.AbstractEntityProcessor\.AddedDescriptionPaths\(\)') | Получение списка полей, которые должны быть добавлены в описание\. | +| [AddEntity\(\)](AbstractEntityProcessor.AddEntity().md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.AbstractEntityProcessor\.AddEntity\(\)') | Генерация основных полей корневой сущности\. | +| [AddExternal\(\)](AbstractEntityProcessor.AddExternal().md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.AbstractEntityProcessor\.AddExternal\(\)') | Генерация внешних ссылок сущности\. | +| [AddSource\(\)](AbstractEntityProcessor.AddSource().md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.AbstractEntityProcessor\.AddSource\(\)') | Генерация источников сущности\. | +| [AddTraits\(\)](AbstractEntityProcessor.AddTraits().md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.AbstractEntityProcessor\.AddTraits\(\)') | Генерация списка признаков сущности\. | +| [Check\(\)](AbstractEntityProcessor.Check().md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.AbstractEntityProcessor\.Check\(\)') | Проверки необходимости импорта сущности\. | +| [GenerateJsonString\(ICollection<string>\)](AbstractEntityProcessor.GenerateJsonString(ICollection_string_).md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.AbstractEntityProcessor\.GenerateJsonString\(System\.Collections\.Generic\.ICollection\\)') | Генерация JSON\-строки из объектов, располагаюхися по путям, указанным в [paths](AbstractEntityProcessor.GenerateJsonString(ICollection_string_).md#Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.AbstractEntityProcessor.GenerateJsonString(System.Collections.Generic.ICollection_string_).paths 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.AbstractEntityProcessor\.GenerateJsonString\(System\.Collections\.Generic\.ICollection\\)\.paths')\. | +| [GetDescription\(\)](AbstractEntityProcessor.GetDescription().md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.AbstractEntityProcessor\.GetDescription\(\)') | Сгенерировать описание сущности\. | +| [Process\(\)](AbstractEntityProcessor.Process().md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.AbstractEntityProcessor\.Process\(\)') | Основной метод обработки данных\. | +| [Save\(\)](AbstractEntityProcessor.Save().md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.AbstractEntityProcessor\.Save\(\)') | Метод для сохранения изменений в базе данных\. | diff --git a/Documentation/Pf2eDataScrapper/AbstractImporter.Dir.md b/Documentation/Pf2eDataScrapper/AbstractImporter.Dir.md new file mode 100644 index 0000000..1764156 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractImporter.Dir.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers](Pf2eDataScrapper.Importers.md 'Pf2eDataScrapper\.Importers').[AbstractImporter](AbstractImporter.md 'Pf2eDataScrapper\.Importers\.AbstractImporter') + +## AbstractImporter\.Dir Property + +Путь к директории с данными для импортёра\. + +```csharp +public string Dir { get; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AbstractImporter.Name.md b/Documentation/Pf2eDataScrapper/AbstractImporter.Name.md new file mode 100644 index 0000000..c59f555 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractImporter.Name.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers](Pf2eDataScrapper.Importers.md 'Pf2eDataScrapper\.Importers').[AbstractImporter](AbstractImporter.md 'Pf2eDataScrapper\.Importers\.AbstractImporter') + +## AbstractImporter\.Name Property + +Отображаемое имя импортёра\. + +```csharp +public abstract string Name { get; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AbstractImporter.Slug.md b/Documentation/Pf2eDataScrapper/AbstractImporter.Slug.md new file mode 100644 index 0000000..060561d --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractImporter.Slug.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers](Pf2eDataScrapper.Importers.md 'Pf2eDataScrapper\.Importers').[AbstractImporter](AbstractImporter.md 'Pf2eDataScrapper\.Importers\.AbstractImporter') + +## AbstractImporter\.Slug Property + +Короткое имя импортёра\. + +```csharp +public abstract string Slug { get; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AbstractImporter.md b/Documentation/Pf2eDataScrapper/AbstractImporter.md new file mode 100644 index 0000000..503707d --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractImporter.md @@ -0,0 +1,22 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers](Pf2eDataScrapper.Importers.md 'Pf2eDataScrapper\.Importers') + +## AbstractImporter Class + +Абстрактный класс импортёра\. + +```csharp +internal abstract class AbstractImporter +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 AbstractImporter + +Derived +↳ [AonprdImporter](AonprdImporter.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.AonprdImporter') +↳ [FoundryEnImporter](FoundryEnImporter.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.FoundryEnImporter') + +| Properties | | +| :--- | :--- | +| [Dir](AbstractImporter.Dir.md 'Pf2eDataScrapper\.Importers\.AbstractImporter\.Dir') | Путь к директории с данными для импортёра\. | +| [Name](AbstractImporter.Name.md 'Pf2eDataScrapper\.Importers\.AbstractImporter\.Name') | Отображаемое имя импортёра\. | +| [Slug](AbstractImporter.Slug.md 'Pf2eDataScrapper\.Importers\.AbstractImporter\.Slug') | Короткое имя импортёра\. | diff --git a/Documentation/Pf2eDataScrapper/AbstractImporterRepository.AbstractImporterRepository(AbstractImporter).md b/Documentation/Pf2eDataScrapper/AbstractImporterRepository.AbstractImporterRepository(AbstractImporter).md new file mode 100644 index 0000000..4c2bfe1 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractImporterRepository.AbstractImporterRepository(AbstractImporter).md @@ -0,0 +1,17 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Repositories](Pf2eDataScrapper.Importers.Repositories.md 'Pf2eDataScrapper\.Importers\.Repositories').[AbstractImporterRepository](AbstractImporterRepository.md 'Pf2eDataScrapper\.Importers\.Repositories\.AbstractImporterRepository') + +## AbstractImporterRepository\(AbstractImporter\) Constructor + +Класс абстрактного репозитория\. + +```csharp +protected AbstractImporterRepository(Pf2eDataScrapper.Importers.AbstractImporter importer); +``` +#### Parameters + + + +`importer` [AbstractImporter](AbstractImporter.md 'Pf2eDataScrapper\.Importers\.AbstractImporter') + +Импортёр, использующий репозиторий\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AbstractImporterRepository.Importer.md b/Documentation/Pf2eDataScrapper/AbstractImporterRepository.Importer.md new file mode 100644 index 0000000..5c06e1f --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractImporterRepository.Importer.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Repositories](Pf2eDataScrapper.Importers.Repositories.md 'Pf2eDataScrapper\.Importers\.Repositories').[AbstractImporterRepository](AbstractImporterRepository.md 'Pf2eDataScrapper\.Importers\.Repositories\.AbstractImporterRepository') + +## AbstractImporterRepository\.Importer Field + +Импортёр, использующий репозиторий\. + +```csharp +public readonly AbstractImporter Importer; +``` + +#### Field Value +[AbstractImporter](AbstractImporter.md 'Pf2eDataScrapper\.Importers\.AbstractImporter') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AbstractImporterRepository.RepositoryDir.md b/Documentation/Pf2eDataScrapper/AbstractImporterRepository.RepositoryDir.md new file mode 100644 index 0000000..de62218 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractImporterRepository.RepositoryDir.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Repositories](Pf2eDataScrapper.Importers.Repositories.md 'Pf2eDataScrapper\.Importers\.Repositories').[AbstractImporterRepository](AbstractImporterRepository.md 'Pf2eDataScrapper\.Importers\.Repositories\.AbstractImporterRepository') + +## AbstractImporterRepository\.RepositoryDir Property + +CLR\-представкление директории с данными\. + +```csharp +public System.IO.DirectoryInfo RepositoryDir { get; } +``` + +#### Property Value +[System\.IO\.DirectoryInfo](https://docs.microsoft.com/en-us/dotnet/api/System.IO.DirectoryInfo 'System\.IO\.DirectoryInfo') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AbstractImporterRepository.RepositoryDirPath.md b/Documentation/Pf2eDataScrapper/AbstractImporterRepository.RepositoryDirPath.md new file mode 100644 index 0000000..ee593f3 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractImporterRepository.RepositoryDirPath.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Repositories](Pf2eDataScrapper.Importers.Repositories.md 'Pf2eDataScrapper\.Importers\.Repositories').[AbstractImporterRepository](AbstractImporterRepository.md 'Pf2eDataScrapper\.Importers\.Repositories\.AbstractImporterRepository') + +## AbstractImporterRepository\.RepositoryDirPath Property + +Путь к директории с данными для импортёра\. + +```csharp +public string RepositoryDirPath { get; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AbstractImporterRepository.Update(ProcessProgress).md b/Documentation/Pf2eDataScrapper/AbstractImporterRepository.Update(ProcessProgress).md new file mode 100644 index 0000000..8ece2e0 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractImporterRepository.Update(ProcessProgress).md @@ -0,0 +1,15 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Repositories](Pf2eDataScrapper.Importers.Repositories.md 'Pf2eDataScrapper\.Importers\.Repositories').[AbstractImporterRepository](AbstractImporterRepository.md 'Pf2eDataScrapper\.Importers\.Repositories\.AbstractImporterRepository') + +## AbstractImporterRepository\.Update\(ProcessProgress\) Method + +Обновление данных в репозитории\. + +```csharp +public abstract void Update(Pf2eDataScrapper.Helpers.ProcessProgress progress); +``` +#### Parameters + + + +`progress` [ProcessProgress](ProcessProgress.md 'Pf2eDataScrapper\.Helpers\.ProcessProgress') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AbstractImporterRepository.md b/Documentation/Pf2eDataScrapper/AbstractImporterRepository.md new file mode 100644 index 0000000..3f81b92 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractImporterRepository.md @@ -0,0 +1,33 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Repositories](Pf2eDataScrapper.Importers.Repositories.md 'Pf2eDataScrapper\.Importers\.Repositories') + +## AbstractImporterRepository Class + +Класс абстрактного репозитория\. + +```csharp +internal abstract class AbstractImporterRepository +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 AbstractImporterRepository + +Derived +↳ [AonprdRepository](AonprdRepository.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.AonprdRepository') +↳ [GitRepository](GitRepository.md 'Pf2eDataScrapper\.Importers\.Repositories\.GitRepository') + +| Constructors | | +| :--- | :--- | +| [AbstractImporterRepository\(AbstractImporter\)](AbstractImporterRepository.AbstractImporterRepository(AbstractImporter).md 'Pf2eDataScrapper\.Importers\.Repositories\.AbstractImporterRepository\.AbstractImporterRepository\(Pf2eDataScrapper\.Importers\.AbstractImporter\)') | Класс абстрактного репозитория\. | + +| Fields | | +| :--- | :--- | +| [Importer](AbstractImporterRepository.Importer.md 'Pf2eDataScrapper\.Importers\.Repositories\.AbstractImporterRepository\.Importer') | Импортёр, использующий репозиторий\. | + +| Properties | | +| :--- | :--- | +| [RepositoryDir](AbstractImporterRepository.RepositoryDir.md 'Pf2eDataScrapper\.Importers\.Repositories\.AbstractImporterRepository\.RepositoryDir') | CLR\-представкление директории с данными\. | +| [RepositoryDirPath](AbstractImporterRepository.RepositoryDirPath.md 'Pf2eDataScrapper\.Importers\.Repositories\.AbstractImporterRepository\.RepositoryDirPath') | Путь к директории с данными для импортёра\. | + +| Methods | | +| :--- | :--- | +| [Update\(ProcessProgress\)](AbstractImporterRepository.Update(ProcessProgress).md 'Pf2eDataScrapper\.Importers\.Repositories\.AbstractImporterRepository\.Update\(Pf2eDataScrapper\.Helpers\.ProcessProgress\)') | Обновление данных в репозитории\. | diff --git a/Documentation/Pf2eDataScrapper/AbstractInputProcessor.AbstractInputProcessor(ProcessorInput).md b/Documentation/Pf2eDataScrapper/AbstractInputProcessor.AbstractInputProcessor(ProcessorInput).md new file mode 100644 index 0000000..35b5ca4 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractInputProcessor.AbstractInputProcessor(ProcessorInput).md @@ -0,0 +1,22 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Processors\.Definitions](Pf2eDataScrapper.Processors.Definitions.md 'Pf2eDataScrapper\.Processors\.Definitions').[AbstractInputProcessor](AbstractInputProcessor.md 'Pf2eDataScrapper\.Processors\.Definitions\.AbstractInputProcessor') + +## AbstractInputProcessor\(ProcessorInput\) Constructor + +Абстрактный класс\-обработчик данных, полученных из Архивов Нефиса\. +Класс предназначен для обработки данных с помощью различных обработчиков, +для которых указан атрибут [ProcessorAttribute](ProcessorAttribute.md 'Pf2eDataScrapper\.Processors\.Attributes\.ProcessorAttribute')\. + +```csharp +protected AbstractInputProcessor(Pf2eDataScrapper.Processors.ProcessorInput input); +``` +#### Parameters + + + +`input` [ProcessorInput](ProcessorInput.md 'Pf2eDataScrapper\.Processors\.ProcessorInput') + +Входные данные обработчика\. + +### See Also +- [ProcessorAttribute](ProcessorAttribute.md 'Pf2eDataScrapper\.Processors\.Attributes\.ProcessorAttribute') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AbstractInputProcessor.Input.md b/Documentation/Pf2eDataScrapper/AbstractInputProcessor.Input.md new file mode 100644 index 0000000..59b4cf9 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractInputProcessor.Input.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Processors\.Definitions](Pf2eDataScrapper.Processors.Definitions.md 'Pf2eDataScrapper\.Processors\.Definitions').[AbstractInputProcessor](AbstractInputProcessor.md 'Pf2eDataScrapper\.Processors\.Definitions\.AbstractInputProcessor') + +## AbstractInputProcessor\.Input Property + +Входные данные обработчика\. + +```csharp +public Pf2eDataScrapper.Processors.ProcessorInput Input { get; } +``` + +#### Property Value +[ProcessorInput](ProcessorInput.md 'Pf2eDataScrapper\.Processors\.ProcessorInput') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AbstractInputProcessor.Process().md b/Documentation/Pf2eDataScrapper/AbstractInputProcessor.Process().md new file mode 100644 index 0000000..d0ed30d --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractInputProcessor.Process().md @@ -0,0 +1,12 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Processors\.Definitions](Pf2eDataScrapper.Processors.Definitions.md 'Pf2eDataScrapper\.Processors\.Definitions').[AbstractInputProcessor](AbstractInputProcessor.md 'Pf2eDataScrapper\.Processors\.Definitions\.AbstractInputProcessor') + +## AbstractInputProcessor\.Process\(\) Method + +Основной метод обработки данных\. + +```csharp +public abstract void Process(); +``` + +Implements [Process\(\)](IProcessor.Process().md 'Pf2eDataScrapper\.Processors\.Definitions\.IProcessor\.Process\(\)') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AbstractInputProcessor.Save().md b/Documentation/Pf2eDataScrapper/AbstractInputProcessor.Save().md new file mode 100644 index 0000000..2a6bf0b --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractInputProcessor.Save().md @@ -0,0 +1,12 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Processors\.Definitions](Pf2eDataScrapper.Processors.Definitions.md 'Pf2eDataScrapper\.Processors\.Definitions').[AbstractInputProcessor](AbstractInputProcessor.md 'Pf2eDataScrapper\.Processors\.Definitions\.AbstractInputProcessor') + +## AbstractInputProcessor\.Save\(\) Method + +Метод для сохранения изменений в базе данных\. + +```csharp +public abstract void Save(); +``` + +Implements [Save\(\)](IProcessor.Save().md 'Pf2eDataScrapper\.Processors\.Definitions\.IProcessor\.Save\(\)') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AbstractInputProcessor.md b/Documentation/Pf2eDataScrapper/AbstractInputProcessor.md new file mode 100644 index 0000000..a7d4e60 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractInputProcessor.md @@ -0,0 +1,37 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Processors\.Definitions](Pf2eDataScrapper.Processors.Definitions.md 'Pf2eDataScrapper\.Processors\.Definitions') + +## AbstractInputProcessor Class + +Абстрактный класс\-обработчик данных, полученных из Архивов Нефиса\. +Класс предназначен для обработки данных с помощью различных обработчиков, +для которых указан атрибут [ProcessorAttribute](ProcessorAttribute.md 'Pf2eDataScrapper\.Processors\.Attributes\.ProcessorAttribute')\. + +```csharp +internal abstract class AbstractInputProcessor : Pf2eDataScrapper.Processors.Definitions.IProcessor +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 AbstractInputProcessor + +Derived +↳ [AbstractEntityProcessor](AbstractEntityProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.AbstractEntityProcessor') +↳ [SkillProcessor](SkillProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Preparation\.SkillProcessor') +↳ [SourceProcessor](SourceProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Preparation\.SourceProcessor') + +Implements [IProcessor](IProcessor.md 'Pf2eDataScrapper\.Processors\.Definitions\.IProcessor') + +### See Also +- [ProcessorAttribute](ProcessorAttribute.md 'Pf2eDataScrapper\.Processors\.Attributes\.ProcessorAttribute') + +| Constructors | | +| :--- | :--- | +| [AbstractInputProcessor\(ProcessorInput\)](AbstractInputProcessor.AbstractInputProcessor(ProcessorInput).md 'Pf2eDataScrapper\.Processors\.Definitions\.AbstractInputProcessor\.AbstractInputProcessor\(Pf2eDataScrapper\.Processors\.ProcessorInput\)') | Абстрактный класс\-обработчик данных, полученных из Архивов Нефиса\. Класс предназначен для обработки данных с помощью различных обработчиков, для которых указан атрибут [ProcessorAttribute](ProcessorAttribute.md 'Pf2eDataScrapper\.Processors\.Attributes\.ProcessorAttribute')\. | + +| Properties | | +| :--- | :--- | +| [Input](AbstractInputProcessor.Input.md 'Pf2eDataScrapper\.Processors\.Definitions\.AbstractInputProcessor\.Input') | Входные данные обработчика\. | + +| Methods | | +| :--- | :--- | +| [Process\(\)](AbstractInputProcessor.Process().md 'Pf2eDataScrapper\.Processors\.Definitions\.AbstractInputProcessor\.Process\(\)') | Основной метод обработки данных\. | +| [Save\(\)](AbstractInputProcessor.Save().md 'Pf2eDataScrapper\.Processors\.Definitions\.AbstractInputProcessor\.Save\(\)') | Метод для сохранения изменений в базе данных\. | diff --git a/Documentation/Pf2eDataScrapper/AbstractProcessorAttribute.AbstractProcessorAttribute(string).md b/Documentation/Pf2eDataScrapper/AbstractProcessorAttribute.AbstractProcessorAttribute(string).md new file mode 100644 index 0000000..9211003 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractProcessorAttribute.AbstractProcessorAttribute(string).md @@ -0,0 +1,15 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Processors\.Attributes](Pf2eDataScrapper.Processors.Attributes.md 'Pf2eDataScrapper\.Processors\.Attributes').[AbstractProcessorAttribute](AbstractProcessorAttribute.md 'Pf2eDataScrapper\.Processors\.Attributes\.AbstractProcessorAttribute') + +## AbstractProcessorAttribute\(string\) Constructor + +Абстрактный аттрибут обработчика\. + +```csharp +public AbstractProcessorAttribute(string name); +``` +#### Parameters + + + +`name` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AbstractProcessorAttribute.Active.md b/Documentation/Pf2eDataScrapper/AbstractProcessorAttribute.Active.md new file mode 100644 index 0000000..97d4d85 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractProcessorAttribute.Active.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Processors\.Attributes](Pf2eDataScrapper.Processors.Attributes.md 'Pf2eDataScrapper\.Processors\.Attributes').[AbstractProcessorAttribute](AbstractProcessorAttribute.md 'Pf2eDataScrapper\.Processors\.Attributes\.AbstractProcessorAttribute') + +## AbstractProcessorAttribute\.Active Property + +Процессор включён по умолчанию\. + +```csharp +public bool Active { get; init; } +``` + +#### Property Value +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AbstractProcessorAttribute.Description.md b/Documentation/Pf2eDataScrapper/AbstractProcessorAttribute.Description.md new file mode 100644 index 0000000..ae46842 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractProcessorAttribute.Description.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Processors\.Attributes](Pf2eDataScrapper.Processors.Attributes.md 'Pf2eDataScrapper\.Processors\.Attributes').[AbstractProcessorAttribute](AbstractProcessorAttribute.md 'Pf2eDataScrapper\.Processors\.Attributes\.AbstractProcessorAttribute') + +## AbstractProcessorAttribute\.Description Property + +Описание обработчика\. + +```csharp +public string Description { get; init; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AbstractProcessorAttribute.Group.md b/Documentation/Pf2eDataScrapper/AbstractProcessorAttribute.Group.md new file mode 100644 index 0000000..95379ed --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractProcessorAttribute.Group.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Processors\.Attributes](Pf2eDataScrapper.Processors.Attributes.md 'Pf2eDataScrapper\.Processors\.Attributes').[AbstractProcessorAttribute](AbstractProcessorAttribute.md 'Pf2eDataScrapper\.Processors\.Attributes\.AbstractProcessorAttribute') + +## AbstractProcessorAttribute\.Group Property + +Группа обработчиков, к которому относится обработчик\. + +```csharp +public Pf2eDataScrapper.Processors.Attributes.ProcessorGroupEnum Group { get; init; } +``` + +#### Property Value +[ProcessorGroupEnum](ProcessorGroupEnum.md 'Pf2eDataScrapper\.Processors\.Attributes\.ProcessorGroupEnum') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AbstractProcessorAttribute.Name.md b/Documentation/Pf2eDataScrapper/AbstractProcessorAttribute.Name.md new file mode 100644 index 0000000..f3821a2 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractProcessorAttribute.Name.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Processors\.Attributes](Pf2eDataScrapper.Processors.Attributes.md 'Pf2eDataScrapper\.Processors\.Attributes').[AbstractProcessorAttribute](AbstractProcessorAttribute.md 'Pf2eDataScrapper\.Processors\.Attributes\.AbstractProcessorAttribute') + +## AbstractProcessorAttribute\.Name Property + +Название обработчика\. + +```csharp +public string Name { get; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AbstractProcessorAttribute.Parallel.md b/Documentation/Pf2eDataScrapper/AbstractProcessorAttribute.Parallel.md new file mode 100644 index 0000000..6e2f601 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractProcessorAttribute.Parallel.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Processors\.Attributes](Pf2eDataScrapper.Processors.Attributes.md 'Pf2eDataScrapper\.Processors\.Attributes').[AbstractProcessorAttribute](AbstractProcessorAttribute.md 'Pf2eDataScrapper\.Processors\.Attributes\.AbstractProcessorAttribute') + +## AbstractProcessorAttribute\.Parallel Property + +Разрешить выполнять процессов в параллельном режиме + +```csharp +public bool Parallel { get; init; } +``` + +#### Property Value +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AbstractProcessorAttribute.md b/Documentation/Pf2eDataScrapper/AbstractProcessorAttribute.md new file mode 100644 index 0000000..4d1d7b7 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractProcessorAttribute.md @@ -0,0 +1,29 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Processors\.Attributes](Pf2eDataScrapper.Processors.Attributes.md 'Pf2eDataScrapper\.Processors\.Attributes') + +## AbstractProcessorAttribute Class + +Абстрактный аттрибут обработчика\. + +```csharp +internal class AbstractProcessorAttribute : System.Attribute +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [System\.Attribute](https://docs.microsoft.com/en-us/dotnet/api/System.Attribute 'System\.Attribute') 🡒 AbstractProcessorAttribute + +Derived +↳ [ProcessorAttribute](ProcessorAttribute.md 'Pf2eDataScrapper\.Processors\.Attributes\.ProcessorAttribute') +↳ [ProcessorCollectionAttribute](ProcessorCollectionAttribute.md 'Pf2eDataScrapper\.Processors\.Attributes\.ProcessorCollectionAttribute') +↳ [ProcessorFactoryAttribute](ProcessorFactoryAttribute.md 'Pf2eDataScrapper\.Processors\.Attributes\.ProcessorFactoryAttribute') + +| Constructors | | +| :--- | :--- | +| [AbstractProcessorAttribute\(string\)](AbstractProcessorAttribute.AbstractProcessorAttribute(string).md 'Pf2eDataScrapper\.Processors\.Attributes\.AbstractProcessorAttribute\.AbstractProcessorAttribute\(string\)') | Абстрактный аттрибут обработчика\. | + +| Properties | | +| :--- | :--- | +| [Active](AbstractProcessorAttribute.Active.md 'Pf2eDataScrapper\.Processors\.Attributes\.AbstractProcessorAttribute\.Active') | Процессор включён по умолчанию\. | +| [Description](AbstractProcessorAttribute.Description.md 'Pf2eDataScrapper\.Processors\.Attributes\.AbstractProcessorAttribute\.Description') | Описание обработчика\. | +| [Group](AbstractProcessorAttribute.Group.md 'Pf2eDataScrapper\.Processors\.Attributes\.AbstractProcessorAttribute\.Group') | Группа обработчиков, к которому относится обработчик\. | +| [Name](AbstractProcessorAttribute.Name.md 'Pf2eDataScrapper\.Processors\.Attributes\.AbstractProcessorAttribute\.Name') | Название обработчика\. | +| [Parallel](AbstractProcessorAttribute.Parallel.md 'Pf2eDataScrapper\.Processors\.Attributes\.AbstractProcessorAttribute\.Parallel') | Разрешить выполнять процессов в параллельном режиме | diff --git a/Documentation/Pf2eDataScrapper/AbstractProcessorFactory.Count().md b/Documentation/Pf2eDataScrapper/AbstractProcessorFactory.Count().md new file mode 100644 index 0000000..26fbb70 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractProcessorFactory.Count().md @@ -0,0 +1,14 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Processors\.Factory](Pf2eDataScrapper.Processors.Factory.md 'Pf2eDataScrapper\.Processors\.Factory').[AbstractProcessorFactory](AbstractProcessorFactory.md 'Pf2eDataScrapper\.Processors\.Factory\.AbstractProcessorFactory') + +## AbstractProcessorFactory\.Count\(\) Method + +Количество элеметов для итерирования\. + +```csharp +public abstract int Count(); +``` + +#### Returns +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') +Количество элеметов \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AbstractProcessorFactory.GetEnumerator().md b/Documentation/Pf2eDataScrapper/AbstractProcessorFactory.GetEnumerator().md new file mode 100644 index 0000000..ecfc133 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractProcessorFactory.GetEnumerator().md @@ -0,0 +1,14 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Processors\.Factory](Pf2eDataScrapper.Processors.Factory.md 'Pf2eDataScrapper\.Processors\.Factory').[AbstractProcessorFactory](AbstractProcessorFactory.md 'Pf2eDataScrapper\.Processors\.Factory\.AbstractProcessorFactory') + +## AbstractProcessorFactory\.GetEnumerator\(\) Method + +Итератор процессоров\. + +```csharp +public abstract System.Collections.Generic.IEnumerable> GetEnumerator(); +``` + +#### Returns +[System\.Collections\.Generic\.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System\.Collections\.Generic\.IEnumerable\`1')[System\.Tuple<](https://docs.microsoft.com/en-us/dotnet/api/System.Tuple-2 'System\.Tuple\`2')[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Tuple-2 'System\.Tuple\`2')[IProcessor](IProcessor.md 'Pf2eDataScrapper\.Processors\.Definitions\.IProcessor')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Tuple-2 'System\.Tuple\`2')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System\.Collections\.Generic\.IEnumerable\`1') +Пара значений: \[0\] \- описание элемента процессор, \[1\] \- процессор\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AbstractProcessorFactory.Prepare().md b/Documentation/Pf2eDataScrapper/AbstractProcessorFactory.Prepare().md new file mode 100644 index 0000000..90f7cda --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractProcessorFactory.Prepare().md @@ -0,0 +1,10 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Processors\.Factory](Pf2eDataScrapper.Processors.Factory.md 'Pf2eDataScrapper\.Processors\.Factory').[AbstractProcessorFactory](AbstractProcessorFactory.md 'Pf2eDataScrapper\.Processors\.Factory\.AbstractProcessorFactory') + +## AbstractProcessorFactory\.Prepare\(\) Method + +Подготовить фабрику к работе\. + +```csharp +public virtual void Prepare(); +``` \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AbstractProcessorFactory.md b/Documentation/Pf2eDataScrapper/AbstractProcessorFactory.md new file mode 100644 index 0000000..344b604 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractProcessorFactory.md @@ -0,0 +1,18 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Processors\.Factory](Pf2eDataScrapper.Processors.Factory.md 'Pf2eDataScrapper\.Processors\.Factory') + +## AbstractProcessorFactory Class + +Абстрактная фабрика создания процессоров\. + +```csharp +internal abstract class AbstractProcessorFactory +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 AbstractProcessorFactory + +| Methods | | +| :--- | :--- | +| [Count\(\)](AbstractProcessorFactory.Count().md 'Pf2eDataScrapper\.Processors\.Factory\.AbstractProcessorFactory\.Count\(\)') | Количество элеметов для итерирования\. | +| [GetEnumerator\(\)](AbstractProcessorFactory.GetEnumerator().md 'Pf2eDataScrapper\.Processors\.Factory\.AbstractProcessorFactory\.GetEnumerator\(\)') | Итератор процессоров\. | +| [Prepare\(\)](AbstractProcessorFactory.Prepare().md 'Pf2eDataScrapper\.Processors\.Factory\.AbstractProcessorFactory\.Prepare\(\)') | Подготовить фабрику к работе\. | diff --git a/Documentation/Pf2eDataScrapper/AbstractSchemaBuildProcessor.Compendium.md b/Documentation/Pf2eDataScrapper/AbstractSchemaBuildProcessor.Compendium.md new file mode 100644 index 0000000..1402ba6 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractSchemaBuildProcessor.Compendium.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder](Pf2eDataScrapper.SchemaBuilder.md 'Pf2eDataScrapper\.SchemaBuilder').[AbstractSchemaBuildProcessor](AbstractSchemaBuildProcessor.md 'Pf2eDataScrapper\.SchemaBuilder\.AbstractSchemaBuildProcessor') + +## AbstractSchemaBuildProcessor\.Compendium Property + +Связаный компендиум + +```csharp +protected abstract Pf2eDataScrapper.Importers.AbstractCompendium Compendium { protected get; } +``` + +#### Property Value +[AbstractCompendium](AbstractCompendium.md 'Pf2eDataScrapper\.Importers\.AbstractCompendium') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AbstractSchemaBuildProcessor.GetSchemaNodes(AbstractCompendiumItem).md b/Documentation/Pf2eDataScrapper/AbstractSchemaBuildProcessor.GetSchemaNodes(AbstractCompendiumItem).md new file mode 100644 index 0000000..f4995ff --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractSchemaBuildProcessor.GetSchemaNodes(AbstractCompendiumItem).md @@ -0,0 +1,21 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder](Pf2eDataScrapper.SchemaBuilder.md 'Pf2eDataScrapper\.SchemaBuilder').[AbstractSchemaBuildProcessor](AbstractSchemaBuildProcessor.md 'Pf2eDataScrapper\.SchemaBuilder\.AbstractSchemaBuildProcessor') + +## AbstractSchemaBuildProcessor\.GetSchemaNodes\(AbstractCompendiumItem\) Method + +Получить список названий элементов структуры данных на основе вводимого элемента\. + +```csharp +protected abstract System.Collections.Generic.ICollection GetSchemaNodes(Pf2eDataScrapper.Importers.AbstractCompendiumItem item); +``` +#### Parameters + + + +`item` [AbstractCompendiumItem](AbstractCompendiumItem.md 'Pf2eDataScrapper\.Importers\.AbstractCompendiumItem') + +Вводимый элемент + +#### Returns +[System\.Collections\.Generic\.ICollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1')[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1') +Коллекция названий элементов структуры данных/ \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AbstractSchemaBuildProcessor.Process().md b/Documentation/Pf2eDataScrapper/AbstractSchemaBuildProcessor.Process().md new file mode 100644 index 0000000..df827ca --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractSchemaBuildProcessor.Process().md @@ -0,0 +1,12 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder](Pf2eDataScrapper.SchemaBuilder.md 'Pf2eDataScrapper\.SchemaBuilder').[AbstractSchemaBuildProcessor](AbstractSchemaBuildProcessor.md 'Pf2eDataScrapper\.SchemaBuilder\.AbstractSchemaBuildProcessor') + +## AbstractSchemaBuildProcessor\.Process\(\) Method + +Построение схемы данных\. + +```csharp +public void Process(); +``` + +Implements [Process\(\)](IProcessor.Process().md 'Pf2eDataScrapper\.Processors\.Definitions\.IProcessor\.Process\(\)') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AbstractSchemaBuildProcessor.Resolver.md b/Documentation/Pf2eDataScrapper/AbstractSchemaBuildProcessor.Resolver.md new file mode 100644 index 0000000..816b4cd --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractSchemaBuildProcessor.Resolver.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder](Pf2eDataScrapper.SchemaBuilder.md 'Pf2eDataScrapper\.SchemaBuilder').[AbstractSchemaBuildProcessor](AbstractSchemaBuildProcessor.md 'Pf2eDataScrapper\.SchemaBuilder\.AbstractSchemaBuildProcessor') + +## AbstractSchemaBuildProcessor\.Resolver Property + +Определитель типов данных\. + +```csharp +protected abstract Pf2eDataScrapper.SchemaBuilder.TypeResolver Resolver { protected get; } +``` + +#### Property Value +[TypeResolver](TypeResolver.md 'Pf2eDataScrapper\.SchemaBuilder\.TypeResolver') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AbstractSchemaBuildProcessor.Save().md b/Documentation/Pf2eDataScrapper/AbstractSchemaBuildProcessor.Save().md new file mode 100644 index 0000000..f6a05a6 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractSchemaBuildProcessor.Save().md @@ -0,0 +1,12 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder](Pf2eDataScrapper.SchemaBuilder.md 'Pf2eDataScrapper\.SchemaBuilder').[AbstractSchemaBuildProcessor](AbstractSchemaBuildProcessor.md 'Pf2eDataScrapper\.SchemaBuilder\.AbstractSchemaBuildProcessor') + +## AbstractSchemaBuildProcessor\.Save\(\) Method + +Сохранение постренных схем данных\. + +```csharp +public void Save(); +``` + +Implements [Save\(\)](IProcessor.Save().md 'Pf2eDataScrapper\.Processors\.Definitions\.IProcessor\.Save\(\)') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AbstractSchemaBuildProcessor.SavePath.md b/Documentation/Pf2eDataScrapper/AbstractSchemaBuildProcessor.SavePath.md new file mode 100644 index 0000000..6347e44 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractSchemaBuildProcessor.SavePath.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder](Pf2eDataScrapper.SchemaBuilder.md 'Pf2eDataScrapper\.SchemaBuilder').[AbstractSchemaBuildProcessor](AbstractSchemaBuildProcessor.md 'Pf2eDataScrapper\.SchemaBuilder\.AbstractSchemaBuildProcessor') + +## AbstractSchemaBuildProcessor\.SavePath Property + +Путь к каталогу для сохранения вывода\. + +```csharp +protected abstract string SavePath { protected get; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AbstractSchemaBuildProcessor.SaveSchema(string,string,SchemaNode).md b/Documentation/Pf2eDataScrapper/AbstractSchemaBuildProcessor.SaveSchema(string,string,SchemaNode).md new file mode 100644 index 0000000..3bc383a --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractSchemaBuildProcessor.SaveSchema(string,string,SchemaNode).md @@ -0,0 +1,29 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder](Pf2eDataScrapper.SchemaBuilder.md 'Pf2eDataScrapper\.SchemaBuilder').[AbstractSchemaBuildProcessor](AbstractSchemaBuildProcessor.md 'Pf2eDataScrapper\.SchemaBuilder\.AbstractSchemaBuildProcessor') + +## AbstractSchemaBuildProcessor\.SaveSchema\(string, string, SchemaNode\) Method + +Сохранение отдельной схемы данных\. + +```csharp +protected void SaveSchema(string dir, string name, Pf2eDataScrapper.SchemaBuilder.SchemaNode schema); +``` +#### Parameters + + + +`dir` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +Целевой каталог\. + + + +`name` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +Название схемы\. + + + +`schema` [SchemaNode](SchemaNode.md 'Pf2eDataScrapper\.SchemaBuilder\.SchemaNode') + +Сохраняемая схема\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AbstractSchemaBuildProcessor.Schemas.md b/Documentation/Pf2eDataScrapper/AbstractSchemaBuildProcessor.Schemas.md new file mode 100644 index 0000000..5145da0 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractSchemaBuildProcessor.Schemas.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder](Pf2eDataScrapper.SchemaBuilder.md 'Pf2eDataScrapper\.SchemaBuilder').[AbstractSchemaBuildProcessor](AbstractSchemaBuildProcessor.md 'Pf2eDataScrapper\.SchemaBuilder\.AbstractSchemaBuildProcessor') + +## AbstractSchemaBuildProcessor\.Schemas Property + +Набор схем данных\. + +```csharp +protected System.Collections.Generic.Dictionary Schemas { protected get; } +``` + +#### Property Value +[System\.Collections\.Generic\.Dictionary<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.Dictionary-2 'System\.Collections\.Generic\.Dictionary\`2')[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.Dictionary-2 'System\.Collections\.Generic\.Dictionary\`2')[SchemaNode](SchemaNode.md 'Pf2eDataScrapper\.SchemaBuilder\.SchemaNode')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.Dictionary-2 'System\.Collections\.Generic\.Dictionary\`2') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AbstractSchemaBuildProcessor.md b/Documentation/Pf2eDataScrapper/AbstractSchemaBuildProcessor.md new file mode 100644 index 0000000..b9ec5ce --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractSchemaBuildProcessor.md @@ -0,0 +1,30 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder](Pf2eDataScrapper.SchemaBuilder.md 'Pf2eDataScrapper\.SchemaBuilder') + +## AbstractSchemaBuildProcessor Class + +```csharp +internal abstract class AbstractSchemaBuildProcessor : Pf2eDataScrapper.Processors.Definitions.IProcessor +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 AbstractSchemaBuildProcessor + +Derived +↳ [SchemaBuildProcessor](SchemaBuildProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Preparation\.SchemaBuildProcessor') +↳ [SchemaBuildProcessor](SchemaBuildProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Processors\.Preparation\.SchemaBuildProcessor') + +Implements [IProcessor](IProcessor.md 'Pf2eDataScrapper\.Processors\.Definitions\.IProcessor') + +| Properties | | +| :--- | :--- | +| [Compendium](AbstractSchemaBuildProcessor.Compendium.md 'Pf2eDataScrapper\.SchemaBuilder\.AbstractSchemaBuildProcessor\.Compendium') | Связаный компендиум | +| [Resolver](AbstractSchemaBuildProcessor.Resolver.md 'Pf2eDataScrapper\.SchemaBuilder\.AbstractSchemaBuildProcessor\.Resolver') | Определитель типов данных\. | +| [SavePath](AbstractSchemaBuildProcessor.SavePath.md 'Pf2eDataScrapper\.SchemaBuilder\.AbstractSchemaBuildProcessor\.SavePath') | Путь к каталогу для сохранения вывода\. | +| [Schemas](AbstractSchemaBuildProcessor.Schemas.md 'Pf2eDataScrapper\.SchemaBuilder\.AbstractSchemaBuildProcessor\.Schemas') | Набор схем данных\. | + +| Methods | | +| :--- | :--- | +| [GetSchemaNodes\(AbstractCompendiumItem\)](AbstractSchemaBuildProcessor.GetSchemaNodes(AbstractCompendiumItem).md 'Pf2eDataScrapper\.SchemaBuilder\.AbstractSchemaBuildProcessor\.GetSchemaNodes\(Pf2eDataScrapper\.Importers\.AbstractCompendiumItem\)') | Получить список названий элементов структуры данных на основе вводимого элемента\. | +| [Process\(\)](AbstractSchemaBuildProcessor.Process().md 'Pf2eDataScrapper\.SchemaBuilder\.AbstractSchemaBuildProcessor\.Process\(\)') | Построение схемы данных\. | +| [Save\(\)](AbstractSchemaBuildProcessor.Save().md 'Pf2eDataScrapper\.SchemaBuilder\.AbstractSchemaBuildProcessor\.Save\(\)') | Сохранение постренных схем данных\. | +| [SaveSchema\(string, string, SchemaNode\)](AbstractSchemaBuildProcessor.SaveSchema(string,string,SchemaNode).md 'Pf2eDataScrapper\.SchemaBuilder\.AbstractSchemaBuildProcessor\.SaveSchema\(string, string, Pf2eDataScrapper\.SchemaBuilder\.SchemaNode\)') | Сохранение отдельной схемы данных\. | diff --git a/Documentation/Pf2eDataScrapper/AbstractSchemaType.AbstractSchemaType(SchemaNode).md b/Documentation/Pf2eDataScrapper/AbstractSchemaType.AbstractSchemaType(SchemaNode).md new file mode 100644 index 0000000..77fd7c9 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractSchemaType.AbstractSchemaType(SchemaNode).md @@ -0,0 +1,17 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder\.Types](Pf2eDataScrapper.SchemaBuilder.Types.md 'Pf2eDataScrapper\.SchemaBuilder\.Types').[AbstractSchemaType](AbstractSchemaType.md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.AbstractSchemaType') + +## AbstractSchemaType\(SchemaNode\) Constructor + +Абстрактный тип представоления данных в схеме\. + +```csharp +protected AbstractSchemaType(Pf2eDataScrapper.SchemaBuilder.SchemaNode parent); +``` +#### Parameters + + + +`parent` [SchemaNode](SchemaNode.md 'Pf2eDataScrapper\.SchemaBuilder\.SchemaNode') + +Элемент, к которому добавляется тип\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AbstractSchemaType.AddValue(JToken).md b/Documentation/Pf2eDataScrapper/AbstractSchemaType.AddValue(JToken).md new file mode 100644 index 0000000..ad82559 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractSchemaType.AddValue(JToken).md @@ -0,0 +1,17 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder\.Types](Pf2eDataScrapper.SchemaBuilder.Types.md 'Pf2eDataScrapper\.SchemaBuilder\.Types').[AbstractSchemaType](AbstractSchemaType.md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.AbstractSchemaType') + +## AbstractSchemaType\.AddValue\(JToken\) Method + +Добавление нового значения\. + +```csharp +public abstract void AddValue(Newtonsoft.Json.Linq.JToken value); +``` +#### Parameters + + + +`value` [Newtonsoft\.Json\.Linq\.JToken](https://docs.microsoft.com/en-us/dotnet/api/Newtonsoft.Json.Linq.JToken 'Newtonsoft\.Json\.Linq\.JToken') + +Новое значение\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AbstractSchemaType.Beautify().md b/Documentation/Pf2eDataScrapper/AbstractSchemaType.Beautify().md new file mode 100644 index 0000000..a20c0c0 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractSchemaType.Beautify().md @@ -0,0 +1,10 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder\.Types](Pf2eDataScrapper.SchemaBuilder.Types.md 'Pf2eDataScrapper\.SchemaBuilder\.Types').[AbstractSchemaType](AbstractSchemaType.md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.AbstractSchemaType') + +## AbstractSchemaType\.Beautify\(\) Method + +Подготовка типа к красивому представлению\. + +```csharp +public abstract void Beautify(); +``` \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AbstractSchemaType.GetTypeName().md b/Documentation/Pf2eDataScrapper/AbstractSchemaType.GetTypeName().md new file mode 100644 index 0000000..dbf0acd --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractSchemaType.GetTypeName().md @@ -0,0 +1,14 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder\.Types](Pf2eDataScrapper.SchemaBuilder.Types.md 'Pf2eDataScrapper\.SchemaBuilder\.Types').[AbstractSchemaType](AbstractSchemaType.md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.AbstractSchemaType') + +## AbstractSchemaType\.GetTypeName\(\) Method + +Получение строкового представоения типа элемента\. + +```csharp +public abstract string GetTypeName(); +``` + +#### Returns +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') +Строковое представоение типа элемента \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AbstractSchemaType.GetYamlData().md b/Documentation/Pf2eDataScrapper/AbstractSchemaType.GetYamlData().md new file mode 100644 index 0000000..af09bc4 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractSchemaType.GetYamlData().md @@ -0,0 +1,14 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder\.Types](Pf2eDataScrapper.SchemaBuilder.Types.md 'Pf2eDataScrapper\.SchemaBuilder\.Types').[AbstractSchemaType](AbstractSchemaType.md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.AbstractSchemaType') + +## AbstractSchemaType\.GetYamlData\(\) Method + +Получение данных для форматирования в YAML\. + +```csharp +public abstract System.Collections.Generic.Dictionary GetYamlData(); +``` + +#### Returns +[System\.Collections\.Generic\.Dictionary<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.Dictionary-2 'System\.Collections\.Generic\.Dictionary\`2')[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.Dictionary-2 'System\.Collections\.Generic\.Dictionary\`2')[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.Dictionary-2 'System\.Collections\.Generic\.Dictionary\`2') +Словарь данных \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AbstractSchemaType.IsCompatibleValue(JToken).md b/Documentation/Pf2eDataScrapper/AbstractSchemaType.IsCompatibleValue(JToken).md new file mode 100644 index 0000000..d6557c9 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractSchemaType.IsCompatibleValue(JToken).md @@ -0,0 +1,21 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder\.Types](Pf2eDataScrapper.SchemaBuilder.Types.md 'Pf2eDataScrapper\.SchemaBuilder\.Types').[AbstractSchemaType](AbstractSchemaType.md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.AbstractSchemaType') + +## AbstractSchemaType\.IsCompatibleValue\(JToken\) Method + +Проверка, что значение совместимо с текущим типом\. + +```csharp +public abstract bool IsCompatibleValue(Newtonsoft.Json.Linq.JToken value); +``` +#### Parameters + + + +`value` [Newtonsoft\.Json\.Linq\.JToken](https://docs.microsoft.com/en-us/dotnet/api/Newtonsoft.Json.Linq.JToken 'Newtonsoft\.Json\.Linq\.JToken') + +Проверяемое значение\. + +#### Returns +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') +\`true\`, если значение совместимо с текущим типом\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AbstractSchemaType.Parent.md b/Documentation/Pf2eDataScrapper/AbstractSchemaType.Parent.md new file mode 100644 index 0000000..160dcd3 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractSchemaType.Parent.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder\.Types](Pf2eDataScrapper.SchemaBuilder.Types.md 'Pf2eDataScrapper\.SchemaBuilder\.Types').[AbstractSchemaType](AbstractSchemaType.md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.AbstractSchemaType') + +## AbstractSchemaType\.Parent Field + +Элемент схемы данных, к которому относится тип\. + +```csharp +public readonly SchemaNode Parent; +``` + +#### Field Value +[SchemaNode](SchemaNode.md 'Pf2eDataScrapper\.SchemaBuilder\.SchemaNode') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AbstractSchemaType.Resolver.md b/Documentation/Pf2eDataScrapper/AbstractSchemaType.Resolver.md new file mode 100644 index 0000000..e391197 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractSchemaType.Resolver.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder\.Types](Pf2eDataScrapper.SchemaBuilder.Types.md 'Pf2eDataScrapper\.SchemaBuilder\.Types').[AbstractSchemaType](AbstractSchemaType.md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.AbstractSchemaType') + +## AbstractSchemaType\.Resolver Property + +Объект для определения типа поля в схеме данных\. + +```csharp +public Pf2eDataScrapper.SchemaBuilder.TypeResolver Resolver { get; } +``` + +#### Property Value +[TypeResolver](TypeResolver.md 'Pf2eDataScrapper\.SchemaBuilder\.TypeResolver') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AbstractSchemaType.Root.md b/Documentation/Pf2eDataScrapper/AbstractSchemaType.Root.md new file mode 100644 index 0000000..c0c312b --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractSchemaType.Root.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder\.Types](Pf2eDataScrapper.SchemaBuilder.Types.md 'Pf2eDataScrapper\.SchemaBuilder\.Types').[AbstractSchemaType](AbstractSchemaType.md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.AbstractSchemaType') + +## AbstractSchemaType\.Root Property + +Корневой элемент схемы данных\. + +```csharp +public Pf2eDataScrapper.SchemaBuilder.SchemaNode Root { get; } +``` + +#### Property Value +[SchemaNode](SchemaNode.md 'Pf2eDataScrapper\.SchemaBuilder\.SchemaNode') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AbstractSchemaType.ToString().md b/Documentation/Pf2eDataScrapper/AbstractSchemaType.ToString().md new file mode 100644 index 0000000..4f6f664 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractSchemaType.ToString().md @@ -0,0 +1,14 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder\.Types](Pf2eDataScrapper.SchemaBuilder.Types.md 'Pf2eDataScrapper\.SchemaBuilder\.Types').[AbstractSchemaType](AbstractSchemaType.md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.AbstractSchemaType') + +## AbstractSchemaType\.ToString\(\) Method + +Полное строковое представление элемента\. + +```csharp +public override string ToString(); +``` + +#### Returns +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') +Строковое представление элемента\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AbstractSchemaType.md b/Documentation/Pf2eDataScrapper/AbstractSchemaType.md new file mode 100644 index 0000000..91481a9 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractSchemaType.md @@ -0,0 +1,41 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder\.Types](Pf2eDataScrapper.SchemaBuilder.Types.md 'Pf2eDataScrapper\.SchemaBuilder\.Types') + +## AbstractSchemaType Class + +Абстрактный тип представоления данных в схеме\. + +```csharp +internal abstract class AbstractSchemaType +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 AbstractSchemaType + +Derived +↳ [ArraySchemaType](ArraySchemaType.md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.ArraySchemaType') +↳ [DictionarySchemaType](DictionarySchemaType.md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.DictionarySchemaType') +↳ [IgnoreSchemaType](IgnoreSchemaType.md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.IgnoreSchemaType') +↳ [ObjectSchemaType](ObjectSchemaType.md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.ObjectSchemaType') +↳ [StaticSchemaType](StaticSchemaType.md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.StaticSchemaType') + +| Constructors | | +| :--- | :--- | +| [AbstractSchemaType\(SchemaNode\)](AbstractSchemaType.AbstractSchemaType(SchemaNode).md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.AbstractSchemaType\.AbstractSchemaType\(Pf2eDataScrapper\.SchemaBuilder\.SchemaNode\)') | Абстрактный тип представоления данных в схеме\. | + +| Fields | | +| :--- | :--- | +| [Parent](AbstractSchemaType.Parent.md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.AbstractSchemaType\.Parent') | Элемент схемы данных, к которому относится тип\. | + +| Properties | | +| :--- | :--- | +| [Resolver](AbstractSchemaType.Resolver.md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.AbstractSchemaType\.Resolver') | Объект для определения типа поля в схеме данных\. | +| [Root](AbstractSchemaType.Root.md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.AbstractSchemaType\.Root') | Корневой элемент схемы данных\. | + +| Methods | | +| :--- | :--- | +| [AddValue\(JToken\)](AbstractSchemaType.AddValue(JToken).md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.AbstractSchemaType\.AddValue\(Newtonsoft\.Json\.Linq\.JToken\)') | Добавление нового значения\. | +| [Beautify\(\)](AbstractSchemaType.Beautify().md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.AbstractSchemaType\.Beautify\(\)') | Подготовка типа к красивому представлению\. | +| [GetTypeName\(\)](AbstractSchemaType.GetTypeName().md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.AbstractSchemaType\.GetTypeName\(\)') | Получение строкового представоения типа элемента\. | +| [GetYamlData\(\)](AbstractSchemaType.GetYamlData().md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.AbstractSchemaType\.GetYamlData\(\)') | Получение данных для форматирования в YAML\. | +| [IsCompatibleValue\(JToken\)](AbstractSchemaType.IsCompatibleValue(JToken).md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.AbstractSchemaType\.IsCompatibleValue\(Newtonsoft\.Json\.Linq\.JToken\)') | Проверка, что значение совместимо с текущим типом\. | +| [ToString\(\)](AbstractSchemaType.ToString().md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.AbstractSchemaType\.ToString\(\)') | Полное строковое представление элемента\. | diff --git a/Documentation/Pf2eDataScrapper/AbstractSimpleProcessor.Process().md b/Documentation/Pf2eDataScrapper/AbstractSimpleProcessor.Process().md new file mode 100644 index 0000000..162813c --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractSimpleProcessor.Process().md @@ -0,0 +1,12 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Processors\.Definitions](Pf2eDataScrapper.Processors.Definitions.md 'Pf2eDataScrapper\.Processors\.Definitions').[AbstractSimpleProcessor](AbstractSimpleProcessor.md 'Pf2eDataScrapper\.Processors\.Definitions\.AbstractSimpleProcessor') + +## AbstractSimpleProcessor\.Process\(\) Method + +Основной метод обработки данных\. + +```csharp +public abstract void Process(); +``` + +Implements [Process\(\)](IProcessor.Process().md 'Pf2eDataScrapper\.Processors\.Definitions\.IProcessor\.Process\(\)') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AbstractSimpleProcessor.Save().md b/Documentation/Pf2eDataScrapper/AbstractSimpleProcessor.Save().md new file mode 100644 index 0000000..e0dd1b0 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractSimpleProcessor.Save().md @@ -0,0 +1,12 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Processors\.Definitions](Pf2eDataScrapper.Processors.Definitions.md 'Pf2eDataScrapper\.Processors\.Definitions').[AbstractSimpleProcessor](AbstractSimpleProcessor.md 'Pf2eDataScrapper\.Processors\.Definitions\.AbstractSimpleProcessor') + +## AbstractSimpleProcessor\.Save\(\) Method + +Метод для сохранения изменений в базе данных\. + +```csharp +public abstract void Save(); +``` + +Implements [Save\(\)](IProcessor.Save().md 'Pf2eDataScrapper\.Processors\.Definitions\.IProcessor\.Save\(\)') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AbstractSimpleProcessor.md b/Documentation/Pf2eDataScrapper/AbstractSimpleProcessor.md new file mode 100644 index 0000000..4034f85 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractSimpleProcessor.md @@ -0,0 +1,24 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Processors\.Definitions](Pf2eDataScrapper.Processors.Definitions.md 'Pf2eDataScrapper\.Processors\.Definitions') + +## AbstractSimpleProcessor Class + +Абстрактный класс\-обработчик данных, полученных из Архивов Нефиса\. +Класс предназначен для обработки данных с помощью различных обработчиков, +для которых указан атрибут [ProcessorAttribute](ProcessorAttribute.md 'Pf2eDataScrapper\.Processors\.Attributes\.ProcessorAttribute')\. + +```csharp +internal abstract class AbstractSimpleProcessor : Pf2eDataScrapper.Processors.Definitions.IProcessor +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 AbstractSimpleProcessor + +Implements [IProcessor](IProcessor.md 'Pf2eDataScrapper\.Processors\.Definitions\.IProcessor') + +### See Also +- [ProcessorAttribute](ProcessorAttribute.md 'Pf2eDataScrapper\.Processors\.Attributes\.ProcessorAttribute') + +| Methods | | +| :--- | :--- | +| [Process\(\)](AbstractSimpleProcessor.Process().md 'Pf2eDataScrapper\.Processors\.Definitions\.AbstractSimpleProcessor\.Process\(\)') | Основной метод обработки данных\. | +| [Save\(\)](AbstractSimpleProcessor.Save().md 'Pf2eDataScrapper\.Processors\.Definitions\.AbstractSimpleProcessor\.Save\(\)') | Метод для сохранения изменений в базе данных\. | diff --git a/Documentation/Pf2eDataScrapper/AbstractSubclassProcessor.AbstractSubclassProcessor(ProcessorInput,StringHelper,DatabaseHelper,AonprdBuilderGlobals).md b/Documentation/Pf2eDataScrapper/AbstractSubclassProcessor.AbstractSubclassProcessor(ProcessorInput,StringHelper,DatabaseHelper,AonprdBuilderGlobals).md new file mode 100644 index 0000000..147bdd1 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractSubclassProcessor.AbstractSubclassProcessor(ProcessorInput,StringHelper,DatabaseHelper,AonprdBuilderGlobals).md @@ -0,0 +1,29 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors').[AbstractSubclassProcessor](AbstractSubclassProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.AbstractSubclassProcessor') + +## AbstractSubclassProcessor\(ProcessorInput, StringHelper, DatabaseHelper, AonprdBuilderGlobals\) Constructor + +Абстрактный класс\-обработчик сущностей подклассов, полученных из Архивов Нефиса\. +Класс предназначен для обработки данных с помощью различных обработчиков, +для которых указан атрибут [ProcessorAttribute](ProcessorAttribute.md 'Pf2eDataScrapper\.Processors\.Attributes\.ProcessorAttribute')\. + +```csharp +protected AbstractSubclassProcessor(Pf2eDataScrapper.Processors.ProcessorInput input, Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.StringHelper stringHelper, Pf2eDataScrapper.Helpers.DatabaseHelper helper, Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.AonprdBuilderGlobals globals); +``` +#### Parameters + + + +`input` [ProcessorInput](ProcessorInput.md 'Pf2eDataScrapper\.Processors\.ProcessorInput') + + + +`stringHelper` [StringHelper](StringHelper.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.StringHelper') + + + +`helper` [DatabaseHelper](DatabaseHelper.md 'Pf2eDataScrapper\.Helpers\.DatabaseHelper') + + + +`globals` [AonprdBuilderGlobals](AonprdBuilderGlobals.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.AonprdBuilderGlobals') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AbstractSubclassProcessor.Add().md b/Documentation/Pf2eDataScrapper/AbstractSubclassProcessor.Add().md new file mode 100644 index 0000000..a5237cb --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractSubclassProcessor.Add().md @@ -0,0 +1,10 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors').[AbstractSubclassProcessor](AbstractSubclassProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.AbstractSubclassProcessor') + +## AbstractSubclassProcessor\.Add\(\) Method + +Добавление основной сущности в контекст базы данных\. + +```csharp +protected override void Add(); +``` \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AbstractSubclassProcessor.ClassName.md b/Documentation/Pf2eDataScrapper/AbstractSubclassProcessor.ClassName.md new file mode 100644 index 0000000..cc3f45f --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractSubclassProcessor.ClassName.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors').[AbstractSubclassProcessor](AbstractSubclassProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.AbstractSubclassProcessor') + +## AbstractSubclassProcessor\.ClassName Property + +Название подкласса\. + +```csharp +public abstract string? ClassName { get; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AbstractSubclassProcessor.GetGroup().md b/Documentation/Pf2eDataScrapper/AbstractSubclassProcessor.GetGroup().md new file mode 100644 index 0000000..ad78202 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractSubclassProcessor.GetGroup().md @@ -0,0 +1,14 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors').[AbstractSubclassProcessor](AbstractSubclassProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.AbstractSubclassProcessor') + +## AbstractSubclassProcessor\.GetGroup\(\) Method + +Получение CLR\-представления группы подклассов, к которому относится обрабатываемый подкласс\. + +```csharp +public Pf2eModel.Model.Structure.SubclassGroup GetGroup(); +``` + +#### Returns +[Pf2eModel\.Model\.Structure\.SubclassGroup](https://docs.microsoft.com/en-us/dotnet/api/Pf2eModel.Model.Structure.SubclassGroup 'Pf2eModel\.Model\.Structure\.SubclassGroup') +CLR\-представления группы подклассов\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AbstractSubclassProcessor.GroupName.md b/Documentation/Pf2eDataScrapper/AbstractSubclassProcessor.GroupName.md new file mode 100644 index 0000000..335d697 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractSubclassProcessor.GroupName.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors').[AbstractSubclassProcessor](AbstractSubclassProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.AbstractSubclassProcessor') + +## AbstractSubclassProcessor\.GroupName Property + +Название группы подклассов\. + +```csharp +public abstract string GroupName { get; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AbstractSubclassProcessor.Object.md b/Documentation/Pf2eDataScrapper/AbstractSubclassProcessor.Object.md new file mode 100644 index 0000000..cbe46bd --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractSubclassProcessor.Object.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors').[AbstractSubclassProcessor](AbstractSubclassProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.AbstractSubclassProcessor') + +## AbstractSubclassProcessor\.Object Property + +Основная сущность\. + +```csharp +public abstract Pf2eModel.Model.Structure.Subclass Object { get; } +``` + +#### Property Value +[Pf2eModel\.Model\.Structure\.Subclass](https://docs.microsoft.com/en-us/dotnet/api/Pf2eModel.Model.Structure.Subclass 'Pf2eModel\.Model\.Structure\.Subclass') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AbstractSubclassProcessor.Process().md b/Documentation/Pf2eDataScrapper/AbstractSubclassProcessor.Process().md new file mode 100644 index 0000000..7cd23fb --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractSubclassProcessor.Process().md @@ -0,0 +1,12 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors').[AbstractSubclassProcessor](AbstractSubclassProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.AbstractSubclassProcessor') + +## AbstractSubclassProcessor\.Process\(\) Method + +Основной метод обработки данных\. + +```csharp +public override void Process(); +``` + +Implements [Process\(\)](IProcessor.Process().md 'Pf2eDataScrapper\.Processors\.Definitions\.IProcessor\.Process\(\)') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AbstractSubclassProcessor.ProcessObject().md b/Documentation/Pf2eDataScrapper/AbstractSubclassProcessor.ProcessObject().md new file mode 100644 index 0000000..acaed7b --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractSubclassProcessor.ProcessObject().md @@ -0,0 +1,10 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors').[AbstractSubclassProcessor](AbstractSubclassProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.AbstractSubclassProcessor') + +## AbstractSubclassProcessor\.ProcessObject\(\) Method + +Обработка полей подкласса\. + +```csharp +public abstract void ProcessObject(); +``` \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AbstractSubclassProcessor.Type.md b/Documentation/Pf2eDataScrapper/AbstractSubclassProcessor.Type.md new file mode 100644 index 0000000..09d8443 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractSubclassProcessor.Type.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors').[AbstractSubclassProcessor](AbstractSubclassProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.AbstractSubclassProcessor') + +## AbstractSubclassProcessor\.Type Property + +Тип сущности\. + +```csharp +public override Pf2eModel.Model.Enum.EntityType Type { get; } +``` + +#### Property Value +[Pf2eModel\.Model\.Enum\.EntityType](https://docs.microsoft.com/en-us/dotnet/api/Pf2eModel.Model.Enum.EntityType 'Pf2eModel\.Model\.Enum\.EntityType') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AbstractSubclassProcessor.md b/Documentation/Pf2eDataScrapper/AbstractSubclassProcessor.md new file mode 100644 index 0000000..e47c0b7 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AbstractSubclassProcessor.md @@ -0,0 +1,35 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors') + +## AbstractSubclassProcessor Class + +Абстрактный класс\-обработчик сущностей подклассов, полученных из Архивов Нефиса\. +Класс предназначен для обработки данных с помощью различных обработчиков, +для которых указан атрибут [ProcessorAttribute](ProcessorAttribute.md 'Pf2eDataScrapper\.Processors\.Attributes\.ProcessorAttribute')\. + +```csharp +internal abstract class AbstractSubclassProcessor : Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.AbstractEntityProcessor +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [AbstractInputProcessor](AbstractInputProcessor.md 'Pf2eDataScrapper\.Processors\.Definitions\.AbstractInputProcessor') 🡒 [AbstractEntityProcessor](AbstractEntityProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.AbstractEntityProcessor') 🡒 AbstractSubclassProcessor + +Derived +↳ [ApparitionProcessor](ApparitionProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Subclasses\.ApparitionProcessor') + +| Constructors | | +| :--- | :--- | +| [AbstractSubclassProcessor\(ProcessorInput, StringHelper, DatabaseHelper, AonprdBuilderGlobals\)](AbstractSubclassProcessor.AbstractSubclassProcessor(ProcessorInput,StringHelper,DatabaseHelper,AonprdBuilderGlobals).md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.AbstractSubclassProcessor\.AbstractSubclassProcessor\(Pf2eDataScrapper\.Processors\.ProcessorInput, Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.StringHelper, Pf2eDataScrapper\.Helpers\.DatabaseHelper, Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.AonprdBuilderGlobals\)') | Абстрактный класс\-обработчик сущностей подклассов, полученных из Архивов Нефиса\. Класс предназначен для обработки данных с помощью различных обработчиков, для которых указан атрибут [ProcessorAttribute](ProcessorAttribute.md 'Pf2eDataScrapper\.Processors\.Attributes\.ProcessorAttribute')\. | + +| Properties | | +| :--- | :--- | +| [ClassName](AbstractSubclassProcessor.ClassName.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.AbstractSubclassProcessor\.ClassName') | Название подкласса\. | +| [GroupName](AbstractSubclassProcessor.GroupName.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.AbstractSubclassProcessor\.GroupName') | Название группы подклассов\. | +| [Object](AbstractSubclassProcessor.Object.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.AbstractSubclassProcessor\.Object') | Основная сущность\. | +| [Type](AbstractSubclassProcessor.Type.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.AbstractSubclassProcessor\.Type') | Тип сущности\. | + +| Methods | | +| :--- | :--- | +| [Add\(\)](AbstractSubclassProcessor.Add().md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.AbstractSubclassProcessor\.Add\(\)') | Добавление основной сущности в контекст базы данных\. | +| [GetGroup\(\)](AbstractSubclassProcessor.GetGroup().md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.AbstractSubclassProcessor\.GetGroup\(\)') | Получение CLR\-представления группы подклассов, к которому относится обрабатываемый подкласс\. | +| [Process\(\)](AbstractSubclassProcessor.Process().md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.AbstractSubclassProcessor\.Process\(\)') | Основной метод обработки данных\. | +| [ProcessObject\(\)](AbstractSubclassProcessor.ProcessObject().md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.AbstractSubclassProcessor\.ProcessObject\(\)') | Обработка полей подкласса\. | diff --git a/Documentation/Pf2eDataScrapper/ActionProcessor.Add().md b/Documentation/Pf2eDataScrapper/ActionProcessor.Add().md new file mode 100644 index 0000000..0eb152e --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ActionProcessor.Add().md @@ -0,0 +1,10 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types').[ActionProcessor](ActionProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.ActionProcessor') + +## ActionProcessor\.Add\(\) Method + +Добавление основной сущности в контекст базы данных\. + +```csharp +protected override void Add(); +``` \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ActionProcessor.AddedDescriptionPaths().md b/Documentation/Pf2eDataScrapper/ActionProcessor.AddedDescriptionPaths().md new file mode 100644 index 0000000..968e0ec --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ActionProcessor.AddedDescriptionPaths().md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types').[ActionProcessor](ActionProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.ActionProcessor') + +## ActionProcessor\.AddedDescriptionPaths\(\) Method + +Получение списка полей, которые должны быть добавлены в описание\. + +```csharp +protected virtual string[] AddedDescriptionPaths(); +``` + +#### Returns +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String')[\[\]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System\.Array') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ActionProcessor.Object.md b/Documentation/Pf2eDataScrapper/ActionProcessor.Object.md new file mode 100644 index 0000000..ae5e241 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ActionProcessor.Object.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types').[ActionProcessor](ActionProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.ActionProcessor') + +## ActionProcessor\.Object Property + +Основная сущность\. + +```csharp +public virtual Pf2eModel.Model.Structure.Action Object { get; } +``` + +#### Property Value +[Pf2eModel\.Model\.Structure\.Action](https://docs.microsoft.com/en-us/dotnet/api/Pf2eModel.Model.Structure.Action 'Pf2eModel\.Model\.Structure\.Action') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ActionProcessor.Process().md b/Documentation/Pf2eDataScrapper/ActionProcessor.Process().md new file mode 100644 index 0000000..1fadee5 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ActionProcessor.Process().md @@ -0,0 +1,12 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types').[ActionProcessor](ActionProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.ActionProcessor') + +## ActionProcessor\.Process\(\) Method + +Основной метод обработки данных\. + +```csharp +public override void Process(); +``` + +Implements [Process\(\)](IProcessor.Process().md 'Pf2eDataScrapper\.Processors\.Definitions\.IProcessor\.Process\(\)') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ActionProcessor.Type.md b/Documentation/Pf2eDataScrapper/ActionProcessor.Type.md new file mode 100644 index 0000000..7f060c4 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ActionProcessor.Type.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types').[ActionProcessor](ActionProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.ActionProcessor') + +## ActionProcessor\.Type Property + +Тип сущности\. + +```csharp +public override Pf2eModel.Model.Enum.EntityType Type { get; } +``` + +#### Property Value +[Pf2eModel\.Model\.Enum\.EntityType](https://docs.microsoft.com/en-us/dotnet/api/Pf2eModel.Model.Enum.EntityType 'Pf2eModel\.Model\.Enum\.EntityType') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ActionProcessor.md b/Documentation/Pf2eDataScrapper/ActionProcessor.md new file mode 100644 index 0000000..2f82982 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ActionProcessor.md @@ -0,0 +1,21 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types') + +## ActionProcessor Class + +```csharp +internal class ActionProcessor : Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.AbstractEntityProcessor +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [AbstractInputProcessor](AbstractInputProcessor.md 'Pf2eDataScrapper\.Processors\.Definitions\.AbstractInputProcessor') 🡒 [AbstractEntityProcessor](AbstractEntityProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.AbstractEntityProcessor') 🡒 ActionProcessor + +| Properties | | +| :--- | :--- | +| [Object](ActionProcessor.Object.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.ActionProcessor\.Object') | Основная сущность\. | +| [Type](ActionProcessor.Type.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.ActionProcessor\.Type') | Тип сущности\. | + +| Methods | | +| :--- | :--- | +| [Add\(\)](ActionProcessor.Add().md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.ActionProcessor\.Add\(\)') | Добавление основной сущности в контекст базы данных\. | +| [AddedDescriptionPaths\(\)](ActionProcessor.AddedDescriptionPaths().md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.ActionProcessor\.AddedDescriptionPaths\(\)') | Получение списка полей, которые должны быть добавлены в описание\. | +| [Process\(\)](ActionProcessor.Process().md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.ActionProcessor\.Process\(\)') | Основной метод обработки данных\. | diff --git a/Documentation/Pf2eDataScrapper/AncestryProcessor.Add().md b/Documentation/Pf2eDataScrapper/AncestryProcessor.Add().md new file mode 100644 index 0000000..ded2aa1 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AncestryProcessor.Add().md @@ -0,0 +1,10 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types').[AncestryProcessor](AncestryProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.AncestryProcessor') + +## AncestryProcessor\.Add\(\) Method + +Добавление основной сущности в контекст базы данных\. + +```csharp +protected override void Add(); +``` \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AncestryProcessor.Object.md b/Documentation/Pf2eDataScrapper/AncestryProcessor.Object.md new file mode 100644 index 0000000..e943336 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AncestryProcessor.Object.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types').[AncestryProcessor](AncestryProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.AncestryProcessor') + +## AncestryProcessor\.Object Property + +Основная сущность\. + +```csharp +public virtual Pf2eModel.Model.Structure.Ancestry Object { get; } +``` + +#### Property Value +[Pf2eModel\.Model\.Structure\.Ancestry](https://docs.microsoft.com/en-us/dotnet/api/Pf2eModel.Model.Structure.Ancestry 'Pf2eModel\.Model\.Structure\.Ancestry') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AncestryProcessor.Process().md b/Documentation/Pf2eDataScrapper/AncestryProcessor.Process().md new file mode 100644 index 0000000..4d51470 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AncestryProcessor.Process().md @@ -0,0 +1,12 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types').[AncestryProcessor](AncestryProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.AncestryProcessor') + +## AncestryProcessor\.Process\(\) Method + +Основной метод обработки данных\. + +```csharp +public override void Process(); +``` + +Implements [Process\(\)](IProcessor.Process().md 'Pf2eDataScrapper\.Processors\.Definitions\.IProcessor\.Process\(\)') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AncestryProcessor.Type.md b/Documentation/Pf2eDataScrapper/AncestryProcessor.Type.md new file mode 100644 index 0000000..334c874 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AncestryProcessor.Type.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types').[AncestryProcessor](AncestryProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.AncestryProcessor') + +## AncestryProcessor\.Type Property + +Тип сущности\. + +```csharp +public override Pf2eModel.Model.Enum.EntityType Type { get; } +``` + +#### Property Value +[Pf2eModel\.Model\.Enum\.EntityType](https://docs.microsoft.com/en-us/dotnet/api/Pf2eModel.Model.Enum.EntityType 'Pf2eModel\.Model\.Enum\.EntityType') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AncestryProcessor.md b/Documentation/Pf2eDataScrapper/AncestryProcessor.md new file mode 100644 index 0000000..63132a8 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AncestryProcessor.md @@ -0,0 +1,20 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types') + +## AncestryProcessor Class + +```csharp +internal class AncestryProcessor : Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.AbstractEntityProcessor +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [AbstractInputProcessor](AbstractInputProcessor.md 'Pf2eDataScrapper\.Processors\.Definitions\.AbstractInputProcessor') 🡒 [AbstractEntityProcessor](AbstractEntityProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.AbstractEntityProcessor') 🡒 AncestryProcessor + +| Properties | | +| :--- | :--- | +| [Object](AncestryProcessor.Object.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.AncestryProcessor\.Object') | Основная сущность\. | +| [Type](AncestryProcessor.Type.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.AncestryProcessor\.Type') | Тип сущности\. | + +| Methods | | +| :--- | :--- | +| [Add\(\)](AncestryProcessor.Add().md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.AncestryProcessor\.Add\(\)') | Добавление основной сущности в контекст базы данных\. | +| [Process\(\)](AncestryProcessor.Process().md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.AncestryProcessor\.Process\(\)') | Основной метод обработки данных\. | diff --git a/Documentation/Pf2eDataScrapper/AonprdBuilderGlobals.AonprdBuilderGlobals().md b/Documentation/Pf2eDataScrapper/AonprdBuilderGlobals.AonprdBuilderGlobals().md new file mode 100644 index 0000000..83ac812 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AonprdBuilderGlobals.AonprdBuilderGlobals().md @@ -0,0 +1,10 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers](Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers').[AonprdBuilderGlobals](AonprdBuilderGlobals.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.AonprdBuilderGlobals') + +## AonprdBuilderGlobals\(\) Constructor + +Конструктор класса [AonprdBuilderGlobals](AonprdBuilderGlobals.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.AonprdBuilderGlobals')\. + +```csharp +public AonprdBuilderGlobals(); +``` \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AonprdBuilderGlobals.AonprdTarget.md b/Documentation/Pf2eDataScrapper/AonprdBuilderGlobals.AonprdTarget.md new file mode 100644 index 0000000..0e4c4da --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AonprdBuilderGlobals.AonprdTarget.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers](Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers').[AonprdBuilderGlobals](AonprdBuilderGlobals.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.AonprdBuilderGlobals') + +## AonprdBuilderGlobals\.AonprdTarget Property + +Цель внешних ссылок Архивов Нефисов\. + +```csharp +public Pf2eModel.Model.Base.Targets.ExternalTarget AonprdTarget { get; set; } +``` + +#### Property Value +[Pf2eModel\.Model\.Base\.Targets\.ExternalTarget](https://docs.microsoft.com/en-us/dotnet/api/Pf2eModel.Model.Base.Targets.ExternalTarget 'Pf2eModel\.Model\.Base\.Targets\.ExternalTarget') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AonprdBuilderGlobals.GetSlugSuffix(string).md b/Documentation/Pf2eDataScrapper/AonprdBuilderGlobals.GetSlugSuffix(string).md new file mode 100644 index 0000000..a7fbf7f --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AonprdBuilderGlobals.GetSlugSuffix(string).md @@ -0,0 +1,21 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers](Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers').[AonprdBuilderGlobals](AonprdBuilderGlobals.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.AonprdBuilderGlobals') + +## AonprdBuilderGlobals\.GetSlugSuffix\(string\) Method + +Получить суффикс для ссылки\. + +```csharp +public string GetSlugSuffix(string id); +``` +#### Parameters + + + +`id` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +Идентификатор Aonprd\. + +#### Returns +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') +Суффикс для ссылки или пустая строка\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AonprdBuilderGlobals.LegacyRemasterExtra.md b/Documentation/Pf2eDataScrapper/AonprdBuilderGlobals.LegacyRemasterExtra.md new file mode 100644 index 0000000..2ec392d --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AonprdBuilderGlobals.LegacyRemasterExtra.md @@ -0,0 +1,14 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers](Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers').[AonprdBuilderGlobals](AonprdBuilderGlobals.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.AonprdBuilderGlobals') + +## AonprdBuilderGlobals\.LegacyRemasterExtra Property + +Словарь допольнительных проверок связей\. +Ключ \- устаревшая сущность, значение \- обновлённая\. + +```csharp +public System.Collections.Generic.Dictionary LegacyRemasterExtra { get; } +``` + +#### Property Value +[System\.Collections\.Generic\.Dictionary<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.Dictionary-2 'System\.Collections\.Generic\.Dictionary\`2')[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.Dictionary-2 'System\.Collections\.Generic\.Dictionary\`2')[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.Dictionary-2 'System\.Collections\.Generic\.Dictionary\`2') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AonprdBuilderGlobals.MergeSources.md b/Documentation/Pf2eDataScrapper/AonprdBuilderGlobals.MergeSources.md new file mode 100644 index 0000000..d54d528 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AonprdBuilderGlobals.MergeSources.md @@ -0,0 +1,14 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers](Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers').[AonprdBuilderGlobals](AonprdBuilderGlobals.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.AonprdBuilderGlobals') + +## AonprdBuilderGlobals\.MergeSources Property + +Словарь сущностей, которые нужно слить с другой/другими\. +Ключ \- пропускаемая сущность\. Значение \- целевая сущность\. + +```csharp +public System.Collections.Generic.Dictionary MergeSources { get; } +``` + +#### Property Value +[System\.Collections\.Generic\.Dictionary<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.Dictionary-2 'System\.Collections\.Generic\.Dictionary\`2')[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.Dictionary-2 'System\.Collections\.Generic\.Dictionary\`2')[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.Dictionary-2 'System\.Collections\.Generic\.Dictionary\`2') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AonprdBuilderGlobals.SlugSuffixes.md b/Documentation/Pf2eDataScrapper/AonprdBuilderGlobals.SlugSuffixes.md new file mode 100644 index 0000000..54b1bb8 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AonprdBuilderGlobals.SlugSuffixes.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers](Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers').[AonprdBuilderGlobals](AonprdBuilderGlobals.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.AonprdBuilderGlobals') + +## AonprdBuilderGlobals\.SlugSuffixes Property + +Словарей суффиксов для сущностей + +```csharp +public System.Collections.Generic.Dictionary SlugSuffixes { get; } +``` + +#### Property Value +[System\.Collections\.Generic\.Dictionary<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.Dictionary-2 'System\.Collections\.Generic\.Dictionary\`2')[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.Dictionary-2 'System\.Collections\.Generic\.Dictionary\`2')[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.Dictionary-2 'System\.Collections\.Generic\.Dictionary\`2') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AonprdBuilderGlobals.SourceIds.md b/Documentation/Pf2eDataScrapper/AonprdBuilderGlobals.SourceIds.md new file mode 100644 index 0000000..87f04be --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AonprdBuilderGlobals.SourceIds.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers](Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers').[AonprdBuilderGlobals](AonprdBuilderGlobals.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.AonprdBuilderGlobals') + +## AonprdBuilderGlobals\.SourceIds Property + +Словарь идентификаторов источников\. + +```csharp +public System.Collections.Generic.Dictionary SourceIds { get; } +``` + +#### Property Value +[System\.Collections\.Generic\.Dictionary<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.Dictionary-2 'System\.Collections\.Generic\.Dictionary\`2')[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.Dictionary-2 'System\.Collections\.Generic\.Dictionary\`2')[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.Dictionary-2 'System\.Collections\.Generic\.Dictionary\`2') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AonprdBuilderGlobals.SubclassGroups.md b/Documentation/Pf2eDataScrapper/AonprdBuilderGlobals.SubclassGroups.md new file mode 100644 index 0000000..0f9cca7 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AonprdBuilderGlobals.SubclassGroups.md @@ -0,0 +1,14 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers](Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers').[AonprdBuilderGlobals](AonprdBuilderGlobals.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.AonprdBuilderGlobals') + +## AonprdBuilderGlobals\.SubclassGroups Property + +Словарь сущностей, которые нужно слить с другой/другими\. +Ключ \- пропускаемая сущность\. Значение \- целевая сущность\. + +```csharp +public System.Collections.Generic.Dictionary SubclassGroups { get; } +``` + +#### Property Value +[System\.Collections\.Generic\.Dictionary<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.Dictionary-2 'System\.Collections\.Generic\.Dictionary\`2')[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.Dictionary-2 'System\.Collections\.Generic\.Dictionary\`2')[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.Dictionary-2 'System\.Collections\.Generic\.Dictionary\`2') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AonprdBuilderGlobals.TraitIds.md b/Documentation/Pf2eDataScrapper/AonprdBuilderGlobals.TraitIds.md new file mode 100644 index 0000000..5ae2b87 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AonprdBuilderGlobals.TraitIds.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers](Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers').[AonprdBuilderGlobals](AonprdBuilderGlobals.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.AonprdBuilderGlobals') + +## AonprdBuilderGlobals\.TraitIds Property + +Словарь идентификаторов признаков\. + +```csharp +public System.Collections.Generic.Dictionary TraitIds { get; } +``` + +#### Property Value +[System\.Collections\.Generic\.Dictionary<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.Dictionary-2 'System\.Collections\.Generic\.Dictionary\`2')[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.Dictionary-2 'System\.Collections\.Generic\.Dictionary\`2')[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.Dictionary-2 'System\.Collections\.Generic\.Dictionary\`2') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AonprdBuilderGlobals.md b/Documentation/Pf2eDataScrapper/AonprdBuilderGlobals.md new file mode 100644 index 0000000..577d5bd --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AonprdBuilderGlobals.md @@ -0,0 +1,30 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers](Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers') + +## AonprdBuilderGlobals Class + +Класс\-помощник, хранящий необходимые глобальные данные\. + +```csharp +internal class AonprdBuilderGlobals +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 AonprdBuilderGlobals + +| Constructors | | +| :--- | :--- | +| [AonprdBuilderGlobals\(\)](AonprdBuilderGlobals.AonprdBuilderGlobals().md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.AonprdBuilderGlobals\.AonprdBuilderGlobals\(\)') | Конструктор класса [AonprdBuilderGlobals](AonprdBuilderGlobals.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.AonprdBuilderGlobals')\. | + +| Properties | | +| :--- | :--- | +| [AonprdTarget](AonprdBuilderGlobals.AonprdTarget.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.AonprdBuilderGlobals\.AonprdTarget') | Цель внешних ссылок Архивов Нефисов\. | +| [LegacyRemasterExtra](AonprdBuilderGlobals.LegacyRemasterExtra.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.AonprdBuilderGlobals\.LegacyRemasterExtra') | Словарь допольнительных проверок связей\. Ключ \- устаревшая сущность, значение \- обновлённая\. | +| [MergeSources](AonprdBuilderGlobals.MergeSources.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.AonprdBuilderGlobals\.MergeSources') | Словарь сущностей, которые нужно слить с другой/другими\. Ключ \- пропускаемая сущность\. Значение \- целевая сущность\. | +| [SlugSuffixes](AonprdBuilderGlobals.SlugSuffixes.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.AonprdBuilderGlobals\.SlugSuffixes') | Словарей суффиксов для сущностей | +| [SourceIds](AonprdBuilderGlobals.SourceIds.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.AonprdBuilderGlobals\.SourceIds') | Словарь идентификаторов источников\. | +| [SubclassGroups](AonprdBuilderGlobals.SubclassGroups.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.AonprdBuilderGlobals\.SubclassGroups') | Словарь сущностей, которые нужно слить с другой/другими\. Ключ \- пропускаемая сущность\. Значение \- целевая сущность\. | +| [TraitIds](AonprdBuilderGlobals.TraitIds.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.AonprdBuilderGlobals\.TraitIds') | Словарь идентификаторов признаков\. | + +| Methods | | +| :--- | :--- | +| [GetSlugSuffix\(string\)](AonprdBuilderGlobals.GetSlugSuffix(string).md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.AonprdBuilderGlobals\.GetSlugSuffix\(string\)') | Получить суффикс для ссылки\. | diff --git a/Documentation/Pf2eDataScrapper/AonprdCompendium.AonprdCompendium(AonprdRepository).md b/Documentation/Pf2eDataScrapper/AonprdCompendium.AonprdCompendium(AonprdRepository).md new file mode 100644 index 0000000..33006f9 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AonprdCompendium.AonprdCompendium(AonprdRepository).md @@ -0,0 +1,15 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Compendium](Pf2eDataScrapper.Importers.Implementations.Aonprd.Compendium.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Compendium').[AonprdCompendium](AonprdCompendium.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Compendium\.AonprdCompendium') + +## AonprdCompendium\(AonprdRepository\) Constructor + +Класс хранения данных компендиума\. + +```csharp +public AonprdCompendium(Pf2eDataScrapper.Importers.Implementations.Aonprd.AonprdRepository repository); +``` +#### Parameters + + + +`repository` [AonprdRepository](AonprdRepository.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.AonprdRepository') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AonprdCompendium.Count(ICollection_string_).md b/Documentation/Pf2eDataScrapper/AonprdCompendium.Count(ICollection_string_).md new file mode 100644 index 0000000..c031a81 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AonprdCompendium.Count(ICollection_string_).md @@ -0,0 +1,19 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Compendium](Pf2eDataScrapper.Importers.Implementations.Aonprd.Compendium.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Compendium').[AonprdCompendium](AonprdCompendium.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Compendium\.AonprdCompendium') + +## AonprdCompendium\.Count\(ICollection\\) Method + +Возвращает количество элементов для указанного типа данных\. + +```csharp +public override int Count(System.Collections.Generic.ICollection types); +``` +#### Parameters + + + +`types` [System\.Collections\.Generic\.ICollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1')[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1') + +#### Returns +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') +Количество элементов\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AonprdCompendium.Items.md b/Documentation/Pf2eDataScrapper/AonprdCompendium.Items.md new file mode 100644 index 0000000..78af455 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AonprdCompendium.Items.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Compendium](Pf2eDataScrapper.Importers.Implementations.Aonprd.Compendium.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Compendium').[AonprdCompendium](AonprdCompendium.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Compendium\.AonprdCompendium') + +## AonprdCompendium\.Items Property + +Коллекция всех записей компендиума\. + +```csharp +public System.Collections.Concurrent.ConcurrentBag Items { get; } +``` + +#### Property Value +[System\.Collections\.Concurrent\.ConcurrentBag<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Concurrent.ConcurrentBag-1 'System\.Collections\.Concurrent\.ConcurrentBag\`1')[AonprdCompendiumItem](AonprdCompendiumItem.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Compendium\.AonprdCompendiumItem')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Concurrent.ConcurrentBag-1 'System\.Collections\.Concurrent\.ConcurrentBag\`1') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AonprdCompendium.Iterate(ICollection_string_).md b/Documentation/Pf2eDataScrapper/AonprdCompendium.Iterate(ICollection_string_).md new file mode 100644 index 0000000..b37ddd6 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AonprdCompendium.Iterate(ICollection_string_).md @@ -0,0 +1,19 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Compendium](Pf2eDataScrapper.Importers.Implementations.Aonprd.Compendium.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Compendium').[AonprdCompendium](AonprdCompendium.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Compendium\.AonprdCompendium') + +## AonprdCompendium\.Iterate\(ICollection\\) Method + +Получение итератора сущностей\. Если указан тип type \- то только указанного типа\. + +```csharp +public override System.Collections.Generic.IEnumerable> Iterate(System.Collections.Generic.ICollection types); +``` +#### Parameters + + + +`types` [System\.Collections\.Generic\.ICollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1')[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1') + +#### Returns +[System\.Collections\.Generic\.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System\.Collections\.Generic\.IEnumerable\`1')[System\.Tuple<](https://docs.microsoft.com/en-us/dotnet/api/System.Tuple-2 'System\.Tuple\`2')[AbstractCompendiumItem](AbstractCompendiumItem.md 'Pf2eDataScrapper\.Importers\.AbstractCompendiumItem')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Tuple-2 'System\.Tuple\`2')[Newtonsoft\.Json\.Linq\.JObject](https://docs.microsoft.com/en-us/dotnet/api/Newtonsoft.Json.Linq.JObject 'Newtonsoft\.Json\.Linq\.JObject')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Tuple-2 'System\.Tuple\`2')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System\.Collections\.Generic\.IEnumerable\`1') +Итератор сущностей\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AonprdCompendium.Repository.md b/Documentation/Pf2eDataScrapper/AonprdCompendium.Repository.md new file mode 100644 index 0000000..8555f6e --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AonprdCompendium.Repository.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Compendium](Pf2eDataScrapper.Importers.Implementations.Aonprd.Compendium.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Compendium').[AonprdCompendium](AonprdCompendium.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Compendium\.AonprdCompendium') + +## AonprdCompendium\.Repository Property + +Репозиторий данных\. + +```csharp +public virtual Pf2eDataScrapper.Importers.Implementations.Aonprd.AonprdRepository Repository { get; } +``` + +#### Property Value +[AonprdRepository](AonprdRepository.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.AonprdRepository') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AonprdCompendium.md b/Documentation/Pf2eDataScrapper/AonprdCompendium.md new file mode 100644 index 0000000..1fcdd11 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AonprdCompendium.md @@ -0,0 +1,26 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Compendium](Pf2eDataScrapper.Importers.Implementations.Aonprd.Compendium.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Compendium') + +## AonprdCompendium Class + +Класс хранения данных компендиума\. + +```csharp +internal sealed class AonprdCompendium : Pf2eDataScrapper.Importers.AbstractCompendium +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [AbstractCompendium](AbstractCompendium.md 'Pf2eDataScrapper\.Importers\.AbstractCompendium') 🡒 AonprdCompendium + +| Constructors | | +| :--- | :--- | +| [AonprdCompendium\(AonprdRepository\)](AonprdCompendium.AonprdCompendium(AonprdRepository).md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Compendium\.AonprdCompendium\.AonprdCompendium\(Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.AonprdRepository\)') | Класс хранения данных компендиума\. | + +| Properties | | +| :--- | :--- | +| [Items](AonprdCompendium.Items.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Compendium\.AonprdCompendium\.Items') | Коллекция всех записей компендиума\. | +| [Repository](AonprdCompendium.Repository.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Compendium\.AonprdCompendium\.Repository') | Репозиторий данных\. | + +| Methods | | +| :--- | :--- | +| [Count\(ICollection<string>\)](AonprdCompendium.Count(ICollection_string_).md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Compendium\.AonprdCompendium\.Count\(System\.Collections\.Generic\.ICollection\\)') | Возвращает количество элементов для указанного типа данных\. | +| [Iterate\(ICollection<string>\)](AonprdCompendium.Iterate(ICollection_string_).md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Compendium\.AonprdCompendium\.Iterate\(System\.Collections\.Generic\.ICollection\\)') | Получение итератора сущностей\. Если указан тип type \- то только указанного типа\. | diff --git a/Documentation/Pf2eDataScrapper/AonprdCompendiumItem.AonprdCompendiumItem(string,string).md b/Documentation/Pf2eDataScrapper/AonprdCompendiumItem.AonprdCompendiumItem(string,string).md new file mode 100644 index 0000000..6d16fd4 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AonprdCompendiumItem.AonprdCompendiumItem(string,string).md @@ -0,0 +1,23 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Compendium](Pf2eDataScrapper.Importers.Implementations.Aonprd.Compendium.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Compendium').[AonprdCompendiumItem](AonprdCompendiumItem.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Compendium\.AonprdCompendiumItem') + +## AonprdCompendiumItem\(string, string\) Constructor + +Ссылка на сущность с указанием файла, в котором она хранится\. + +```csharp +public AonprdCompendiumItem(string id, string file); +``` +#### Parameters + + + +`id` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +Идентификатор сущности\. + + + +`file` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +Имя файла\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AonprdCompendiumItem.File.md b/Documentation/Pf2eDataScrapper/AonprdCompendiumItem.File.md new file mode 100644 index 0000000..c0e7851 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AonprdCompendiumItem.File.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Compendium](Pf2eDataScrapper.Importers.Implementations.Aonprd.Compendium.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Compendium').[AonprdCompendiumItem](AonprdCompendiumItem.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Compendium\.AonprdCompendiumItem') + +## AonprdCompendiumItem\.File Property + +Имя файла, в котором хранится сущность\. + +```csharp +public string File { get; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AonprdCompendiumItem.Id.md b/Documentation/Pf2eDataScrapper/AonprdCompendiumItem.Id.md new file mode 100644 index 0000000..ad0c5f1 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AonprdCompendiumItem.Id.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Compendium](Pf2eDataScrapper.Importers.Implementations.Aonprd.Compendium.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Compendium').[AonprdCompendiumItem](AonprdCompendiumItem.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Compendium\.AonprdCompendiumItem') + +## AonprdCompendiumItem\.Id Property + +Идентификатор сущности\. + +```csharp +public override string Id { get; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AonprdCompendiumItem.ResolveType(string).md b/Documentation/Pf2eDataScrapper/AonprdCompendiumItem.ResolveType(string).md new file mode 100644 index 0000000..63ebace --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AonprdCompendiumItem.ResolveType(string).md @@ -0,0 +1,18 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Compendium](Pf2eDataScrapper.Importers.Implementations.Aonprd.Compendium.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Compendium').[AonprdCompendiumItem](AonprdCompendiumItem.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Compendium\.AonprdCompendiumItem') + +## AonprdCompendiumItem\.ResolveType\(string\) Method + +Определение типа сущности как префикса идентификатора\. + +```csharp +public static string ResolveType(string id); +``` +#### Parameters + + + +`id` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +#### Returns +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AonprdCompendiumItem.Type.md b/Documentation/Pf2eDataScrapper/AonprdCompendiumItem.Type.md new file mode 100644 index 0000000..a1ac6ed --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AonprdCompendiumItem.Type.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Compendium](Pf2eDataScrapper.Importers.Implementations.Aonprd.Compendium.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Compendium').[AonprdCompendiumItem](AonprdCompendiumItem.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Compendium\.AonprdCompendiumItem') + +## AonprdCompendiumItem\.Type Property + +Тип сущности\. + +```csharp +public override string Type { get; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AonprdCompendiumItem.md b/Documentation/Pf2eDataScrapper/AonprdCompendiumItem.md new file mode 100644 index 0000000..d78ecf1 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AonprdCompendiumItem.md @@ -0,0 +1,26 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Compendium](Pf2eDataScrapper.Importers.Implementations.Aonprd.Compendium.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Compendium') + +## AonprdCompendiumItem Class + +Ссылка на сущность с указанием файла, в котором она хранится\. + +```csharp +internal class AonprdCompendiumItem : Pf2eDataScrapper.Importers.AbstractCompendiumItem +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [AbstractCompendiumItem](AbstractCompendiumItem.md 'Pf2eDataScrapper\.Importers\.AbstractCompendiumItem') 🡒 AonprdCompendiumItem + +| Constructors | | +| :--- | :--- | +| [AonprdCompendiumItem\(string, string\)](AonprdCompendiumItem.AonprdCompendiumItem(string,string).md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Compendium\.AonprdCompendiumItem\.AonprdCompendiumItem\(string, string\)') | Ссылка на сущность с указанием файла, в котором она хранится\. | + +| Properties | | +| :--- | :--- | +| [File](AonprdCompendiumItem.File.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Compendium\.AonprdCompendiumItem\.File') | Имя файла, в котором хранится сущность\. | +| [Id](AonprdCompendiumItem.Id.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Compendium\.AonprdCompendiumItem\.Id') | Идентификатор сущности\. | +| [Type](AonprdCompendiumItem.Type.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Compendium\.AonprdCompendiumItem\.Type') | Тип сущности\. | + +| Methods | | +| :--- | :--- | +| [ResolveType\(string\)](AonprdCompendiumItem.ResolveType(string).md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Compendium\.AonprdCompendiumItem\.ResolveType\(string\)') | Определение типа сущности как префикса идентификатора\. | diff --git a/Documentation/Pf2eDataScrapper/AonprdImporter.Name.md b/Documentation/Pf2eDataScrapper/AonprdImporter.Name.md new file mode 100644 index 0000000..33078ef --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AonprdImporter.Name.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd](Pf2eDataScrapper.Importers.Implementations.Aonprd.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd').[AonprdImporter](AonprdImporter.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.AonprdImporter') + +## AonprdImporter\.Name Property + +Отображаемое имя импортёра\. + +```csharp +public override string Name { get; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AonprdImporter.Slug.md b/Documentation/Pf2eDataScrapper/AonprdImporter.Slug.md new file mode 100644 index 0000000..5a21985 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AonprdImporter.Slug.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd](Pf2eDataScrapper.Importers.Implementations.Aonprd.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd').[AonprdImporter](AonprdImporter.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.AonprdImporter') + +## AonprdImporter\.Slug Property + +Короткое имя импортёра\. + +```csharp +public override string Slug { get; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AonprdImporter.TargetName.md b/Documentation/Pf2eDataScrapper/AonprdImporter.TargetName.md new file mode 100644 index 0000000..09fb482 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AonprdImporter.TargetName.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd](Pf2eDataScrapper.Importers.Implementations.Aonprd.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd').[AonprdImporter](AonprdImporter.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.AonprdImporter') + +## AonprdImporter\.TargetName Field + +Название внешней ссылки\. + +```csharp +public const string TargetName = "Archives of Nethys Pathfinder 2e"; +``` + +#### Field Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AonprdImporter.md b/Documentation/Pf2eDataScrapper/AonprdImporter.md new file mode 100644 index 0000000..13dc06d --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AonprdImporter.md @@ -0,0 +1,21 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd](Pf2eDataScrapper.Importers.Implementations.Aonprd.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd') + +## AonprdImporter Class + +Класс обработки данных с сайта Архивов Нефеса\. + +```csharp +internal class AonprdImporter : Pf2eDataScrapper.Importers.AbstractImporter +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [AbstractImporter](AbstractImporter.md 'Pf2eDataScrapper\.Importers\.AbstractImporter') 🡒 AonprdImporter + +| Fields | | +| :--- | :--- | +| [TargetName](AonprdImporter.TargetName.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.AonprdImporter\.TargetName') | Название внешней ссылки\. | + +| Properties | | +| :--- | :--- | +| [Name](AonprdImporter.Name.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.AonprdImporter\.Name') | Отображаемое имя импортёра\. | +| [Slug](AonprdImporter.Slug.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.AonprdImporter\.Slug') | Короткое имя импортёра\. | diff --git a/Documentation/Pf2eDataScrapper/AonprdProcessorInputExtension.ActionStruct.Actions.md b/Documentation/Pf2eDataScrapper/AonprdProcessorInputExtension.ActionStruct.Actions.md new file mode 100644 index 0000000..0c191b3 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AonprdProcessorInputExtension.ActionStruct.Actions.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers](Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers').[AonprdProcessorInputExtension](AonprdProcessorInputExtension.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.AonprdProcessorInputExtension').[ActionStruct](AonprdProcessorInputExtension.ActionStruct.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.AonprdProcessorInputExtension\.ActionStruct') + +## AonprdProcessorInputExtension\.ActionStruct\.Actions Property + +Количество действий + +```csharp +public int Actions { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AonprdProcessorInputExtension.ActionStruct.IsFreeAction.md b/Documentation/Pf2eDataScrapper/AonprdProcessorInputExtension.ActionStruct.IsFreeAction.md new file mode 100644 index 0000000..c0e0687 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AonprdProcessorInputExtension.ActionStruct.IsFreeAction.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers](Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers').[AonprdProcessorInputExtension](AonprdProcessorInputExtension.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.AonprdProcessorInputExtension').[ActionStruct](AonprdProcessorInputExtension.ActionStruct.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.AonprdProcessorInputExtension\.ActionStruct') + +## AonprdProcessorInputExtension\.ActionStruct\.IsFreeAction Property + +Флаг, указывающий, что можно использовать свободное действие\. + +```csharp +public bool IsFreeAction { get; set; } +``` + +#### Property Value +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AonprdProcessorInputExtension.ActionStruct.IsPassive.md b/Documentation/Pf2eDataScrapper/AonprdProcessorInputExtension.ActionStruct.IsPassive.md new file mode 100644 index 0000000..736d73a --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AonprdProcessorInputExtension.ActionStruct.IsPassive.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers](Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers').[AonprdProcessorInputExtension](AonprdProcessorInputExtension.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.AonprdProcessorInputExtension').[ActionStruct](AonprdProcessorInputExtension.ActionStruct.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.AonprdProcessorInputExtension\.ActionStruct') + +## AonprdProcessorInputExtension\.ActionStruct\.IsPassive Property + +Флаг, указывающий, что действия не требуются\. + +```csharp +public bool IsPassive { get; set; } +``` + +#### Property Value +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AonprdProcessorInputExtension.ActionStruct.IsReaction.md b/Documentation/Pf2eDataScrapper/AonprdProcessorInputExtension.ActionStruct.IsReaction.md new file mode 100644 index 0000000..453ae12 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AonprdProcessorInputExtension.ActionStruct.IsReaction.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers](Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers').[AonprdProcessorInputExtension](AonprdProcessorInputExtension.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.AonprdProcessorInputExtension').[ActionStruct](AonprdProcessorInputExtension.ActionStruct.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.AonprdProcessorInputExtension\.ActionStruct') + +## AonprdProcessorInputExtension\.ActionStruct\.IsReaction Property + +Флаг, указывающий, что действие может быть использовано как реакция\. + +```csharp +public bool IsReaction { get; set; } +``` + +#### Property Value +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AonprdProcessorInputExtension.ActionStruct.MaxActions.md b/Documentation/Pf2eDataScrapper/AonprdProcessorInputExtension.ActionStruct.MaxActions.md new file mode 100644 index 0000000..ccf7880 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AonprdProcessorInputExtension.ActionStruct.MaxActions.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers](Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers').[AonprdProcessorInputExtension](AonprdProcessorInputExtension.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.AonprdProcessorInputExtension').[ActionStruct](AonprdProcessorInputExtension.ActionStruct.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.AonprdProcessorInputExtension\.ActionStruct') + +## AonprdProcessorInputExtension\.ActionStruct\.MaxActions Property + +Максимальное количество действий + +```csharp +public int MaxActions { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AonprdProcessorInputExtension.ActionStruct.TwoRounds.md b/Documentation/Pf2eDataScrapper/AonprdProcessorInputExtension.ActionStruct.TwoRounds.md new file mode 100644 index 0000000..4e78ccb --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AonprdProcessorInputExtension.ActionStruct.TwoRounds.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers](Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers').[AonprdProcessorInputExtension](AonprdProcessorInputExtension.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.AonprdProcessorInputExtension').[ActionStruct](AonprdProcessorInputExtension.ActionStruct.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.AonprdProcessorInputExtension\.ActionStruct') + +## AonprdProcessorInputExtension\.ActionStruct\.TwoRounds Property + +Флаг, указывающий, что действие может быть продлено до 2 раундов\. + +```csharp +public bool TwoRounds { get; set; } +``` + +#### Property Value +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AonprdProcessorInputExtension.ActionStruct.md b/Documentation/Pf2eDataScrapper/AonprdProcessorInputExtension.ActionStruct.md new file mode 100644 index 0000000..f79c7e1 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AonprdProcessorInputExtension.ActionStruct.md @@ -0,0 +1,21 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers](Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers').[AonprdProcessorInputExtension](AonprdProcessorInputExtension.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.AonprdProcessorInputExtension') + +## AonprdProcessorInputExtension\.ActionStruct Class + +Класс структуры, хранящей информацию о количетсве действий\. + +```csharp +public class AonprdProcessorInputExtension.ActionStruct +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 ActionStruct + +| Properties | | +| :--- | :--- | +| [Actions](AonprdProcessorInputExtension.ActionStruct.Actions.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.AonprdProcessorInputExtension\.ActionStruct\.Actions') | Количество действий | +| [IsFreeAction](AonprdProcessorInputExtension.ActionStruct.IsFreeAction.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.AonprdProcessorInputExtension\.ActionStruct\.IsFreeAction') | Флаг, указывающий, что можно использовать свободное действие\. | +| [IsPassive](AonprdProcessorInputExtension.ActionStruct.IsPassive.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.AonprdProcessorInputExtension\.ActionStruct\.IsPassive') | Флаг, указывающий, что действия не требуются\. | +| [IsReaction](AonprdProcessorInputExtension.ActionStruct.IsReaction.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.AonprdProcessorInputExtension\.ActionStruct\.IsReaction') | Флаг, указывающий, что действие может быть использовано как реакция\. | +| [MaxActions](AonprdProcessorInputExtension.ActionStruct.MaxActions.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.AonprdProcessorInputExtension\.ActionStruct\.MaxActions') | Максимальное количество действий | +| [TwoRounds](AonprdProcessorInputExtension.ActionStruct.TwoRounds.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.AonprdProcessorInputExtension\.ActionStruct\.TwoRounds') | Флаг, указывающий, что действие может быть продлено до 2 раундов\. | diff --git a/Documentation/Pf2eDataScrapper/AonprdProcessorInputExtension.ResolveActionString(thisProcessorInput,string).md b/Documentation/Pf2eDataScrapper/AonprdProcessorInputExtension.ResolveActionString(thisProcessorInput,string).md new file mode 100644 index 0000000..7cc3e01 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AonprdProcessorInputExtension.ResolveActionString(thisProcessorInput,string).md @@ -0,0 +1,25 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers](Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers').[AonprdProcessorInputExtension](AonprdProcessorInputExtension.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.AonprdProcessorInputExtension') + +## AonprdProcessorInputExtension\.ResolveActionString\(this ProcessorInput, string\) Method + +Обработать строку, содержащую информацию о количестве действий\. + +```csharp +public static Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.AonprdProcessorInputExtension.ActionStruct ResolveActionString(this Pf2eDataScrapper.Processors.ProcessorInput _, string input); +``` +#### Parameters + + + +`_` [ProcessorInput](ProcessorInput.md 'Pf2eDataScrapper\.Processors\.ProcessorInput') + + + +`input` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +Входная строка с данными\. + +#### Returns +[ActionStruct](AonprdProcessorInputExtension.ActionStruct.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.AonprdProcessorInputExtension\.ActionStruct') +Структура, хранящая информацию о количетсве действий\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AonprdProcessorInputExtension.md b/Documentation/Pf2eDataScrapper/AonprdProcessorInputExtension.md new file mode 100644 index 0000000..c23537d --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AonprdProcessorInputExtension.md @@ -0,0 +1,14 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers](Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers') + +## AonprdProcessorInputExtension Class + +```csharp +internal static class AonprdProcessorInputExtension +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 AonprdProcessorInputExtension + +| Methods | | +| :--- | :--- | +| [ResolveActionString\(this ProcessorInput, string\)](AonprdProcessorInputExtension.ResolveActionString(thisProcessorInput,string).md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.AonprdProcessorInputExtension\.ResolveActionString\(this Pf2eDataScrapper\.Processors\.ProcessorInput, string\)') | Обработать строку, содержащую информацию о количестве действий\. | diff --git a/Documentation/Pf2eDataScrapper/AonprdRepository.AonprdRepository(AonprdImporter).md b/Documentation/Pf2eDataScrapper/AonprdRepository.AonprdRepository(AonprdImporter).md new file mode 100644 index 0000000..ea71611 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AonprdRepository.AonprdRepository(AonprdImporter).md @@ -0,0 +1,15 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd](Pf2eDataScrapper.Importers.Implementations.Aonprd.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd').[AonprdRepository](AonprdRepository.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.AonprdRepository') + +## AonprdRepository\(AonprdImporter\) Constructor + +Основной класс для работы с репозиторием данных Aonprd\. + +```csharp +public AonprdRepository(Pf2eDataScrapper.Importers.Implementations.Aonprd.AonprdImporter importer); +``` +#### Parameters + + + +`importer` [AonprdImporter](AonprdImporter.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.AonprdImporter') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AonprdRepository.CheckRevision().md b/Documentation/Pf2eDataScrapper/AonprdRepository.CheckRevision().md new file mode 100644 index 0000000..43563b2 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AonprdRepository.CheckRevision().md @@ -0,0 +1,14 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd](Pf2eDataScrapper.Importers.Implementations.Aonprd.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd').[AonprdRepository](AonprdRepository.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.AonprdRepository') + +## AonprdRepository\.CheckRevision\(\) Method + +Проверка актуальности данных\. + +```csharp +private bool CheckRevision(); +``` + +#### Returns +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') +true \- актуальная ревизия, false \- устаревшая/отсутсвует\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AonprdRepository.Load(string).md b/Documentation/Pf2eDataScrapper/AonprdRepository.Load(string).md new file mode 100644 index 0000000..54363cc --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AonprdRepository.Load(string).md @@ -0,0 +1,18 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd](Pf2eDataScrapper.Importers.Implementations.Aonprd.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd').[AonprdRepository](AonprdRepository.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.AonprdRepository') + +## AonprdRepository\.Load\(string\) Method + +Метод для загрузки данных из API Aonprd\. + +```csharp +private string Load(string url); +``` +#### Parameters + + + +`url` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +#### Returns +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AonprdRepository.Revision.md b/Documentation/Pf2eDataScrapper/AonprdRepository.Revision.md new file mode 100644 index 0000000..42dc213 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AonprdRepository.Revision.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd](Pf2eDataScrapper.Importers.Implementations.Aonprd.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd').[AonprdRepository](AonprdRepository.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.AonprdRepository') + +## AonprdRepository\.Revision Property + +Текущая ревизия данных\. Значение обновляется при обновлении репозитория\. + +```csharp +public int Revision { get; private set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AonprdRepository.SearchUrl.md b/Documentation/Pf2eDataScrapper/AonprdRepository.SearchUrl.md new file mode 100644 index 0000000..1e5fe87 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AonprdRepository.SearchUrl.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd](Pf2eDataScrapper.Importers.Implementations.Aonprd.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd').[AonprdRepository](AonprdRepository.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.AonprdRepository') + +## AonprdRepository\.SearchUrl Field + +URL для доступа к API Aonprd\. + +```csharp +public const string SearchUrl = "https://elasticsearch.aonprd.com"; +``` + +#### Field Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AonprdRepository.Update(ProcessProgress).md b/Documentation/Pf2eDataScrapper/AonprdRepository.Update(ProcessProgress).md new file mode 100644 index 0000000..16e150c --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AonprdRepository.Update(ProcessProgress).md @@ -0,0 +1,15 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd](Pf2eDataScrapper.Importers.Implementations.Aonprd.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd').[AonprdRepository](AonprdRepository.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.AonprdRepository') + +## AonprdRepository\.Update\(ProcessProgress\) Method + +Обновление данных в репозитории\. + +```csharp +public override void Update(Pf2eDataScrapper.Helpers.ProcessProgress progress); +``` +#### Parameters + + + +`progress` [ProcessProgress](ProcessProgress.md 'Pf2eDataScrapper\.Helpers\.ProcessProgress') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AonprdRepository.WriteFile(string,string).md b/Documentation/Pf2eDataScrapper/AonprdRepository.WriteFile(string,string).md new file mode 100644 index 0000000..fce3d22 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AonprdRepository.WriteFile(string,string).md @@ -0,0 +1,23 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd](Pf2eDataScrapper.Importers.Implementations.Aonprd.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd').[AonprdRepository](AonprdRepository.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.AonprdRepository') + +## AonprdRepository\.WriteFile\(string, string\) Method + +Запись данных в файл\. + +```csharp +private void WriteFile(string path, string content); +``` +#### Parameters + + + +`path` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +Путь к файлу\. + + + +`content` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +Содержимое, которе требуется записать в файл\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/AonprdRepository.md b/Documentation/Pf2eDataScrapper/AonprdRepository.md new file mode 100644 index 0000000..99bd5bb --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AonprdRepository.md @@ -0,0 +1,31 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd](Pf2eDataScrapper.Importers.Implementations.Aonprd.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd') + +## AonprdRepository Class + +Основной класс для работы с репозиторием данных Aonprd\. + +```csharp +internal class AonprdRepository : Pf2eDataScrapper.Importers.Repositories.AbstractImporterRepository +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [AbstractImporterRepository](AbstractImporterRepository.md 'Pf2eDataScrapper\.Importers\.Repositories\.AbstractImporterRepository') 🡒 AonprdRepository + +| Constructors | | +| :--- | :--- | +| [AonprdRepository\(AonprdImporter\)](AonprdRepository.AonprdRepository(AonprdImporter).md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.AonprdRepository\.AonprdRepository\(Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.AonprdImporter\)') | Основной класс для работы с репозиторием данных Aonprd\. | + +| Fields | | +| :--- | :--- | +| [SearchUrl](AonprdRepository.SearchUrl.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.AonprdRepository\.SearchUrl') | URL для доступа к API Aonprd\. | + +| Properties | | +| :--- | :--- | +| [Revision](AonprdRepository.Revision.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.AonprdRepository\.Revision') | Текущая ревизия данных\. Значение обновляется при обновлении репозитория\. | + +| Methods | | +| :--- | :--- | +| [CheckRevision\(\)](AonprdRepository.CheckRevision().md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.AonprdRepository\.CheckRevision\(\)') | Проверка актуальности данных\. | +| [Load\(string\)](AonprdRepository.Load(string).md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.AonprdRepository\.Load\(string\)') | Метод для загрузки данных из API Aonprd\. | +| [Update\(ProcessProgress\)](AonprdRepository.Update(ProcessProgress).md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.AonprdRepository\.Update\(Pf2eDataScrapper\.Helpers\.ProcessProgress\)') | Обновление данных в репозитории\. | +| [WriteFile\(string, string\)](AonprdRepository.WriteFile(string,string).md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.AonprdRepository\.WriteFile\(string, string\)') | Запись данных в файл\. | diff --git a/Documentation/Pf2eDataScrapper/AonprdTypeResolver.md b/Documentation/Pf2eDataScrapper/AonprdTypeResolver.md new file mode 100644 index 0000000..ac877fb --- /dev/null +++ b/Documentation/Pf2eDataScrapper/AonprdTypeResolver.md @@ -0,0 +1,12 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Preparation](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Preparation.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Preparation') + +## AonprdTypeResolver Class + +Класс для определения типа поля в схеме данных\. + +```csharp +internal class AonprdTypeResolver : Pf2eDataScrapper.SchemaBuilder.TypeResolver +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [TypeResolver](TypeResolver.md 'Pf2eDataScrapper\.SchemaBuilder\.TypeResolver') 🡒 AonprdTypeResolver \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ApparitionProcessor.AddFocal(string).md b/Documentation/Pf2eDataScrapper/ApparitionProcessor.AddFocal(string).md new file mode 100644 index 0000000..c2cf921 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ApparitionProcessor.AddFocal(string).md @@ -0,0 +1,15 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Subclasses](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Subclasses.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Subclasses').[ApparitionProcessor](ApparitionProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Subclasses\.ApparitionProcessor') + +## ApparitionProcessor\.AddFocal\(string\) Method + +Добавление заклинания сосуда\. + +```csharp +public void AddFocal(string description); +``` +#### Parameters + + + +`description` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ApparitionProcessor.AddSpells(string).md b/Documentation/Pf2eDataScrapper/ApparitionProcessor.AddSpells(string).md new file mode 100644 index 0000000..ca46311 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ApparitionProcessor.AddSpells(string).md @@ -0,0 +1,15 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Subclasses](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Subclasses.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Subclasses').[ApparitionProcessor](ApparitionProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Subclasses\.ApparitionProcessor') + +## ApparitionProcessor\.AddSpells\(string\) Method + +Добавление заклинаний\. + +```csharp +public void AddSpells(string spellMd); +``` +#### Parameters + + + +`spellMd` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ApparitionProcessor.AddTrainings(string).md b/Documentation/Pf2eDataScrapper/ApparitionProcessor.AddTrainings(string).md new file mode 100644 index 0000000..45a70e0 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ApparitionProcessor.AddTrainings(string).md @@ -0,0 +1,15 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Subclasses](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Subclasses.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Subclasses').[ApparitionProcessor](ApparitionProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Subclasses\.ApparitionProcessor') + +## ApparitionProcessor\.AddTrainings\(string\) Method + +Добавление тренировок\. + +```csharp +public void AddTrainings(string trainingMd); +``` +#### Parameters + + + +`trainingMd` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ApparitionProcessor.ClassName.md b/Documentation/Pf2eDataScrapper/ApparitionProcessor.ClassName.md new file mode 100644 index 0000000..280bcd9 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ApparitionProcessor.ClassName.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Subclasses](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Subclasses.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Subclasses').[ApparitionProcessor](ApparitionProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Subclasses\.ApparitionProcessor') + +## ApparitionProcessor\.ClassName Property + +Название подкласса\. + +```csharp +public override string ClassName { get; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ApparitionProcessor.GroupName.md b/Documentation/Pf2eDataScrapper/ApparitionProcessor.GroupName.md new file mode 100644 index 0000000..3136c74 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ApparitionProcessor.GroupName.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Subclasses](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Subclasses.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Subclasses').[ApparitionProcessor](ApparitionProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Subclasses\.ApparitionProcessor') + +## ApparitionProcessor\.GroupName Property + +Название группы подклассов\. + +```csharp +public override string GroupName { get; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ApparitionProcessor.Object.md b/Documentation/Pf2eDataScrapper/ApparitionProcessor.Object.md new file mode 100644 index 0000000..00b09a6 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ApparitionProcessor.Object.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Subclasses](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Subclasses.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Subclasses').[ApparitionProcessor](ApparitionProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Subclasses\.ApparitionProcessor') + +## ApparitionProcessor\.Object Property + +Основная сущность\. + +```csharp +public override Pf2eModel.Model.Structure.Subclass Object { get; } +``` + +#### Property Value +[Pf2eModel\.Model\.Structure\.Subclass](https://docs.microsoft.com/en-us/dotnet/api/Pf2eModel.Model.Structure.Subclass 'Pf2eModel\.Model\.Structure\.Subclass') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ApparitionProcessor.ProcessObject().md b/Documentation/Pf2eDataScrapper/ApparitionProcessor.ProcessObject().md new file mode 100644 index 0000000..d962318 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ApparitionProcessor.ProcessObject().md @@ -0,0 +1,10 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Subclasses](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Subclasses.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Subclasses').[ApparitionProcessor](ApparitionProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Subclasses\.ApparitionProcessor') + +## ApparitionProcessor\.ProcessObject\(\) Method + +Обработка полей подкласса\. + +```csharp +public override void ProcessObject(); +``` \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ApparitionProcessor.VesselSpellMarkdownRegex().md b/Documentation/Pf2eDataScrapper/ApparitionProcessor.VesselSpellMarkdownRegex().md new file mode 100644 index 0000000..cbf92ef --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ApparitionProcessor.VesselSpellMarkdownRegex().md @@ -0,0 +1,28 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Subclasses](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Subclasses.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Subclasses').[ApparitionProcessor](ApparitionProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Subclasses\.ApparitionProcessor') + +## ApparitionProcessor\.VesselSpellMarkdownRegex\(\) Method + +```csharp +private static System.Text.RegularExpressions.Regex VesselSpellMarkdownRegex(); +``` + +#### Returns +[System\.Text\.RegularExpressions\.Regex](https://docs.microsoft.com/en-us/dotnet/api/System.Text.RegularExpressions.Regex 'System\.Text\.RegularExpressions\.Regex') + +### Remarks +Pattern:
+ +```csharp +\\*\\*Vessel Spell\\*\\* \\[.*?\\]\\(/Spells\\.aspx\\?ID=(\\d+)\\) +```
+Explanation:
+ +```csharp +○ Match the string "**Vessel Spell** [".
+○ Match a character other than '\n' lazily any number of times.
+○ Match the string "](/Spells.aspx?ID=".
+○ 1st capture group.
+ ○ Match a Unicode digit atomically at least once.
+○ Match ')'.
+``` \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ApparitionProcessor.md b/Documentation/Pf2eDataScrapper/ApparitionProcessor.md new file mode 100644 index 0000000..1ce01e5 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ApparitionProcessor.md @@ -0,0 +1,24 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Subclasses](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Subclasses.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Subclasses') + +## ApparitionProcessor Class + +```csharp +internal class ApparitionProcessor : Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.AbstractSubclassProcessor +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [AbstractInputProcessor](AbstractInputProcessor.md 'Pf2eDataScrapper\.Processors\.Definitions\.AbstractInputProcessor') 🡒 [AbstractEntityProcessor](AbstractEntityProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.AbstractEntityProcessor') 🡒 [AbstractSubclassProcessor](AbstractSubclassProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.AbstractSubclassProcessor') 🡒 ApparitionProcessor + +| Properties | | +| :--- | :--- | +| [ClassName](ApparitionProcessor.ClassName.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Subclasses\.ApparitionProcessor\.ClassName') | Название подкласса\. | +| [GroupName](ApparitionProcessor.GroupName.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Subclasses\.ApparitionProcessor\.GroupName') | Название группы подклассов\. | +| [Object](ApparitionProcessor.Object.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Subclasses\.ApparitionProcessor\.Object') | Основная сущность\. | + +| Methods | | +| :--- | :--- | +| [AddFocal\(string\)](ApparitionProcessor.AddFocal(string).md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Subclasses\.ApparitionProcessor\.AddFocal\(string\)') | Добавление заклинания сосуда\. | +| [AddSpells\(string\)](ApparitionProcessor.AddSpells(string).md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Subclasses\.ApparitionProcessor\.AddSpells\(string\)') | Добавление заклинаний\. | +| [AddTrainings\(string\)](ApparitionProcessor.AddTrainings(string).md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Subclasses\.ApparitionProcessor\.AddTrainings\(string\)') | Добавление тренировок\. | +| [ProcessObject\(\)](ApparitionProcessor.ProcessObject().md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Subclasses\.ApparitionProcessor\.ProcessObject\(\)') | Обработка полей подкласса\. | +| [VesselSpellMarkdownRegex\(\)](ApparitionProcessor.VesselSpellMarkdownRegex().md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Subclasses\.ApparitionProcessor\.VesselSpellMarkdownRegex\(\)') | | diff --git a/Documentation/Pf2eDataScrapper/ApplicationSettings.ApplicationSettings().md b/Documentation/Pf2eDataScrapper/ApplicationSettings.ApplicationSettings().md new file mode 100644 index 0000000..3f5e774 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ApplicationSettings.ApplicationSettings().md @@ -0,0 +1,10 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper](Pf2eDataScrapper.md 'Pf2eDataScrapper').[ApplicationSettings](ApplicationSettings.md 'Pf2eDataScrapper\.ApplicationSettings') + +## ApplicationSettings\(\) Constructor + +Конструктор класса [ApplicationSettings](ApplicationSettings.md 'Pf2eDataScrapper\.ApplicationSettings')\. + +```csharp +public ApplicationSettings(); +``` \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ApplicationSettings.DataDir.md b/Documentation/Pf2eDataScrapper/ApplicationSettings.DataDir.md new file mode 100644 index 0000000..8c0a75f --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ApplicationSettings.DataDir.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper](Pf2eDataScrapper.md 'Pf2eDataScrapper').[ApplicationSettings](ApplicationSettings.md 'Pf2eDataScrapper\.ApplicationSettings') + +## ApplicationSettings\.DataDir Property + +Папка в входными данными\. + +```csharp +public System.IO.DirectoryInfo DataDir { get; } +``` + +#### Property Value +[System\.IO\.DirectoryInfo](https://docs.microsoft.com/en-us/dotnet/api/System.IO.DirectoryInfo 'System\.IO\.DirectoryInfo') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ApplicationSettings.DataDirPath.md b/Documentation/Pf2eDataScrapper/ApplicationSettings.DataDirPath.md new file mode 100644 index 0000000..b680e0f --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ApplicationSettings.DataDirPath.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper](Pf2eDataScrapper.md 'Pf2eDataScrapper').[ApplicationSettings](ApplicationSettings.md 'Pf2eDataScrapper\.ApplicationSettings') + +## ApplicationSettings\.DataDirPath Property + +Путь к папке с входными данными\. + +```csharp +public string DataDirPath { get; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ApplicationSettings.DatabaseConnection.md b/Documentation/Pf2eDataScrapper/ApplicationSettings.DatabaseConnection.md new file mode 100644 index 0000000..158c150 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ApplicationSettings.DatabaseConnection.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper](Pf2eDataScrapper.md 'Pf2eDataScrapper').[ApplicationSettings](ApplicationSettings.md 'Pf2eDataScrapper\.ApplicationSettings') + +## ApplicationSettings\.DatabaseConnection Property + +Строка подключения к базе данных\. + +```csharp +public string DatabaseConnection { get; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ApplicationSettings.MaxThreads.md b/Documentation/Pf2eDataScrapper/ApplicationSettings.MaxThreads.md new file mode 100644 index 0000000..ea80a6c --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ApplicationSettings.MaxThreads.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper](Pf2eDataScrapper.md 'Pf2eDataScrapper').[ApplicationSettings](ApplicationSettings.md 'Pf2eDataScrapper\.ApplicationSettings') + +## ApplicationSettings\.MaxThreads Property + +Максимальное количество потоков\. + +```csharp +public int MaxThreads { get; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ApplicationSettings.OutputDir.md b/Documentation/Pf2eDataScrapper/ApplicationSettings.OutputDir.md new file mode 100644 index 0000000..79c08ca --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ApplicationSettings.OutputDir.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper](Pf2eDataScrapper.md 'Pf2eDataScrapper').[ApplicationSettings](ApplicationSettings.md 'Pf2eDataScrapper\.ApplicationSettings') + +## ApplicationSettings\.OutputDir Property + +Папка для сохранения результатов\. + +```csharp +public string OutputDir { get; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ApplicationSettings.OutputDirPath.md b/Documentation/Pf2eDataScrapper/ApplicationSettings.OutputDirPath.md new file mode 100644 index 0000000..ab12f51 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ApplicationSettings.OutputDirPath.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper](Pf2eDataScrapper.md 'Pf2eDataScrapper').[ApplicationSettings](ApplicationSettings.md 'Pf2eDataScrapper\.ApplicationSettings') + +## ApplicationSettings\.OutputDirPath Property + +Путь к папке для сохранения результатов\. + +```csharp +public string OutputDirPath { get; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ApplicationSettings.md b/Documentation/Pf2eDataScrapper/ApplicationSettings.md new file mode 100644 index 0000000..4d767eb --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ApplicationSettings.md @@ -0,0 +1,25 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper](Pf2eDataScrapper.md 'Pf2eDataScrapper') + +## ApplicationSettings Class + +Настройки программы\. + +```csharp +internal class ApplicationSettings +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 ApplicationSettings + +| Constructors | | +| :--- | :--- | +| [ApplicationSettings\(\)](ApplicationSettings.ApplicationSettings().md 'Pf2eDataScrapper\.ApplicationSettings\.ApplicationSettings\(\)') | Конструктор класса [ApplicationSettings](ApplicationSettings.md 'Pf2eDataScrapper\.ApplicationSettings')\. | + +| Properties | | +| :--- | :--- | +| [DatabaseConnection](ApplicationSettings.DatabaseConnection.md 'Pf2eDataScrapper\.ApplicationSettings\.DatabaseConnection') | Строка подключения к базе данных\. | +| [DataDir](ApplicationSettings.DataDir.md 'Pf2eDataScrapper\.ApplicationSettings\.DataDir') | Папка в входными данными\. | +| [DataDirPath](ApplicationSettings.DataDirPath.md 'Pf2eDataScrapper\.ApplicationSettings\.DataDirPath') | Путь к папке с входными данными\. | +| [MaxThreads](ApplicationSettings.MaxThreads.md 'Pf2eDataScrapper\.ApplicationSettings\.MaxThreads') | Максимальное количество потоков\. | +| [OutputDir](ApplicationSettings.OutputDir.md 'Pf2eDataScrapper\.ApplicationSettings\.OutputDir') | Папка для сохранения результатов\. | +| [OutputDirPath](ApplicationSettings.OutputDirPath.md 'Pf2eDataScrapper\.ApplicationSettings\.OutputDirPath') | Путь к папке для сохранения результатов\. | diff --git a/Documentation/Pf2eDataScrapper/ArchetypeProcessor.Add().md b/Documentation/Pf2eDataScrapper/ArchetypeProcessor.Add().md new file mode 100644 index 0000000..f820fe5 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ArchetypeProcessor.Add().md @@ -0,0 +1,10 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types').[ArchetypeProcessor](ArchetypeProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.ArchetypeProcessor') + +## ArchetypeProcessor\.Add\(\) Method + +Добавление основной сущности в контекст базы данных\. + +```csharp +protected override void Add(); +``` \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ArchetypeProcessor.AddedDescriptionPaths().md b/Documentation/Pf2eDataScrapper/ArchetypeProcessor.AddedDescriptionPaths().md new file mode 100644 index 0000000..80ea683 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ArchetypeProcessor.AddedDescriptionPaths().md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types').[ArchetypeProcessor](ArchetypeProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.ArchetypeProcessor') + +## ArchetypeProcessor\.AddedDescriptionPaths\(\) Method + +Получение списка полей, которые должны быть добавлены в описание\. + +```csharp +protected virtual string[] AddedDescriptionPaths(); +``` + +#### Returns +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String')[\[\]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System\.Array') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ArchetypeProcessor.Object.md b/Documentation/Pf2eDataScrapper/ArchetypeProcessor.Object.md new file mode 100644 index 0000000..d78e280 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ArchetypeProcessor.Object.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types').[ArchetypeProcessor](ArchetypeProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.ArchetypeProcessor') + +## ArchetypeProcessor\.Object Property + +Основная сущность\. + +```csharp +public virtual Pf2eModel.Model.Structure.Archetype Object { get; } +``` + +#### Property Value +[Pf2eModel\.Model\.Structure\.Archetype](https://docs.microsoft.com/en-us/dotnet/api/Pf2eModel.Model.Structure.Archetype 'Pf2eModel\.Model\.Structure\.Archetype') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ArchetypeProcessor.Process().md b/Documentation/Pf2eDataScrapper/ArchetypeProcessor.Process().md new file mode 100644 index 0000000..87b49ed --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ArchetypeProcessor.Process().md @@ -0,0 +1,12 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types').[ArchetypeProcessor](ArchetypeProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.ArchetypeProcessor') + +## ArchetypeProcessor\.Process\(\) Method + +Основной метод обработки данных\. + +```csharp +public override void Process(); +``` + +Implements [Process\(\)](IProcessor.Process().md 'Pf2eDataScrapper\.Processors\.Definitions\.IProcessor\.Process\(\)') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ArchetypeProcessor.Type.md b/Documentation/Pf2eDataScrapper/ArchetypeProcessor.Type.md new file mode 100644 index 0000000..dd41ebe --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ArchetypeProcessor.Type.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types').[ArchetypeProcessor](ArchetypeProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.ArchetypeProcessor') + +## ArchetypeProcessor\.Type Property + +Тип сущности\. + +```csharp +public override Pf2eModel.Model.Enum.EntityType Type { get; } +``` + +#### Property Value +[Pf2eModel\.Model\.Enum\.EntityType](https://docs.microsoft.com/en-us/dotnet/api/Pf2eModel.Model.Enum.EntityType 'Pf2eModel\.Model\.Enum\.EntityType') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ArchetypeProcessor.md b/Documentation/Pf2eDataScrapper/ArchetypeProcessor.md new file mode 100644 index 0000000..cbb59ee --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ArchetypeProcessor.md @@ -0,0 +1,21 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types') + +## ArchetypeProcessor Class + +```csharp +internal class ArchetypeProcessor : Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.AbstractEntityProcessor +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [AbstractInputProcessor](AbstractInputProcessor.md 'Pf2eDataScrapper\.Processors\.Definitions\.AbstractInputProcessor') 🡒 [AbstractEntityProcessor](AbstractEntityProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.AbstractEntityProcessor') 🡒 ArchetypeProcessor + +| Properties | | +| :--- | :--- | +| [Object](ArchetypeProcessor.Object.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.ArchetypeProcessor\.Object') | Основная сущность\. | +| [Type](ArchetypeProcessor.Type.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.ArchetypeProcessor\.Type') | Тип сущности\. | + +| Methods | | +| :--- | :--- | +| [Add\(\)](ArchetypeProcessor.Add().md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.ArchetypeProcessor\.Add\(\)') | Добавление основной сущности в контекст базы данных\. | +| [AddedDescriptionPaths\(\)](ArchetypeProcessor.AddedDescriptionPaths().md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.ArchetypeProcessor\.AddedDescriptionPaths\(\)') | Получение списка полей, которые должны быть добавлены в описание\. | +| [Process\(\)](ArchetypeProcessor.Process().md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.ArchetypeProcessor\.Process\(\)') | Основной метод обработки данных\. | diff --git a/Documentation/Pf2eDataScrapper/ArraySchemaType.AddValue(JToken).md b/Documentation/Pf2eDataScrapper/ArraySchemaType.AddValue(JToken).md new file mode 100644 index 0000000..a4c0e70 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ArraySchemaType.AddValue(JToken).md @@ -0,0 +1,17 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder\.Types](Pf2eDataScrapper.SchemaBuilder.Types.md 'Pf2eDataScrapper\.SchemaBuilder\.Types').[ArraySchemaType](ArraySchemaType.md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.ArraySchemaType') + +## ArraySchemaType\.AddValue\(JToken\) Method + +Добавление нового значения\. + +```csharp +public override void AddValue(Newtonsoft.Json.Linq.JToken value); +``` +#### Parameters + + + +`value` [Newtonsoft\.Json\.Linq\.JToken](https://docs.microsoft.com/en-us/dotnet/api/Newtonsoft.Json.Linq.JToken 'Newtonsoft\.Json\.Linq\.JToken') + +Новое значение\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ArraySchemaType.ArraySchemaType(SchemaNode).md b/Documentation/Pf2eDataScrapper/ArraySchemaType.ArraySchemaType(SchemaNode).md new file mode 100644 index 0000000..c2cf86c --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ArraySchemaType.ArraySchemaType(SchemaNode).md @@ -0,0 +1,17 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder\.Types](Pf2eDataScrapper.SchemaBuilder.Types.md 'Pf2eDataScrapper\.SchemaBuilder\.Types').[ArraySchemaType](ArraySchemaType.md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.ArraySchemaType') + +## ArraySchemaType\(SchemaNode\) Constructor + +Тип представоления массива в схеме\. + +```csharp +public ArraySchemaType(Pf2eDataScrapper.SchemaBuilder.SchemaNode parent); +``` +#### Parameters + + + +`parent` [SchemaNode](SchemaNode.md 'Pf2eDataScrapper\.SchemaBuilder\.SchemaNode') + +Элемент, к которому добавляется тип\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ArraySchemaType.Beautify().md b/Documentation/Pf2eDataScrapper/ArraySchemaType.Beautify().md new file mode 100644 index 0000000..825d092 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ArraySchemaType.Beautify().md @@ -0,0 +1,10 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder\.Types](Pf2eDataScrapper.SchemaBuilder.Types.md 'Pf2eDataScrapper\.SchemaBuilder\.Types').[ArraySchemaType](ArraySchemaType.md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.ArraySchemaType') + +## ArraySchemaType\.Beautify\(\) Method + +Подготовка типа к красивому представлению\. + +```csharp +public override void Beautify(); +``` \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ArraySchemaType.ElementSchema.md b/Documentation/Pf2eDataScrapper/ArraySchemaType.ElementSchema.md new file mode 100644 index 0000000..f67edba --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ArraySchemaType.ElementSchema.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder\.Types](Pf2eDataScrapper.SchemaBuilder.Types.md 'Pf2eDataScrapper\.SchemaBuilder\.Types').[ArraySchemaType](ArraySchemaType.md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.ArraySchemaType') + +## ArraySchemaType\.ElementSchema Field + +Схема элемента массива\. + +```csharp +protected readonly SchemaNode ElementSchema; +``` + +#### Field Value +[SchemaNode](SchemaNode.md 'Pf2eDataScrapper\.SchemaBuilder\.SchemaNode') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ArraySchemaType.GetTypeName().md b/Documentation/Pf2eDataScrapper/ArraySchemaType.GetTypeName().md new file mode 100644 index 0000000..94db9c1 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ArraySchemaType.GetTypeName().md @@ -0,0 +1,14 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder\.Types](Pf2eDataScrapper.SchemaBuilder.Types.md 'Pf2eDataScrapper\.SchemaBuilder\.Types').[ArraySchemaType](ArraySchemaType.md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.ArraySchemaType') + +## ArraySchemaType\.GetTypeName\(\) Method + +Получение строкового представоения типа элемента\. + +```csharp +public override string GetTypeName(); +``` + +#### Returns +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') +Строковое представоение типа элемента \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ArraySchemaType.GetYamlData().md b/Documentation/Pf2eDataScrapper/ArraySchemaType.GetYamlData().md new file mode 100644 index 0000000..bddf190 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ArraySchemaType.GetYamlData().md @@ -0,0 +1,14 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder\.Types](Pf2eDataScrapper.SchemaBuilder.Types.md 'Pf2eDataScrapper\.SchemaBuilder\.Types').[ArraySchemaType](ArraySchemaType.md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.ArraySchemaType') + +## ArraySchemaType\.GetYamlData\(\) Method + +Получение данных для форматирования в YAML\. + +```csharp +public override System.Collections.Generic.Dictionary GetYamlData(); +``` + +#### Returns +[System\.Collections\.Generic\.Dictionary<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.Dictionary-2 'System\.Collections\.Generic\.Dictionary\`2')[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.Dictionary-2 'System\.Collections\.Generic\.Dictionary\`2')[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.Dictionary-2 'System\.Collections\.Generic\.Dictionary\`2') +Словарь данных \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ArraySchemaType.IsCompatibleValue(JToken).md b/Documentation/Pf2eDataScrapper/ArraySchemaType.IsCompatibleValue(JToken).md new file mode 100644 index 0000000..4d10b4d --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ArraySchemaType.IsCompatibleValue(JToken).md @@ -0,0 +1,21 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder\.Types](Pf2eDataScrapper.SchemaBuilder.Types.md 'Pf2eDataScrapper\.SchemaBuilder\.Types').[ArraySchemaType](ArraySchemaType.md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.ArraySchemaType') + +## ArraySchemaType\.IsCompatibleValue\(JToken\) Method + +Проверка, что значение совместимо с текущим типом\. + +```csharp +public override bool IsCompatibleValue(Newtonsoft.Json.Linq.JToken value); +``` +#### Parameters + + + +`value` [Newtonsoft\.Json\.Linq\.JToken](https://docs.microsoft.com/en-us/dotnet/api/Newtonsoft.Json.Linq.JToken 'Newtonsoft\.Json\.Linq\.JToken') + +Проверяемое значение\. + +#### Returns +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') +\`true\`, если значение совместимо с текущим типом\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ArraySchemaType.MaxCount.md b/Documentation/Pf2eDataScrapper/ArraySchemaType.MaxCount.md new file mode 100644 index 0000000..8bdfc05 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ArraySchemaType.MaxCount.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder\.Types](Pf2eDataScrapper.SchemaBuilder.Types.md 'Pf2eDataScrapper\.SchemaBuilder\.Types').[ArraySchemaType](ArraySchemaType.md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.ArraySchemaType') + +## ArraySchemaType\.MaxCount Field + +Максимальное количество элементов в массиве\. + +```csharp +public int MaxCount; +``` + +#### Field Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ArraySchemaType.MinCount.md b/Documentation/Pf2eDataScrapper/ArraySchemaType.MinCount.md new file mode 100644 index 0000000..f09acc2 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ArraySchemaType.MinCount.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder\.Types](Pf2eDataScrapper.SchemaBuilder.Types.md 'Pf2eDataScrapper\.SchemaBuilder\.Types').[ArraySchemaType](ArraySchemaType.md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.ArraySchemaType') + +## ArraySchemaType\.MinCount Field + +Минимальное количество элементов в массиве\. + +```csharp +public int MinCount; +``` + +#### Field Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ArraySchemaType.md b/Documentation/Pf2eDataScrapper/ArraySchemaType.md new file mode 100644 index 0000000..30ebfe5 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ArraySchemaType.md @@ -0,0 +1,30 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder\.Types](Pf2eDataScrapper.SchemaBuilder.Types.md 'Pf2eDataScrapper\.SchemaBuilder\.Types') + +## ArraySchemaType Class + +Тип представоления массива в схеме\. + +```csharp +internal class ArraySchemaType : Pf2eDataScrapper.SchemaBuilder.Types.AbstractSchemaType +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [AbstractSchemaType](AbstractSchemaType.md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.AbstractSchemaType') 🡒 ArraySchemaType + +| Constructors | | +| :--- | :--- | +| [ArraySchemaType\(SchemaNode\)](ArraySchemaType.ArraySchemaType(SchemaNode).md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.ArraySchemaType\.ArraySchemaType\(Pf2eDataScrapper\.SchemaBuilder\.SchemaNode\)') | Тип представоления массива в схеме\. | + +| Fields | | +| :--- | :--- | +| [ElementSchema](ArraySchemaType.ElementSchema.md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.ArraySchemaType\.ElementSchema') | Схема элемента массива\. | +| [MaxCount](ArraySchemaType.MaxCount.md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.ArraySchemaType\.MaxCount') | Максимальное количество элементов в массиве\. | +| [MinCount](ArraySchemaType.MinCount.md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.ArraySchemaType\.MinCount') | Минимальное количество элементов в массиве\. | + +| Methods | | +| :--- | :--- | +| [AddValue\(JToken\)](ArraySchemaType.AddValue(JToken).md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.ArraySchemaType\.AddValue\(Newtonsoft\.Json\.Linq\.JToken\)') | Добавление нового значения\. | +| [Beautify\(\)](ArraySchemaType.Beautify().md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.ArraySchemaType\.Beautify\(\)') | Подготовка типа к красивому представлению\. | +| [GetTypeName\(\)](ArraySchemaType.GetTypeName().md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.ArraySchemaType\.GetTypeName\(\)') | Получение строкового представоения типа элемента\. | +| [GetYamlData\(\)](ArraySchemaType.GetYamlData().md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.ArraySchemaType\.GetYamlData\(\)') | Получение данных для форматирования в YAML\. | +| [IsCompatibleValue\(JToken\)](ArraySchemaType.IsCompatibleValue(JToken).md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.ArraySchemaType\.IsCompatibleValue\(Newtonsoft\.Json\.Linq\.JToken\)') | Проверка, что значение совместимо с текущим типом\. | diff --git a/Documentation/Pf2eDataScrapper/BackgroundProcessor.Add().md b/Documentation/Pf2eDataScrapper/BackgroundProcessor.Add().md new file mode 100644 index 0000000..237b6f9 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/BackgroundProcessor.Add().md @@ -0,0 +1,10 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types').[BackgroundProcessor](BackgroundProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.BackgroundProcessor') + +## BackgroundProcessor\.Add\(\) Method + +Добавление основной сущности в контекст базы данных\. + +```csharp +protected override void Add(); +``` \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/BackgroundProcessor.AddedDescriptionPaths().md b/Documentation/Pf2eDataScrapper/BackgroundProcessor.AddedDescriptionPaths().md new file mode 100644 index 0000000..eee89cc --- /dev/null +++ b/Documentation/Pf2eDataScrapper/BackgroundProcessor.AddedDescriptionPaths().md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types').[BackgroundProcessor](BackgroundProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.BackgroundProcessor') + +## BackgroundProcessor\.AddedDescriptionPaths\(\) Method + +Получение списка полей, которые должны быть добавлены в описание\. + +```csharp +protected virtual string[] AddedDescriptionPaths(); +``` + +#### Returns +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String')[\[\]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System\.Array') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/BackgroundProcessor.Object.md b/Documentation/Pf2eDataScrapper/BackgroundProcessor.Object.md new file mode 100644 index 0000000..ef61533 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/BackgroundProcessor.Object.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types').[BackgroundProcessor](BackgroundProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.BackgroundProcessor') + +## BackgroundProcessor\.Object Property + +Основная сущность\. + +```csharp +public virtual Pf2eModel.Model.Structure.Background Object { get; } +``` + +#### Property Value +[Pf2eModel\.Model\.Structure\.Background](https://docs.microsoft.com/en-us/dotnet/api/Pf2eModel.Model.Structure.Background 'Pf2eModel\.Model\.Structure\.Background') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/BackgroundProcessor.Process().md b/Documentation/Pf2eDataScrapper/BackgroundProcessor.Process().md new file mode 100644 index 0000000..ee04c8a --- /dev/null +++ b/Documentation/Pf2eDataScrapper/BackgroundProcessor.Process().md @@ -0,0 +1,12 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types').[BackgroundProcessor](BackgroundProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.BackgroundProcessor') + +## BackgroundProcessor\.Process\(\) Method + +Основной метод обработки данных\. + +```csharp +public override void Process(); +``` + +Implements [Process\(\)](IProcessor.Process().md 'Pf2eDataScrapper\.Processors\.Definitions\.IProcessor\.Process\(\)') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/BackgroundProcessor.Type.md b/Documentation/Pf2eDataScrapper/BackgroundProcessor.Type.md new file mode 100644 index 0000000..4b8ae2a --- /dev/null +++ b/Documentation/Pf2eDataScrapper/BackgroundProcessor.Type.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types').[BackgroundProcessor](BackgroundProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.BackgroundProcessor') + +## BackgroundProcessor\.Type Property + +Тип сущности\. + +```csharp +public override Pf2eModel.Model.Enum.EntityType Type { get; } +``` + +#### Property Value +[Pf2eModel\.Model\.Enum\.EntityType](https://docs.microsoft.com/en-us/dotnet/api/Pf2eModel.Model.Enum.EntityType 'Pf2eModel\.Model\.Enum\.EntityType') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/BackgroundProcessor.md b/Documentation/Pf2eDataScrapper/BackgroundProcessor.md new file mode 100644 index 0000000..c78d62e --- /dev/null +++ b/Documentation/Pf2eDataScrapper/BackgroundProcessor.md @@ -0,0 +1,21 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types') + +## BackgroundProcessor Class + +```csharp +internal class BackgroundProcessor : Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.AbstractEntityProcessor +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [AbstractInputProcessor](AbstractInputProcessor.md 'Pf2eDataScrapper\.Processors\.Definitions\.AbstractInputProcessor') 🡒 [AbstractEntityProcessor](AbstractEntityProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.AbstractEntityProcessor') 🡒 BackgroundProcessor + +| Properties | | +| :--- | :--- | +| [Object](BackgroundProcessor.Object.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.BackgroundProcessor\.Object') | Основная сущность\. | +| [Type](BackgroundProcessor.Type.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.BackgroundProcessor\.Type') | Тип сущности\. | + +| Methods | | +| :--- | :--- | +| [Add\(\)](BackgroundProcessor.Add().md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.BackgroundProcessor\.Add\(\)') | Добавление основной сущности в контекст базы данных\. | +| [AddedDescriptionPaths\(\)](BackgroundProcessor.AddedDescriptionPaths().md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.BackgroundProcessor\.AddedDescriptionPaths\(\)') | Получение списка полей, которые должны быть добавлены в описание\. | +| [Process\(\)](BackgroundProcessor.Process().md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.BackgroundProcessor\.Process\(\)') | Основной метод обработки данных\. | diff --git a/Documentation/Pf2eDataScrapper/ClassProcessor.Add().md b/Documentation/Pf2eDataScrapper/ClassProcessor.Add().md new file mode 100644 index 0000000..32bc8c4 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ClassProcessor.Add().md @@ -0,0 +1,10 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types').[ClassProcessor](ClassProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.ClassProcessor') + +## ClassProcessor\.Add\(\) Method + +Добавление основной сущности в контекст базы данных\. + +```csharp +protected override void Add(); +``` \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ClassProcessor.GetSaveTrainings().md b/Documentation/Pf2eDataScrapper/ClassProcessor.GetSaveTrainings().md new file mode 100644 index 0000000..5736421 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ClassProcessor.GetSaveTrainings().md @@ -0,0 +1,14 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types').[ClassProcessor](ClassProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.ClassProcessor') + +## ClassProcessor\.GetSaveTrainings\(\) Method + +Получение CLR\-представления обучений спасброскам\. + +```csharp +protected System.Collections.Generic.ICollection GetSaveTrainings(); +``` + +#### Returns +[System\.Collections\.Generic\.ICollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1')[Pf2eModel\.Model\.Structure\.ClassRelation\.ClassTraining](https://docs.microsoft.com/en-us/dotnet/api/Pf2eModel.Model.Structure.ClassRelation.ClassTraining 'Pf2eModel\.Model\.Structure\.ClassRelation\.ClassTraining')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1') +Коллекция обучений\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ClassProcessor.GetSkillTrainings().md b/Documentation/Pf2eDataScrapper/ClassProcessor.GetSkillTrainings().md new file mode 100644 index 0000000..0b13562 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ClassProcessor.GetSkillTrainings().md @@ -0,0 +1,14 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types').[ClassProcessor](ClassProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.ClassProcessor') + +## ClassProcessor\.GetSkillTrainings\(\) Method + +Получение коллекции обучений, связанных с классом\. + +```csharp +protected System.Collections.Generic.ICollection GetSkillTrainings(); +``` + +#### Returns +[System\.Collections\.Generic\.ICollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1')[Pf2eModel\.Model\.Structure\.ClassRelation\.ClassTraining](https://docs.microsoft.com/en-us/dotnet/api/Pf2eModel.Model.Structure.ClassRelation.ClassTraining 'Pf2eModel\.Model\.Structure\.ClassRelation\.ClassTraining')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1') +Коллекция обучения\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ClassProcessor.GetTrainingString(string).md b/Documentation/Pf2eDataScrapper/ClassProcessor.GetTrainingString(string).md new file mode 100644 index 0000000..227d7e6 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ClassProcessor.GetTrainingString(string).md @@ -0,0 +1,21 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types').[ClassProcessor](ClassProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.ClassProcessor') + +## ClassProcessor\.GetTrainingString\(string\) Method + +Получение коллекции названий обучений из строкового представления из Архивов Нефиса\. + +```csharp +protected System.Collections.Generic.ICollection GetTrainingString(string value); +``` +#### Parameters + + + +`value` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +Строковое представление обучений из Архивов Нефиса\. + +#### Returns +[System\.Collections\.Generic\.ICollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1')[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1') +Коллекция названий обучений\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ClassProcessor.Object.md b/Documentation/Pf2eDataScrapper/ClassProcessor.Object.md new file mode 100644 index 0000000..3b25f92 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ClassProcessor.Object.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types').[ClassProcessor](ClassProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.ClassProcessor') + +## ClassProcessor\.Object Property + +Основная сущность\. + +```csharp +public virtual Pf2eModel.Model.Structure.Class Object { get; } +``` + +#### Property Value +[Pf2eModel\.Model\.Structure\.Class](https://docs.microsoft.com/en-us/dotnet/api/Pf2eModel.Model.Structure.Class 'Pf2eModel\.Model\.Structure\.Class') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ClassProcessor.Process().md b/Documentation/Pf2eDataScrapper/ClassProcessor.Process().md new file mode 100644 index 0000000..8a0479d --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ClassProcessor.Process().md @@ -0,0 +1,12 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types').[ClassProcessor](ClassProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.ClassProcessor') + +## ClassProcessor\.Process\(\) Method + +Основной метод обработки данных\. + +```csharp +public override void Process(); +``` + +Implements [Process\(\)](IProcessor.Process().md 'Pf2eDataScrapper\.Processors\.Definitions\.IProcessor\.Process\(\)') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ClassProcessor.ProcessClassTrait().md b/Documentation/Pf2eDataScrapper/ClassProcessor.ProcessClassTrait().md new file mode 100644 index 0000000..811b065 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ClassProcessor.ProcessClassTrait().md @@ -0,0 +1,10 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types').[ClassProcessor](ClassProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.ClassProcessor') + +## ClassProcessor\.ProcessClassTrait\(\) Method + +Объявление соотеветсвующего классу признака классовым\. + +```csharp +protected void ProcessClassTrait(); +``` \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ClassProcessor.ProcessTraining(JArray,TrainingType).md b/Documentation/Pf2eDataScrapper/ClassProcessor.ProcessTraining(JArray,TrainingType).md new file mode 100644 index 0000000..436379f --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ClassProcessor.ProcessTraining(JArray,TrainingType).md @@ -0,0 +1,27 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types').[ClassProcessor](ClassProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.ClassProcessor') + +## ClassProcessor\.ProcessTraining\(JArray, TrainingType\) Method + +Обработка массива со списком обучений\. + +```csharp +protected System.Collections.Generic.ICollection ProcessTraining(Newtonsoft.Json.Linq.JArray array, Pf2eModel.Model.Enum.TrainingType type); +``` +#### Parameters + + + +`array` [Newtonsoft\.Json\.Linq\.JArray](https://docs.microsoft.com/en-us/dotnet/api/Newtonsoft.Json.Linq.JArray 'Newtonsoft\.Json\.Linq\.JArray') + +JSON\-массив обучений\. + + + +`type` [Pf2eModel\.Model\.Enum\.TrainingType](https://docs.microsoft.com/en-us/dotnet/api/Pf2eModel.Model.Enum.TrainingType 'Pf2eModel\.Model\.Enum\.TrainingType') + +Тип обучения\. + +#### Returns +[System\.Collections\.Generic\.ICollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1')[Pf2eModel\.Model\.Structure\.ClassRelation\.ClassTraining](https://docs.microsoft.com/en-us/dotnet/api/Pf2eModel.Model.Structure.ClassRelation.ClassTraining 'Pf2eModel\.Model\.Structure\.ClassRelation\.ClassTraining')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1') +Коллекция обучений\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ClassProcessor.TrainingStringSeparatorRegex().md b/Documentation/Pf2eDataScrapper/ClassProcessor.TrainingStringSeparatorRegex().md new file mode 100644 index 0000000..1326820 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ClassProcessor.TrainingStringSeparatorRegex().md @@ -0,0 +1,27 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types').[ClassProcessor](ClassProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.ClassProcessor') + +## ClassProcessor\.TrainingStringSeparatorRegex\(\) Method + +```csharp +protected static System.Text.RegularExpressions.Regex TrainingStringSeparatorRegex(); +``` + +#### Returns +[System\.Text\.RegularExpressions\.Regex](https://docs.microsoft.com/en-us/dotnet/api/System.Text.RegularExpressions.Regex 'System\.Text\.RegularExpressions\.Regex') + +### Remarks +Pattern:
+ +```csharp +\\s*(?:,|and)\\s* +```
+Explanation:
+ +```csharp +○ Match a whitespace character atomically any number of times.
+○ Match with 2 alternative expressions.
+ ○ Match ','.
+ ○ Match the string "and".
+○ Match a whitespace character atomically any number of times.
+``` \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ClassProcessor.Type.md b/Documentation/Pf2eDataScrapper/ClassProcessor.Type.md new file mode 100644 index 0000000..11127da --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ClassProcessor.Type.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types').[ClassProcessor](ClassProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.ClassProcessor') + +## ClassProcessor\.Type Property + +Тип сущности\. + +```csharp +public override Pf2eModel.Model.Enum.EntityType Type { get; } +``` + +#### Property Value +[Pf2eModel\.Model\.Enum\.EntityType](https://docs.microsoft.com/en-us/dotnet/api/Pf2eModel.Model.Enum.EntityType 'Pf2eModel\.Model\.Enum\.EntityType') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ClassProcessor.md b/Documentation/Pf2eDataScrapper/ClassProcessor.md new file mode 100644 index 0000000..945dc2b --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ClassProcessor.md @@ -0,0 +1,26 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types') + +## ClassProcessor Class + +```csharp +internal class ClassProcessor : Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.AbstractEntityProcessor +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [AbstractInputProcessor](AbstractInputProcessor.md 'Pf2eDataScrapper\.Processors\.Definitions\.AbstractInputProcessor') 🡒 [AbstractEntityProcessor](AbstractEntityProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.AbstractEntityProcessor') 🡒 ClassProcessor + +| Properties | | +| :--- | :--- | +| [Object](ClassProcessor.Object.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.ClassProcessor\.Object') | Основная сущность\. | +| [Type](ClassProcessor.Type.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.ClassProcessor\.Type') | Тип сущности\. | + +| Methods | | +| :--- | :--- | +| [Add\(\)](ClassProcessor.Add().md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.ClassProcessor\.Add\(\)') | Добавление основной сущности в контекст базы данных\. | +| [GetSaveTrainings\(\)](ClassProcessor.GetSaveTrainings().md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.ClassProcessor\.GetSaveTrainings\(\)') | Получение CLR\-представления обучений спасброскам\. | +| [GetSkillTrainings\(\)](ClassProcessor.GetSkillTrainings().md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.ClassProcessor\.GetSkillTrainings\(\)') | Получение коллекции обучений, связанных с классом\. | +| [GetTrainingString\(string\)](ClassProcessor.GetTrainingString(string).md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.ClassProcessor\.GetTrainingString\(string\)') | Получение коллекции названий обучений из строкового представления из Архивов Нефиса\. | +| [Process\(\)](ClassProcessor.Process().md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.ClassProcessor\.Process\(\)') | Основной метод обработки данных\. | +| [ProcessClassTrait\(\)](ClassProcessor.ProcessClassTrait().md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.ClassProcessor\.ProcessClassTrait\(\)') | Объявление соотеветсвующего классу признака классовым\. | +| [ProcessTraining\(JArray, TrainingType\)](ClassProcessor.ProcessTraining(JArray,TrainingType).md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.ClassProcessor\.ProcessTraining\(Newtonsoft\.Json\.Linq\.JArray, Pf2eModel\.Model\.Enum\.TrainingType\)') | Обработка массива со списком обучений\. | +| [TrainingStringSeparatorRegex\(\)](ClassProcessor.TrainingStringSeparatorRegex().md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.ClassProcessor\.TrainingStringSeparatorRegex\(\)') | | diff --git a/Documentation/Pf2eDataScrapper/CollapseCommand.CanExecute(object).md b/Documentation/Pf2eDataScrapper/CollapseCommand.CanExecute(object).md new file mode 100644 index 0000000..d2e6725 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/CollapseCommand.CanExecute(object).md @@ -0,0 +1,23 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[CollapseCommand](CollapseCommand.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.CollapseCommand') + +## CollapseCommand\.CanExecute\(object\) Method + +Проверяет, может ли команда быть выполнена с указанным параметром\. + +```csharp +public bool CanExecute(object? parameter); +``` +#### Parameters + + + +`parameter` [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') + +Параметр, передаваемый команде\. + +Implements [CanExecute\(object\)](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.Input.ICommand.CanExecute#System_Windows_Input_ICommand_CanExecute_System_Object_ 'System\.Windows\.Input\.ICommand\.CanExecute\(System\.Object\)') + +#### Returns +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') +`true`, если команда может быть выполнена; в противном случае `false`\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/CollapseCommand.CanExecuteChanged.md b/Documentation/Pf2eDataScrapper/CollapseCommand.CanExecuteChanged.md new file mode 100644 index 0000000..88f5c3f --- /dev/null +++ b/Documentation/Pf2eDataScrapper/CollapseCommand.CanExecuteChanged.md @@ -0,0 +1,15 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[CollapseCommand](CollapseCommand.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.CollapseCommand') + +## CollapseCommand\.CanExecuteChanged Event + +Событие, вызываемое при изменении возможности выполнения команды\. + +```csharp +public event EventHandler? CanExecuteChanged; +``` + +Implements [CanExecuteChanged](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.Input.ICommand.CanExecuteChanged 'System\.Windows\.Input\.ICommand\.CanExecuteChanged') + +#### Event Type +[System\.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System\.EventHandler') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/CollapseCommand.CollapseCommand(StructureRow).md b/Documentation/Pf2eDataScrapper/CollapseCommand.CollapseCommand(StructureRow).md new file mode 100644 index 0000000..cab1538 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/CollapseCommand.CollapseCommand(StructureRow).md @@ -0,0 +1,17 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[CollapseCommand](CollapseCommand.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.CollapseCommand') + +## CollapseCommand\(StructureRow\) Constructor + +Команда для сворачивания/разворачивания поля структуры\. + +```csharp +public CollapseCommand(Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.StructureRow structureRow); +``` +#### Parameters + + + +`structureRow` [StructureRow](StructureRow.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureRow') + +Строка структуры, содержащая поле\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/CollapseCommand.Execute(object).md b/Documentation/Pf2eDataScrapper/CollapseCommand.Execute(object).md new file mode 100644 index 0000000..61407b7 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/CollapseCommand.Execute(object).md @@ -0,0 +1,19 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[CollapseCommand](CollapseCommand.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.CollapseCommand') + +## CollapseCommand\.Execute\(object\) Method + +Выполняет команду с указанным параметром\. + +```csharp +public void Execute(object? parameter); +``` +#### Parameters + + + +`parameter` [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') + +Параметр, передаваемый команде\. + +Implements [Execute\(object\)](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.Input.ICommand.Execute#System_Windows_Input_ICommand_Execute_System_Object_ 'System\.Windows\.Input\.ICommand\.Execute\(System\.Object\)') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/CollapseCommand.StructureRow.md b/Documentation/Pf2eDataScrapper/CollapseCommand.StructureRow.md new file mode 100644 index 0000000..8cd7cfe --- /dev/null +++ b/Documentation/Pf2eDataScrapper/CollapseCommand.StructureRow.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[CollapseCommand](CollapseCommand.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.CollapseCommand') + +## CollapseCommand\.StructureRow Property + +Строка структуры, содержащая поле, для которого выполняется команда\. + +```csharp +private Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.StructureRow StructureRow { private get; } +``` + +#### Property Value +[StructureRow](StructureRow.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureRow') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/CollapseCommand.md b/Documentation/Pf2eDataScrapper/CollapseCommand.md new file mode 100644 index 0000000..ae4ea8c --- /dev/null +++ b/Documentation/Pf2eDataScrapper/CollapseCommand.md @@ -0,0 +1,31 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure') + +## CollapseCommand Class + +Команда для сворачивания/разворачивания поля структуры\. + +```csharp +internal class CollapseCommand : System.Windows.Input.ICommand +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 CollapseCommand + +Implements [System\.Windows\.Input\.ICommand](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.Input.ICommand 'System\.Windows\.Input\.ICommand') + +| Constructors | | +| :--- | :--- | +| [CollapseCommand\(StructureRow\)](CollapseCommand.CollapseCommand(StructureRow).md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.CollapseCommand\.CollapseCommand\(Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureRow\)') | Команда для сворачивания/разворачивания поля структуры\. | + +| Properties | | +| :--- | :--- | +| [StructureRow](CollapseCommand.StructureRow.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.CollapseCommand\.StructureRow') | Строка структуры, содержащая поле, для которого выполняется команда\. | + +| Methods | | +| :--- | :--- | +| [CanExecute\(object\)](CollapseCommand.CanExecute(object).md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.CollapseCommand\.CanExecute\(object\)') | Проверяет, может ли команда быть выполнена с указанным параметром\. | +| [Execute\(object\)](CollapseCommand.Execute(object).md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.CollapseCommand\.Execute\(object\)') | Выполняет команду с указанным параметром\. | + +| Events | | +| :--- | :--- | +| [CanExecuteChanged](CollapseCommand.CanExecuteChanged.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.CollapseCommand\.CanExecuteChanged') | Событие, вызываемое при изменении возможности выполнения команды\. | diff --git a/Documentation/Pf2eDataScrapper/ColorAdapterConverter.Convert(object[],Type,object,CultureInfo).md b/Documentation/Pf2eDataScrapper/ColorAdapterConverter.Convert(object[],Type,object,CultureInfo).md new file mode 100644 index 0000000..8349a5d --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ColorAdapterConverter.Convert(object[],Type,object,CultureInfo).md @@ -0,0 +1,41 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[ColorAdapterConverter](ColorAdapterConverter.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.ColorAdapterConverter') + +## ColorAdapterConverter\.Convert\(object\[\], Type, object, CultureInfo\) Method + +Преобразует массив значений в целевой тип, усредняя цвета\. + +```csharp +public object? Convert(object[] value, System.Type targetType, object parameter, System.Globalization.CultureInfo culture); +``` +#### Parameters + + + +`value` [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object')[\[\]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System\.Array') + +Массив значений, содержащий цвета\. + + + +`targetType` [System\.Type](https://docs.microsoft.com/en-us/dotnet/api/System.Type 'System\.Type') + +Целевой тип, в который нужно преобразовать значения\. + + + +`parameter` [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') + +Параметр преобразования, не используется\. + + + +`culture` [System\.Globalization\.CultureInfo](https://docs.microsoft.com/en-us/dotnet/api/System.Globalization.CultureInfo 'System\.Globalization\.CultureInfo') + +Культура, используемая для преобразования, не используется\. + +Implements [Convert\(object\[\], Type, object, CultureInfo\)](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.Data.IMultiValueConverter.Convert#System_Windows_Data_IMultiValueConverter_Convert_System_Object[],System_Type,System_Object,System_Globalization_CultureInfo_ 'System\.Windows\.Data\.IMultiValueConverter\.Convert\(System\.Object\[\],System\.Type,System\.Object,System\.Globalization\.CultureInfo\)') + +#### Returns +[System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') +Результат преобразования в целевой тип, который может быть `null`, если преобразование невозможно\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ColorAdapterConverter.ConvertBack(object,Type[],object,CultureInfo).md b/Documentation/Pf2eDataScrapper/ColorAdapterConverter.ConvertBack(object,Type[],object,CultureInfo).md new file mode 100644 index 0000000..81a5e24 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ColorAdapterConverter.ConvertBack(object,Type[],object,CultureInfo).md @@ -0,0 +1,36 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[ColorAdapterConverter](ColorAdapterConverter.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.ColorAdapterConverter') + +## ColorAdapterConverter\.ConvertBack\(object, Type\[\], object, CultureInfo\) Method + +Преобразует значение обратно в массив типов, но не реализован\. + +```csharp +public object[] ConvertBack(object value, System.Type[] targetType, object parameter, System.Globalization.CultureInfo culture); +``` +#### Parameters + + + +`value` [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') + + + +`targetType` [System\.Type](https://docs.microsoft.com/en-us/dotnet/api/System.Type 'System\.Type')[\[\]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System\.Array') + + + +`parameter` [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') + + + +`culture` [System\.Globalization\.CultureInfo](https://docs.microsoft.com/en-us/dotnet/api/System.Globalization.CultureInfo 'System\.Globalization\.CultureInfo') + +Implements [ConvertBack\(object, Type\[\], object, CultureInfo\)](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.Data.IMultiValueConverter.ConvertBack#System_Windows_Data_IMultiValueConverter_ConvertBack_System_Object,System_Type[],System_Object,System_Globalization_CultureInfo_ 'System\.Windows\.Data\.IMultiValueConverter\.ConvertBack\(System\.Object,System\.Type\[\],System\.Object,System\.Globalization\.CultureInfo\)') + +#### Returns +[System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object')[\[\]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System\.Array') + +#### Exceptions + +[System\.NotImplementedException](https://docs.microsoft.com/en-us/dotnet/api/System.NotImplementedException 'System\.NotImplementedException') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ColorAdapterConverter.Mix(byte,byte,double).md b/Documentation/Pf2eDataScrapper/ColorAdapterConverter.Mix(byte,byte,double).md new file mode 100644 index 0000000..60b81ed --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ColorAdapterConverter.Mix(byte,byte,double).md @@ -0,0 +1,33 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[ColorAdapterConverter](ColorAdapterConverter.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.ColorAdapterConverter') + +## ColorAdapterConverter\.Mix\(byte, byte, double\) Method + +Смешивает два компнента цвета с заданным коэффициентом смешивания\. + +```csharp +private byte Mix(byte a, byte b, double rate); +``` +#### Parameters + + + +`a` [System\.Byte](https://docs.microsoft.com/en-us/dotnet/api/System.Byte 'System\.Byte') + +Первый компонент цвета\. + + + +`b` [System\.Byte](https://docs.microsoft.com/en-us/dotnet/api/System.Byte 'System\.Byte') + +Второй компонент цвета\. + + + +`rate` [System\.Double](https://docs.microsoft.com/en-us/dotnet/api/System.Double 'System\.Double') + +Коэффициент смешивания, где 0\.0 означает полный компонент [a](ColorAdapterConverter.Mix(byte,byte,double).md#Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.ColorAdapterConverter.Mix(byte,byte,double).a 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.ColorAdapterConverter\.Mix\(byte, byte, double\)\.a'), а 1\.0 означает полный компонент [b](ColorAdapterConverter.Mix(byte,byte,double).md#Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.ColorAdapterConverter.Mix(byte,byte,double).b 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.ColorAdapterConverter\.Mix\(byte, byte, double\)\.b')\. + +#### Returns +[System\.Byte](https://docs.microsoft.com/en-us/dotnet/api/System.Byte 'System\.Byte') +Смешанный компонент цвета\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ColorAdapterConverter.md b/Documentation/Pf2eDataScrapper/ColorAdapterConverter.md new file mode 100644 index 0000000..15309ea --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ColorAdapterConverter.md @@ -0,0 +1,20 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure') + +## ColorAdapterConverter Class + +Преобразователь, который адаптирует цвет в зависимости от типа целевого свойства\. + +```csharp +public class ColorAdapterConverter : System.Windows.Data.IMultiValueConverter +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 ColorAdapterConverter + +Implements [System\.Windows\.Data\.IMultiValueConverter](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.Data.IMultiValueConverter 'System\.Windows\.Data\.IMultiValueConverter') + +| Methods | | +| :--- | :--- | +| [Convert\(object\[\], Type, object, CultureInfo\)](ColorAdapterConverter.Convert(object[],Type,object,CultureInfo).md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.ColorAdapterConverter\.Convert\(object\[\], System\.Type, object, System\.Globalization\.CultureInfo\)') | Преобразует массив значений в целевой тип, усредняя цвета\. | +| [ConvertBack\(object, Type\[\], object, CultureInfo\)](ColorAdapterConverter.ConvertBack(object,Type[],object,CultureInfo).md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.ColorAdapterConverter\.ConvertBack\(object, System\.Type\[\], object, System\.Globalization\.CultureInfo\)') | Преобразует значение обратно в массив типов, но не реализован\. | +| [Mix\(byte, byte, double\)](ColorAdapterConverter.Mix(byte,byte,double).md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.ColorAdapterConverter\.Mix\(byte, byte, double\)') | Смешивает два компнента цвета с заданным коэффициентом смешивания\. | diff --git a/Documentation/Pf2eDataScrapper/CompendiumDocumentType.md b/Documentation/Pf2eDataScrapper/CompendiumDocumentType.md new file mode 100644 index 0000000..86829db --- /dev/null +++ b/Documentation/Pf2eDataScrapper/CompendiumDocumentType.md @@ -0,0 +1,10 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium](Pf2eDataScrapper.Importers.Implementations.FoundryEn.Compendium.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium') + +## CompendiumDocumentType Enum + +Тип документов компендиума\. + +```csharp +internal enum CompendiumDocumentType +``` \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/CompendiumFolder.CompendiumFolder.md b/Documentation/Pf2eDataScrapper/CompendiumFolder.CompendiumFolder.md new file mode 100644 index 0000000..4c3dd03 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/CompendiumFolder.CompendiumFolder.md @@ -0,0 +1,47 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium](Pf2eDataScrapper.Importers.Implementations.FoundryEn.Compendium.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium').[CompendiumFolder](CompendiumFolder.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium\.CompendiumFolder') + +## CompendiumFolder Constructors + +| Overloads | | +| :--- | :--- | +| [CompendiumFolder\(JObject\)](CompendiumFolder.CompendiumFolder.md#Pf2eDataScrapper.Importers.Implementations.FoundryEn.Compendium.CompendiumFolder.CompendiumFolder(Newtonsoft.Json.Linq.JObject) 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium\.CompendiumFolder\.CompendiumFolder\(Newtonsoft\.Json\.Linq\.JObject\)') | Конструктор папки компендиума из JSON\-объекта\. | +| [CompendiumFolder\(string, string\)](CompendiumFolder.CompendiumFolder.md#Pf2eDataScrapper.Importers.Implementations.FoundryEn.Compendium.CompendiumFolder.CompendiumFolder(string,string) 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium\.CompendiumFolder\.CompendiumFolder\(string, string\)') | Конструктор папки компендиума\. | + + + +## CompendiumFolder\(JObject\) Constructor + +Конструктор папки компендиума из JSON\-объекта\. + +```csharp +public CompendiumFolder(Newtonsoft.Json.Linq.JObject json); +``` +#### Parameters + + + +`json` [Newtonsoft\.Json\.Linq\.JObject](https://docs.microsoft.com/en-us/dotnet/api/Newtonsoft.Json.Linq.JObject 'Newtonsoft\.Json\.Linq\.JObject') + + + +## CompendiumFolder\(string, string\) Constructor + +Конструктор папки компендиума\. + +```csharp +public CompendiumFolder(string id, string name); +``` +#### Parameters + + + +`id` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +Идентификатор папки\. + + + +`name` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +Название папки\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/CompendiumFolder.Id.md b/Documentation/Pf2eDataScrapper/CompendiumFolder.Id.md new file mode 100644 index 0000000..ac97e85 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/CompendiumFolder.Id.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium](Pf2eDataScrapper.Importers.Implementations.FoundryEn.Compendium.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium').[CompendiumFolder](CompendiumFolder.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium\.CompendiumFolder') + +## CompendiumFolder\.Id Property + +Идентификатор папки\. + +```csharp +public string Id { get; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/CompendiumFolder.IsContained.md b/Documentation/Pf2eDataScrapper/CompendiumFolder.IsContained.md new file mode 100644 index 0000000..6ac45e0 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/CompendiumFolder.IsContained.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium](Pf2eDataScrapper.Importers.Implementations.FoundryEn.Compendium.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium').[CompendiumFolder](CompendiumFolder.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium\.CompendiumFolder') + +## CompendiumFolder\.IsContained Property + +Указатель, что папка содержится в других папках\. + +```csharp +public bool IsContained { get; } +``` + +#### Property Value +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/CompendiumFolder.Name.md b/Documentation/Pf2eDataScrapper/CompendiumFolder.Name.md new file mode 100644 index 0000000..79f1162 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/CompendiumFolder.Name.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium](Pf2eDataScrapper.Importers.Implementations.FoundryEn.Compendium.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium').[CompendiumFolder](CompendiumFolder.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium\.CompendiumFolder') + +## CompendiumFolder\.Name Property + +Название папки\. + +```csharp +public string Name { get; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/CompendiumFolder.Parent.md b/Documentation/Pf2eDataScrapper/CompendiumFolder.Parent.md new file mode 100644 index 0000000..7123e19 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/CompendiumFolder.Parent.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium](Pf2eDataScrapper.Importers.Implementations.FoundryEn.Compendium.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium').[CompendiumFolder](CompendiumFolder.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium\.CompendiumFolder') + +## CompendiumFolder\.Parent Property + +Родительская папка\. + +```csharp +public Pf2eDataScrapper.Importers.Implementations.FoundryEn.Compendium.CompendiumFolder? Parent { get; set; } +``` + +#### Property Value +[CompendiumFolder](CompendiumFolder.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium\.CompendiumFolder') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/CompendiumFolder.Path.md b/Documentation/Pf2eDataScrapper/CompendiumFolder.Path.md new file mode 100644 index 0000000..0aa26dd --- /dev/null +++ b/Documentation/Pf2eDataScrapper/CompendiumFolder.Path.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium](Pf2eDataScrapper.Importers.Implementations.FoundryEn.Compendium.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium').[CompendiumFolder](CompendiumFolder.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium\.CompendiumFolder') + +## CompendiumFolder\.Path Property + +Путь к папке\. + +```csharp +public string? Path { get; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/CompendiumFolder.ToString().md b/Documentation/Pf2eDataScrapper/CompendiumFolder.ToString().md new file mode 100644 index 0000000..7c1a88c --- /dev/null +++ b/Documentation/Pf2eDataScrapper/CompendiumFolder.ToString().md @@ -0,0 +1,14 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium](Pf2eDataScrapper.Importers.Implementations.FoundryEn.Compendium.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium').[CompendiumFolder](CompendiumFolder.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium\.CompendiumFolder') + +## CompendiumFolder\.ToString\(\) Method + +Строковое представление данных о папки компендиума\. + +```csharp +public override string ToString(); +``` + +#### Returns +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') +Строковое представление данных о папки компендиума\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/CompendiumFolder.Type.md b/Documentation/Pf2eDataScrapper/CompendiumFolder.Type.md new file mode 100644 index 0000000..058526c --- /dev/null +++ b/Documentation/Pf2eDataScrapper/CompendiumFolder.Type.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium](Pf2eDataScrapper.Importers.Implementations.FoundryEn.Compendium.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium').[CompendiumFolder](CompendiumFolder.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium\.CompendiumFolder') + +## CompendiumFolder\.Type Property + +Тип документов в папке\. + +```csharp +public Pf2eDataScrapper.Importers.Implementations.FoundryEn.Compendium.CompendiumDocumentType Type { get; } +``` + +#### Property Value +[CompendiumDocumentType](CompendiumDocumentType.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium\.CompendiumDocumentType') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/CompendiumFolder.md b/Documentation/Pf2eDataScrapper/CompendiumFolder.md new file mode 100644 index 0000000..a1ee133 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/CompendiumFolder.md @@ -0,0 +1,30 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium](Pf2eDataScrapper.Importers.Implementations.FoundryEn.Compendium.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium') + +## CompendiumFolder Class + +Папка компендиума\. + +```csharp +internal class CompendiumFolder +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 CompendiumFolder + +| Constructors | | +| :--- | :--- | +| [CompendiumFolder\(JObject\)](CompendiumFolder.CompendiumFolder.md#Pf2eDataScrapper.Importers.Implementations.FoundryEn.Compendium.CompendiumFolder.CompendiumFolder(Newtonsoft.Json.Linq.JObject) 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium\.CompendiumFolder\.CompendiumFolder\(Newtonsoft\.Json\.Linq\.JObject\)') | Конструктор папки компендиума из JSON\-объекта\. | +| [CompendiumFolder\(string, string\)](CompendiumFolder.CompendiumFolder.md#Pf2eDataScrapper.Importers.Implementations.FoundryEn.Compendium.CompendiumFolder.CompendiumFolder(string,string) 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium\.CompendiumFolder\.CompendiumFolder\(string, string\)') | Конструктор папки компендиума\. | + +| Properties | | +| :--- | :--- | +| [Id](CompendiumFolder.Id.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium\.CompendiumFolder\.Id') | Идентификатор папки\. | +| [IsContained](CompendiumFolder.IsContained.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium\.CompendiumFolder\.IsContained') | Указатель, что папка содержится в других папках\. | +| [Name](CompendiumFolder.Name.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium\.CompendiumFolder\.Name') | Название папки\. | +| [Parent](CompendiumFolder.Parent.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium\.CompendiumFolder\.Parent') | Родительская папка\. | +| [Path](CompendiumFolder.Path.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium\.CompendiumFolder\.Path') | Путь к папке\. | +| [Type](CompendiumFolder.Type.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium\.CompendiumFolder\.Type') | Тип документов в папке\. | + +| Methods | | +| :--- | :--- | +| [ToString\(\)](CompendiumFolder.ToString().md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium\.CompendiumFolder\.ToString\(\)') | Строковое представление данных о папки компендиума\. | diff --git a/Documentation/Pf2eDataScrapper/CompendiumFolderCollection.Add(CompendiumFolder).md b/Documentation/Pf2eDataScrapper/CompendiumFolderCollection.Add(CompendiumFolder).md new file mode 100644 index 0000000..5fb20b7 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/CompendiumFolderCollection.Add(CompendiumFolder).md @@ -0,0 +1,17 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium](Pf2eDataScrapper.Importers.Implementations.FoundryEn.Compendium.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium').[CompendiumFolderCollection](CompendiumFolderCollection.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium\.CompendiumFolderCollection') + +## CompendiumFolderCollection\.Add\(CompendiumFolder\) Method + +Добавление информации о папке\. + +```csharp +public void Add(Pf2eDataScrapper.Importers.Implementations.FoundryEn.Compendium.CompendiumFolder folder); +``` +#### Parameters + + + +`folder` [CompendiumFolder](CompendiumFolder.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium\.CompendiumFolder') + +Добавляемая папка\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/CompendiumFolderCollection.GetById(string).md b/Documentation/Pf2eDataScrapper/CompendiumFolderCollection.GetById(string).md new file mode 100644 index 0000000..9ec1508 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/CompendiumFolderCollection.GetById(string).md @@ -0,0 +1,21 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium](Pf2eDataScrapper.Importers.Implementations.FoundryEn.Compendium.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium').[CompendiumFolderCollection](CompendiumFolderCollection.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium\.CompendiumFolderCollection') + +## CompendiumFolderCollection\.GetById\(string\) Method + +Получение папки по идентификатору + +```csharp +public Pf2eDataScrapper.Importers.Implementations.FoundryEn.Compendium.CompendiumFolder? GetById(string id); +``` +#### Parameters + + + +`id` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +Искомый идентификатор + +#### Returns +[CompendiumFolder](CompendiumFolder.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium\.CompendiumFolder') +Искомая папка \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/CompendiumFolderCollection.Items.md b/Documentation/Pf2eDataScrapper/CompendiumFolderCollection.Items.md new file mode 100644 index 0000000..e152ca3 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/CompendiumFolderCollection.Items.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium](Pf2eDataScrapper.Importers.Implementations.FoundryEn.Compendium.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium').[CompendiumFolderCollection](CompendiumFolderCollection.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium\.CompendiumFolderCollection') + +## CompendiumFolderCollection\.Items Property + +Список загруженных папок\. + +```csharp +public System.Collections.Generic.List Items { get; } +``` + +#### Property Value +[System\.Collections\.Generic\.List<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.List-1 'System\.Collections\.Generic\.List\`1')[CompendiumFolder](CompendiumFolder.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium\.CompendiumFolder')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.List-1 'System\.Collections\.Generic\.List\`1') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/CompendiumFolderCollection.md b/Documentation/Pf2eDataScrapper/CompendiumFolderCollection.md new file mode 100644 index 0000000..7dcccea --- /dev/null +++ b/Documentation/Pf2eDataScrapper/CompendiumFolderCollection.md @@ -0,0 +1,21 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium](Pf2eDataScrapper.Importers.Implementations.FoundryEn.Compendium.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium') + +## CompendiumFolderCollection Class + +Коллекция папок компендиума + +```csharp +internal class CompendiumFolderCollection +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 CompendiumFolderCollection + +| Properties | | +| :--- | :--- | +| [Items](CompendiumFolderCollection.Items.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium\.CompendiumFolderCollection\.Items') | Список загруженных папок\. | + +| Methods | | +| :--- | :--- | +| [Add\(CompendiumFolder\)](CompendiumFolderCollection.Add(CompendiumFolder).md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium\.CompendiumFolderCollection\.Add\(Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium\.CompendiumFolder\)') | Добавление информации о папке\. | +| [GetById\(string\)](CompendiumFolderCollection.GetById(string).md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium\.CompendiumFolderCollection\.GetById\(string\)') | Получение папки по идентификатору | diff --git a/Documentation/Pf2eDataScrapper/CompendiumFolderProcessor.LoadPacks().md b/Documentation/Pf2eDataScrapper/CompendiumFolderProcessor.LoadPacks().md new file mode 100644 index 0000000..80ea345 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/CompendiumFolderProcessor.LoadPacks().md @@ -0,0 +1,10 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Processors\.Preparation](Pf2eDataScrapper.Importers.Implementations.FoundryEn.Processors.Preparation.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Processors\.Preparation').[CompendiumFolderProcessor](CompendiumFolderProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Processors\.Preparation\.CompendiumFolderProcessor') + +## CompendiumFolderProcessor\.LoadPacks\(\) Method + +Загрузка основных папок\. + +```csharp +private void LoadPacks(); +``` \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/CompendiumFolderProcessor.ProcessPackFolders(JArray,CompendiumFolder).md b/Documentation/Pf2eDataScrapper/CompendiumFolderProcessor.ProcessPackFolders(JArray,CompendiumFolder).md new file mode 100644 index 0000000..4de9101 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/CompendiumFolderProcessor.ProcessPackFolders(JArray,CompendiumFolder).md @@ -0,0 +1,19 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Processors\.Preparation](Pf2eDataScrapper.Importers.Implementations.FoundryEn.Processors.Preparation.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Processors\.Preparation').[CompendiumFolderProcessor](CompendiumFolderProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Processors\.Preparation\.CompendiumFolderProcessor') + +## CompendiumFolderProcessor\.ProcessPackFolders\(JArray, CompendiumFolder\) Method + +Обработка папок компендиума в поле \`packFolders\`\. + +```csharp +private void ProcessPackFolders(Newtonsoft.Json.Linq.JArray folders, Pf2eDataScrapper.Importers.Implementations.FoundryEn.Compendium.CompendiumFolder? parent); +``` +#### Parameters + + + +`folders` [Newtonsoft\.Json\.Linq\.JArray](https://docs.microsoft.com/en-us/dotnet/api/Newtonsoft.Json.Linq.JArray 'Newtonsoft\.Json\.Linq\.JArray') + + + +`parent` [CompendiumFolder](CompendiumFolder.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium\.CompendiumFolder') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/CompendiumFolderProcessor.md b/Documentation/Pf2eDataScrapper/CompendiumFolderProcessor.md new file mode 100644 index 0000000..68c6489 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/CompendiumFolderProcessor.md @@ -0,0 +1,17 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Processors\.Preparation](Pf2eDataScrapper.Importers.Implementations.FoundryEn.Processors.Preparation.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Processors\.Preparation') + +## CompendiumFolderProcessor Class + +```csharp +internal class CompendiumFolderProcessor : Pf2eDataScrapper.Processors.Definitions.IProcessor +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 CompendiumFolderProcessor + +Implements [IProcessor](IProcessor.md 'Pf2eDataScrapper\.Processors\.Definitions\.IProcessor') + +| Methods | | +| :--- | :--- | +| [LoadPacks\(\)](CompendiumFolderProcessor.LoadPacks().md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Processors\.Preparation\.CompendiumFolderProcessor\.LoadPacks\(\)') | Загрузка основных папок\. | +| [ProcessPackFolders\(JArray, CompendiumFolder\)](CompendiumFolderProcessor.ProcessPackFolders(JArray,CompendiumFolder).md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Processors\.Preparation\.CompendiumFolderProcessor\.ProcessPackFolders\(Newtonsoft\.Json\.Linq\.JArray, Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium\.CompendiumFolder\)') | Обработка папок компендиума в поле \`packFolders\`\. | diff --git a/Documentation/Pf2eDataScrapper/DatabaseHelper.Context.md b/Documentation/Pf2eDataScrapper/DatabaseHelper.Context.md new file mode 100644 index 0000000..36a93d0 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/DatabaseHelper.Context.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Helpers](Pf2eDataScrapper.Helpers.md 'Pf2eDataScrapper\.Helpers').[DatabaseHelper](DatabaseHelper.md 'Pf2eDataScrapper\.Helpers\.DatabaseHelper') + +## DatabaseHelper\.Context Property + +Context для доступа к базе данных\. + +```csharp +public Pf2eModel.Pf2eDbContext Context { get; } +``` + +#### Property Value +[Pf2eModel\.Pf2eDbContext](https://docs.microsoft.com/en-us/dotnet/api/Pf2eModel.Pf2eDbContext 'Pf2eModel\.Pf2eDbContext') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/DatabaseHelper.DatabaseHelper(SlugHelper).md b/Documentation/Pf2eDataScrapper/DatabaseHelper.DatabaseHelper(SlugHelper).md new file mode 100644 index 0000000..7373522 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/DatabaseHelper.DatabaseHelper(SlugHelper).md @@ -0,0 +1,17 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Helpers](Pf2eDataScrapper.Helpers.md 'Pf2eDataScrapper\.Helpers').[DatabaseHelper](DatabaseHelper.md 'Pf2eDataScrapper\.Helpers\.DatabaseHelper') + +## DatabaseHelper\(SlugHelper\) Constructor + +Конструктор класса [DatabaseHelper](DatabaseHelper.md 'Pf2eDataScrapper\.Helpers\.DatabaseHelper') + +```csharp +public DatabaseHelper(Slugify.SlugHelper slugHelper); +``` +#### Parameters + + + +`slugHelper` [Slugify\.SlugHelper](https://docs.microsoft.com/en-us/dotnet/api/Slugify.SlugHelper 'Slugify\.SlugHelper') + +\[DI\] Сервис для работы с URL\-Slug \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/DatabaseHelper.GenerateSlug(string).md b/Documentation/Pf2eDataScrapper/DatabaseHelper.GenerateSlug(string).md new file mode 100644 index 0000000..da8c806 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/DatabaseHelper.GenerateSlug(string).md @@ -0,0 +1,18 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Helpers](Pf2eDataScrapper.Helpers.md 'Pf2eDataScrapper\.Helpers').[DatabaseHelper](DatabaseHelper.md 'Pf2eDataScrapper\.Helpers\.DatabaseHelper') + +## DatabaseHelper\.GenerateSlug\(string\) Method + +Генерирует slug из названия\. + +```csharp +public string GenerateSlug(string name); +``` +#### Parameters + + + +`name` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +#### Returns +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/DatabaseHelper.IdLock.md b/Documentation/Pf2eDataScrapper/DatabaseHelper.IdLock.md new file mode 100644 index 0000000..8fd11b4 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/DatabaseHelper.IdLock.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Helpers](Pf2eDataScrapper.Helpers.md 'Pf2eDataScrapper\.Helpers').[DatabaseHelper](DatabaseHelper.md 'Pf2eDataScrapper\.Helpers\.DatabaseHelper') + +## DatabaseHelper\.IdLock Property + +Блокировщик для генерации идентификаторов сущностей\. + +```csharp +public System.Threading.Lock IdLock { get; } +``` + +#### Property Value +[System\.Threading\.Lock](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Lock 'System\.Threading\.Lock') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/DatabaseHelper.NextEntityId.md b/Documentation/Pf2eDataScrapper/DatabaseHelper.NextEntityId.md new file mode 100644 index 0000000..7193c0d --- /dev/null +++ b/Documentation/Pf2eDataScrapper/DatabaseHelper.NextEntityId.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Helpers](Pf2eDataScrapper.Helpers.md 'Pf2eDataScrapper\.Helpers').[DatabaseHelper](DatabaseHelper.md 'Pf2eDataScrapper\.Helpers\.DatabaseHelper') + +## DatabaseHelper\.NextEntityId Property + +Генерирует новый уникальный идентификатор сущности\. и возвращает его\. + +```csharp +public int NextEntityId { get; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/DatabaseHelper.Slugger.md b/Documentation/Pf2eDataScrapper/DatabaseHelper.Slugger.md new file mode 100644 index 0000000..abfdb0d --- /dev/null +++ b/Documentation/Pf2eDataScrapper/DatabaseHelper.Slugger.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Helpers](Pf2eDataScrapper.Helpers.md 'Pf2eDataScrapper\.Helpers').[DatabaseHelper](DatabaseHelper.md 'Pf2eDataScrapper\.Helpers\.DatabaseHelper') + +## DatabaseHelper\.Slugger Property + +Сервис для работы с URL\-Slug\. Используется для преобразования названий в URL\-friendly формат\. + +```csharp +public Slugify.SlugHelper Slugger { get; } +``` + +#### Property Value +[Slugify\.SlugHelper](https://docs.microsoft.com/en-us/dotnet/api/Slugify.SlugHelper 'Slugify\.SlugHelper') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/DatabaseHelper._id.md b/Documentation/Pf2eDataScrapper/DatabaseHelper._id.md new file mode 100644 index 0000000..29c382b --- /dev/null +++ b/Documentation/Pf2eDataScrapper/DatabaseHelper._id.md @@ -0,0 +1,14 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Helpers](Pf2eDataScrapper.Helpers.md 'Pf2eDataScrapper\.Helpers').[DatabaseHelper](DatabaseHelper.md 'Pf2eDataScrapper\.Helpers\.DatabaseHelper') + +## DatabaseHelper\.\_id Field + +Последний найденный идентификатор сущности\. +Используется для генерации новых ID сущностей\. + +```csharp +private int _id; +``` + +#### Field Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/DatabaseHelper.md b/Documentation/Pf2eDataScrapper/DatabaseHelper.md new file mode 100644 index 0000000..d308bf6 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/DatabaseHelper.md @@ -0,0 +1,31 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Helpers](Pf2eDataScrapper.Helpers.md 'Pf2eDataScrapper\.Helpers') + +## DatabaseHelper Class + +Класс предоставляет методы для работы с базой данных\. + +```csharp +public class DatabaseHelper +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 DatabaseHelper + +| Constructors | | +| :--- | :--- | +| [DatabaseHelper\(SlugHelper\)](DatabaseHelper.DatabaseHelper(SlugHelper).md 'Pf2eDataScrapper\.Helpers\.DatabaseHelper\.DatabaseHelper\(Slugify\.SlugHelper\)') | Конструктор класса [DatabaseHelper](DatabaseHelper.md 'Pf2eDataScrapper\.Helpers\.DatabaseHelper') | + +| Fields | | +| :--- | :--- | +| [\_id](DatabaseHelper._id.md 'Pf2eDataScrapper\.Helpers\.DatabaseHelper\.\_id') | Последний найденный идентификатор сущности\. Используется для генерации новых ID сущностей\. | + +| Properties | | +| :--- | :--- | +| [Context](DatabaseHelper.Context.md 'Pf2eDataScrapper\.Helpers\.DatabaseHelper\.Context') | Context для доступа к базе данных\. | +| [IdLock](DatabaseHelper.IdLock.md 'Pf2eDataScrapper\.Helpers\.DatabaseHelper\.IdLock') | Блокировщик для генерации идентификаторов сущностей\. | +| [NextEntityId](DatabaseHelper.NextEntityId.md 'Pf2eDataScrapper\.Helpers\.DatabaseHelper\.NextEntityId') | Генерирует новый уникальный идентификатор сущности\. и возвращает его\. | +| [Slugger](DatabaseHelper.Slugger.md 'Pf2eDataScrapper\.Helpers\.DatabaseHelper\.Slugger') | Сервис для работы с URL\-Slug\. Используется для преобразования названий в URL\-friendly формат\. | + +| Methods | | +| :--- | :--- | +| [GenerateSlug\(string\)](DatabaseHelper.GenerateSlug(string).md 'Pf2eDataScrapper\.Helpers\.DatabaseHelper\.GenerateSlug\(string\)') | Генерирует slug из названия\. | diff --git a/Documentation/Pf2eDataScrapper/DictionarySchemaType.AddValue(JToken).md b/Documentation/Pf2eDataScrapper/DictionarySchemaType.AddValue(JToken).md new file mode 100644 index 0000000..065e727 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/DictionarySchemaType.AddValue(JToken).md @@ -0,0 +1,17 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder\.Types](Pf2eDataScrapper.SchemaBuilder.Types.md 'Pf2eDataScrapper\.SchemaBuilder\.Types').[DictionarySchemaType](DictionarySchemaType.md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.DictionarySchemaType') + +## DictionarySchemaType\.AddValue\(JToken\) Method + +Добавление нового значения\. + +```csharp +public override void AddValue(Newtonsoft.Json.Linq.JToken value); +``` +#### Parameters + + + +`value` [Newtonsoft\.Json\.Linq\.JToken](https://docs.microsoft.com/en-us/dotnet/api/Newtonsoft.Json.Linq.JToken 'Newtonsoft\.Json\.Linq\.JToken') + +Новое значение\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/DictionarySchemaType.Beautify().md b/Documentation/Pf2eDataScrapper/DictionarySchemaType.Beautify().md new file mode 100644 index 0000000..1ad1005 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/DictionarySchemaType.Beautify().md @@ -0,0 +1,10 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder\.Types](Pf2eDataScrapper.SchemaBuilder.Types.md 'Pf2eDataScrapper\.SchemaBuilder\.Types').[DictionarySchemaType](DictionarySchemaType.md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.DictionarySchemaType') + +## DictionarySchemaType\.Beautify\(\) Method + +Подготовка типа к красивому представлению\. + +```csharp +public override void Beautify(); +``` \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/DictionarySchemaType.DictionarySchemaType(SchemaNode).md b/Documentation/Pf2eDataScrapper/DictionarySchemaType.DictionarySchemaType(SchemaNode).md new file mode 100644 index 0000000..bee9f2a --- /dev/null +++ b/Documentation/Pf2eDataScrapper/DictionarySchemaType.DictionarySchemaType(SchemaNode).md @@ -0,0 +1,17 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder\.Types](Pf2eDataScrapper.SchemaBuilder.Types.md 'Pf2eDataScrapper\.SchemaBuilder\.Types').[DictionarySchemaType](DictionarySchemaType.md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.DictionarySchemaType') + +## DictionarySchemaType\(SchemaNode\) Constructor + +Тип представоления словаря в схеме\. + +```csharp +public DictionarySchemaType(Pf2eDataScrapper.SchemaBuilder.SchemaNode parent); +``` +#### Parameters + + + +`parent` [SchemaNode](SchemaNode.md 'Pf2eDataScrapper\.SchemaBuilder\.SchemaNode') + +Элемент, к которому добавляется тип\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/DictionarySchemaType.GetTypeName().md b/Documentation/Pf2eDataScrapper/DictionarySchemaType.GetTypeName().md new file mode 100644 index 0000000..2d48611 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/DictionarySchemaType.GetTypeName().md @@ -0,0 +1,14 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder\.Types](Pf2eDataScrapper.SchemaBuilder.Types.md 'Pf2eDataScrapper\.SchemaBuilder\.Types').[DictionarySchemaType](DictionarySchemaType.md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.DictionarySchemaType') + +## DictionarySchemaType\.GetTypeName\(\) Method + +Получение строкового представоения типа элемента\. + +```csharp +public override string GetTypeName(); +``` + +#### Returns +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') +Строковое представоение типа элемента \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/DictionarySchemaType.GetYamlData().md b/Documentation/Pf2eDataScrapper/DictionarySchemaType.GetYamlData().md new file mode 100644 index 0000000..3bddca1 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/DictionarySchemaType.GetYamlData().md @@ -0,0 +1,14 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder\.Types](Pf2eDataScrapper.SchemaBuilder.Types.md 'Pf2eDataScrapper\.SchemaBuilder\.Types').[DictionarySchemaType](DictionarySchemaType.md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.DictionarySchemaType') + +## DictionarySchemaType\.GetYamlData\(\) Method + +Получение данных для форматирования в YAML\. + +```csharp +public override System.Collections.Generic.Dictionary GetYamlData(); +``` + +#### Returns +[System\.Collections\.Generic\.Dictionary<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.Dictionary-2 'System\.Collections\.Generic\.Dictionary\`2')[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.Dictionary-2 'System\.Collections\.Generic\.Dictionary\`2')[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.Dictionary-2 'System\.Collections\.Generic\.Dictionary\`2') +Словарь данных \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/DictionarySchemaType.IsCompatibleValue(JToken).md b/Documentation/Pf2eDataScrapper/DictionarySchemaType.IsCompatibleValue(JToken).md new file mode 100644 index 0000000..4ce1531 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/DictionarySchemaType.IsCompatibleValue(JToken).md @@ -0,0 +1,21 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder\.Types](Pf2eDataScrapper.SchemaBuilder.Types.md 'Pf2eDataScrapper\.SchemaBuilder\.Types').[DictionarySchemaType](DictionarySchemaType.md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.DictionarySchemaType') + +## DictionarySchemaType\.IsCompatibleValue\(JToken\) Method + +Проверка, что значение совместимо с текущим типом\. + +```csharp +public override bool IsCompatibleValue(Newtonsoft.Json.Linq.JToken value); +``` +#### Parameters + + + +`value` [Newtonsoft\.Json\.Linq\.JToken](https://docs.microsoft.com/en-us/dotnet/api/Newtonsoft.Json.Linq.JToken 'Newtonsoft\.Json\.Linq\.JToken') + +Проверяемое значение\. + +#### Returns +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') +\`true\`, если значение совместимо с текущим типом\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/DictionarySchemaType.ItemNode.md b/Documentation/Pf2eDataScrapper/DictionarySchemaType.ItemNode.md new file mode 100644 index 0000000..b7421d0 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/DictionarySchemaType.ItemNode.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder\.Types](Pf2eDataScrapper.SchemaBuilder.Types.md 'Pf2eDataScrapper\.SchemaBuilder\.Types').[DictionarySchemaType](DictionarySchemaType.md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.DictionarySchemaType') + +## DictionarySchemaType\.ItemNode Field + +Схема значений словаря\. + +```csharp +public readonly SchemaNode ItemNode; +``` + +#### Field Value +[SchemaNode](SchemaNode.md 'Pf2eDataScrapper\.SchemaBuilder\.SchemaNode') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/DictionarySchemaType.KeyNode.md b/Documentation/Pf2eDataScrapper/DictionarySchemaType.KeyNode.md new file mode 100644 index 0000000..3bf63d7 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/DictionarySchemaType.KeyNode.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder\.Types](Pf2eDataScrapper.SchemaBuilder.Types.md 'Pf2eDataScrapper\.SchemaBuilder\.Types').[DictionarySchemaType](DictionarySchemaType.md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.DictionarySchemaType') + +## DictionarySchemaType\.KeyNode Field + +Схема ключей словаря\. + +```csharp +public readonly SchemaNode KeyNode; +``` + +#### Field Value +[SchemaNode](SchemaNode.md 'Pf2eDataScrapper\.SchemaBuilder\.SchemaNode') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/DictionarySchemaType.md b/Documentation/Pf2eDataScrapper/DictionarySchemaType.md new file mode 100644 index 0000000..4fc4641 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/DictionarySchemaType.md @@ -0,0 +1,29 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder\.Types](Pf2eDataScrapper.SchemaBuilder.Types.md 'Pf2eDataScrapper\.SchemaBuilder\.Types') + +## DictionarySchemaType Class + +Тип представоления словаря в схеме\. + +```csharp +internal class DictionarySchemaType : Pf2eDataScrapper.SchemaBuilder.Types.AbstractSchemaType +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [AbstractSchemaType](AbstractSchemaType.md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.AbstractSchemaType') 🡒 DictionarySchemaType + +| Constructors | | +| :--- | :--- | +| [DictionarySchemaType\(SchemaNode\)](DictionarySchemaType.DictionarySchemaType(SchemaNode).md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.DictionarySchemaType\.DictionarySchemaType\(Pf2eDataScrapper\.SchemaBuilder\.SchemaNode\)') | Тип представоления словаря в схеме\. | + +| Fields | | +| :--- | :--- | +| [ItemNode](DictionarySchemaType.ItemNode.md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.DictionarySchemaType\.ItemNode') | Схема значений словаря\. | +| [KeyNode](DictionarySchemaType.KeyNode.md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.DictionarySchemaType\.KeyNode') | Схема ключей словаря\. | + +| Methods | | +| :--- | :--- | +| [AddValue\(JToken\)](DictionarySchemaType.AddValue(JToken).md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.DictionarySchemaType\.AddValue\(Newtonsoft\.Json\.Linq\.JToken\)') | Добавление нового значения\. | +| [Beautify\(\)](DictionarySchemaType.Beautify().md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.DictionarySchemaType\.Beautify\(\)') | Подготовка типа к красивому представлению\. | +| [GetTypeName\(\)](DictionarySchemaType.GetTypeName().md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.DictionarySchemaType\.GetTypeName\(\)') | Получение строкового представоения типа элемента\. | +| [GetYamlData\(\)](DictionarySchemaType.GetYamlData().md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.DictionarySchemaType\.GetYamlData\(\)') | Получение данных для форматирования в YAML\. | +| [IsCompatibleValue\(JToken\)](DictionarySchemaType.IsCompatibleValue(JToken).md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.DictionarySchemaType\.IsCompatibleValue\(Newtonsoft\.Json\.Linq\.JToken\)') | Проверка, что значение совместимо с текущим типом\. | diff --git a/Documentation/Pf2eDataScrapper/EntityForm.InitializeComponent().md b/Documentation/Pf2eDataScrapper/EntityForm.InitializeComponent().md new file mode 100644 index 0000000..1d50e0b --- /dev/null +++ b/Documentation/Pf2eDataScrapper/EntityForm.InitializeComponent().md @@ -0,0 +1,12 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer](Pf2eDataScrapper.WPF.EntityViewer.md 'Pf2eDataScrapper\.WPF\.EntityViewer').[EntityForm](EntityForm.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityForm') + +## EntityForm\.InitializeComponent\(\) Method + +InitializeComponent + +```csharp +public void InitializeComponent(); +``` + +Implements [InitializeComponent\(\)](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.Markup.IComponentConnector.InitializeComponent 'System\.Windows\.Markup\.IComponentConnector\.InitializeComponent') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/EntityForm.md b/Documentation/Pf2eDataScrapper/EntityForm.md new file mode 100644 index 0000000..c1e6253 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/EntityForm.md @@ -0,0 +1,16 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer](Pf2eDataScrapper.WPF.EntityViewer.md 'Pf2eDataScrapper\.WPF\.EntityViewer') + +## EntityForm Class + +```csharp +internal class EntityForm : System.Windows.Window, System.Windows.Markup.IComponentConnector +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [System\.Windows\.Threading\.DispatcherObject](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.Threading.DispatcherObject 'System\.Windows\.Threading\.DispatcherObject') 🡒 [System\.Windows\.DependencyObject](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.DependencyObject 'System\.Windows\.DependencyObject') 🡒 [System\.Windows\.Media\.Visual](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.Media.Visual 'System\.Windows\.Media\.Visual') 🡒 [System\.Windows\.UIElement](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.UIElement 'System\.Windows\.UIElement') 🡒 [System\.Windows\.FrameworkElement](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.FrameworkElement 'System\.Windows\.FrameworkElement') 🡒 [System\.Windows\.Controls\.Control](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.Controls.Control 'System\.Windows\.Controls\.Control') 🡒 [System\.Windows\.Controls\.ContentControl](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.Controls.ContentControl 'System\.Windows\.Controls\.ContentControl') 🡒 [System\.Windows\.Window](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.Window 'System\.Windows\.Window') 🡒 EntityForm + +Implements [System\.Windows\.Markup\.IComponentConnector](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.Markup.IComponentConnector 'System\.Windows\.Markup\.IComponentConnector') + +| Methods | | +| :--- | :--- | +| [InitializeComponent\(\)](EntityForm.InitializeComponent().md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityForm\.InitializeComponent\(\)') | InitializeComponent | diff --git a/Documentation/Pf2eDataScrapper/EntityListControl.InitializeComponent().md b/Documentation/Pf2eDataScrapper/EntityListControl.InitializeComponent().md new file mode 100644 index 0000000..8cba2f8 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/EntityListControl.InitializeComponent().md @@ -0,0 +1,12 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.Component](Pf2eDataScrapper.WPF.EntityViewer.Component.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.Component').[EntityListControl](EntityListControl.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.Component\.EntityListControl') + +## EntityListControl\.InitializeComponent\(\) Method + +InitializeComponent + +```csharp +public void InitializeComponent(); +``` + +Implements [InitializeComponent\(\)](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.Markup.IComponentConnector.InitializeComponent 'System\.Windows\.Markup\.IComponentConnector\.InitializeComponent') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/EntityListControl.md b/Documentation/Pf2eDataScrapper/EntityListControl.md new file mode 100644 index 0000000..e317441 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/EntityListControl.md @@ -0,0 +1,18 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.Component](Pf2eDataScrapper.WPF.EntityViewer.Component.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.Component') + +## EntityListControl Class + +Логика взаимодействия для DbEntityListControl\.xaml + +```csharp +internal class EntityListControl : System.Windows.Controls.UserControl, System.Windows.Markup.IComponentConnector +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [System\.Windows\.Threading\.DispatcherObject](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.Threading.DispatcherObject 'System\.Windows\.Threading\.DispatcherObject') 🡒 [System\.Windows\.DependencyObject](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.DependencyObject 'System\.Windows\.DependencyObject') 🡒 [System\.Windows\.Media\.Visual](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.Media.Visual 'System\.Windows\.Media\.Visual') 🡒 [System\.Windows\.UIElement](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.UIElement 'System\.Windows\.UIElement') 🡒 [System\.Windows\.FrameworkElement](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.FrameworkElement 'System\.Windows\.FrameworkElement') 🡒 [System\.Windows\.Controls\.Control](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.Controls.Control 'System\.Windows\.Controls\.Control') 🡒 [System\.Windows\.Controls\.ContentControl](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.Controls.ContentControl 'System\.Windows\.Controls\.ContentControl') 🡒 [System\.Windows\.Controls\.UserControl](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.Controls.UserControl 'System\.Windows\.Controls\.UserControl') 🡒 EntityListControl + +Implements [System\.Windows\.Markup\.IComponentConnector](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.Markup.IComponentConnector 'System\.Windows\.Markup\.IComponentConnector') + +| Methods | | +| :--- | :--- | +| [InitializeComponent\(\)](EntityListControl.InitializeComponent().md 'Pf2eDataScrapper\.WPF\.EntityViewer\.Component\.EntityListControl\.InitializeComponent\(\)') | InitializeComponent | diff --git a/Documentation/Pf2eDataScrapper/EntityListViewModel.Reload().md b/Documentation/Pf2eDataScrapper/EntityListViewModel.Reload().md new file mode 100644 index 0000000..a0e54ed --- /dev/null +++ b/Documentation/Pf2eDataScrapper/EntityListViewModel.Reload().md @@ -0,0 +1,10 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.ViewModel](Pf2eDataScrapper.WPF.EntityViewer.ViewModel.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.ViewModel').[EntityListViewModel](EntityListViewModel.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.ViewModel\.EntityListViewModel') + +## EntityListViewModel\.Reload\(\) Method + +Выполняет запрос к базе данных и обрабатывает результаты\. + +```csharp +public void Reload(); +``` \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/EntityListViewModel.md b/Documentation/Pf2eDataScrapper/EntityListViewModel.md new file mode 100644 index 0000000..f558737 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/EntityListViewModel.md @@ -0,0 +1,14 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.ViewModel](Pf2eDataScrapper.WPF.EntityViewer.ViewModel.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.ViewModel') + +## EntityListViewModel Class + +```csharp +internal class EntityListViewModel : Pf2eDataScrapper.WPF.ViewModelBase +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [Pf2eDataScrapper\.WPF\.ViewModelBase](https://docs.microsoft.com/en-us/dotnet/api/Pf2eDataScrapper.WPF.ViewModelBase 'Pf2eDataScrapper\.WPF\.ViewModelBase') 🡒 EntityListViewModel + +| Methods | | +| :--- | :--- | +| [Reload\(\)](EntityListViewModel.Reload().md 'Pf2eDataScrapper\.WPF\.EntityViewer\.ViewModel\.EntityListViewModel\.Reload\(\)') | Выполняет запрос к базе данных и обрабатывает результаты\. | diff --git a/Documentation/Pf2eDataScrapper/EntityView.Entity.md b/Documentation/Pf2eDataScrapper/EntityView.Entity.md new file mode 100644 index 0000000..5062cff --- /dev/null +++ b/Documentation/Pf2eDataScrapper/EntityView.Entity.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Helpers](Pf2eDataScrapper.Helpers.md 'Pf2eDataScrapper\.Helpers').[EntityView](EntityView.md 'Pf2eDataScrapper\.Helpers\.EntityView') + +## EntityView\.Entity Property + +Корневая сущность\. + +```csharp +public Pf2eModel.Model.Base.Entity? Entity { get; } +``` + +#### Property Value +[Pf2eModel\.Model\.Base\.Entity](https://docs.microsoft.com/en-us/dotnet/api/Pf2eModel.Model.Base.Entity 'Pf2eModel\.Model\.Base\.Entity') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/EntityView.EntityView(Pf2eDbContext,EntityType,int).md b/Documentation/Pf2eDataScrapper/EntityView.EntityView(Pf2eDbContext,EntityType,int).md new file mode 100644 index 0000000..e8904ca --- /dev/null +++ b/Documentation/Pf2eDataScrapper/EntityView.EntityView(Pf2eDbContext,EntityType,int).md @@ -0,0 +1,29 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Helpers](Pf2eDataScrapper.Helpers.md 'Pf2eDataScrapper\.Helpers').[EntityView](EntityView.md 'Pf2eDataScrapper\.Helpers\.EntityView') + +## EntityView\(Pf2eDbContext, EntityType, int\) Constructor + +Конструктор класса, который получает сущность из базы данных и заполняет её данными\. + +```csharp +public EntityView(Pf2eModel.Pf2eDbContext context, Pf2eModel.Model.Enum.EntityType type, int id); +``` +#### Parameters + + + +`context` [Pf2eModel\.Pf2eDbContext](https://docs.microsoft.com/en-us/dotnet/api/Pf2eModel.Pf2eDbContext 'Pf2eModel\.Pf2eDbContext') + +Контекст базы данных\. + + + +`type` [Pf2eModel\.Model\.Enum\.EntityType](https://docs.microsoft.com/en-us/dotnet/api/Pf2eModel.Model.Enum.EntityType 'Pf2eModel\.Model\.Enum\.EntityType') + +Тип запрашиваемой сущности\. + + + +`id` [System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') + +Идентификатор запрашиваемой сущности\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/EntityView.Getter.Getter(EntityType).md b/Documentation/Pf2eDataScrapper/EntityView.Getter.Getter(EntityType).md new file mode 100644 index 0000000..5f1604b --- /dev/null +++ b/Documentation/Pf2eDataScrapper/EntityView.Getter.Getter(EntityType).md @@ -0,0 +1,17 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Helpers](Pf2eDataScrapper.Helpers.md 'Pf2eDataScrapper\.Helpers').[EntityView](EntityView.md 'Pf2eDataScrapper\.Helpers\.EntityView').[Getter](EntityView.Getter.md 'Pf2eDataScrapper\.Helpers\.EntityView\.Getter') + +## Getter\(EntityType\) Constructor + +Абстрактный класс, который определяет метод получения сущности из базы данных\. + +```csharp +protected Getter(Pf2eModel.Model.Enum.EntityType type); +``` +#### Parameters + + + +`type` [Pf2eModel\.Model\.Enum\.EntityType](https://docs.microsoft.com/en-us/dotnet/api/Pf2eModel.Model.Enum.EntityType 'Pf2eModel\.Model\.Enum\.EntityType') + +Связанный тип сущности\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/EntityView.Getter.md b/Documentation/Pf2eDataScrapper/EntityView.Getter.md new file mode 100644 index 0000000..ea632f2 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/EntityView.Getter.md @@ -0,0 +1,19 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Helpers](Pf2eDataScrapper.Helpers.md 'Pf2eDataScrapper\.Helpers').[EntityView](EntityView.md 'Pf2eDataScrapper\.Helpers\.EntityView') + +## EntityView\.Getter Class + +Абстрактный класс, который определяет метод получения сущности из базы данных\. + +```csharp +private abstract class EntityView.Getter +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 Getter + +Derived +↳ [Getter<T>](EntityView.Getter_T_.md 'Pf2eDataScrapper\.Helpers\.EntityView\.Getter\') + +| Constructors | | +| :--- | :--- | +| [Getter\(EntityType\)](EntityView.Getter.Getter(EntityType).md 'Pf2eDataScrapper\.Helpers\.EntityView\.Getter\.Getter\(Pf2eModel\.Model\.Enum\.EntityType\)') | Абстрактный класс, который определяет метод получения сущности из базы данных\. | diff --git a/Documentation/Pf2eDataScrapper/EntityView.Getter_T_.Getter(EntityType,Func_Pf2eDbContext,IQueryable_T__).md b/Documentation/Pf2eDataScrapper/EntityView.Getter_T_.Getter(EntityType,Func_Pf2eDbContext,IQueryable_T__).md new file mode 100644 index 0000000..871cb70 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/EntityView.Getter_T_.Getter(EntityType,Func_Pf2eDbContext,IQueryable_T__).md @@ -0,0 +1,23 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Helpers](Pf2eDataScrapper.Helpers.md 'Pf2eDataScrapper\.Helpers').[EntityView](EntityView.md 'Pf2eDataScrapper\.Helpers\.EntityView').[Getter<T>](EntityView.Getter_T_.md 'Pf2eDataScrapper\.Helpers\.EntityView\.Getter\') + +## Getter\(EntityType, Func\\>\) Constructor + +Класс, определяющий метод получения сущности из базы данных\. + +```csharp +public Getter(Pf2eModel.Model.Enum.EntityType type, System.Func> method); +``` +#### Parameters + + + +`type` [Pf2eModel\.Model\.Enum\.EntityType](https://docs.microsoft.com/en-us/dotnet/api/Pf2eModel.Model.Enum.EntityType 'Pf2eModel\.Model\.Enum\.EntityType') + +Связанный тип сущности\. + + + +`method` [System\.Func<](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System\.Func\`2')[Pf2eModel\.Pf2eDbContext](https://docs.microsoft.com/en-us/dotnet/api/Pf2eModel.Pf2eDbContext 'Pf2eModel\.Pf2eDbContext')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System\.Func\`2')[System\.Linq\.IQueryable<](https://docs.microsoft.com/en-us/dotnet/api/System.Linq.IQueryable-1 'System\.Linq\.IQueryable\`1')[T](EntityView.Getter_T_.md#Pf2eDataScrapper.Helpers.EntityView.Getter_T_.T 'Pf2eDataScrapper\.Helpers\.EntityView\.Getter\\.T')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Linq.IQueryable-1 'System\.Linq\.IQueryable\`1')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System\.Func\`2') + +Метод получения сущности из базы данных\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/EntityView.Getter_T_.md b/Documentation/Pf2eDataScrapper/EntityView.Getter_T_.md new file mode 100644 index 0000000..e89e853 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/EntityView.Getter_T_.md @@ -0,0 +1,24 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Helpers](Pf2eDataScrapper.Helpers.md 'Pf2eDataScrapper\.Helpers').[EntityView](EntityView.md 'Pf2eDataScrapper\.Helpers\.EntityView') + +## EntityView\.Getter\ Class + +Класс, определяющий метод получения сущности из базы данных\. + +```csharp +private class EntityView.Getter : Pf2eDataScrapper.Helpers.EntityView.Getter + where T : Pf2eModel.Model.IEntity +``` +#### Type parameters + + + +`T` + +Тип данных основной сущности\. + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [Getter](EntityView.Getter.md 'Pf2eDataScrapper\.Helpers\.EntityView\.Getter') 🡒 Getter + +| Constructors | | +| :--- | :--- | +| [Getter\(EntityType, Func<Pf2eDbContext,IQueryable<T>>\)](EntityView.Getter_T_.Getter(EntityType,Func_Pf2eDbContext,IQueryable_T__).md 'Pf2eDataScrapper\.Helpers\.EntityView\.Getter\\.Getter\(Pf2eModel\.Model\.Enum\.EntityType, System\.Func\\>\)') | Класс, определяющий метод получения сущности из базы данных\. | diff --git a/Documentation/Pf2eDataScrapper/EntityView.SubEntity.md b/Documentation/Pf2eDataScrapper/EntityView.SubEntity.md new file mode 100644 index 0000000..19f5f11 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/EntityView.SubEntity.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Helpers](Pf2eDataScrapper.Helpers.md 'Pf2eDataScrapper\.Helpers').[EntityView](EntityView.md 'Pf2eDataScrapper\.Helpers\.EntityView') + +## EntityView\.SubEntity Property + +Основная сущность\. + +```csharp +public Pf2eModel.Model.IEntity? SubEntity { get; } +``` + +#### Property Value +[Pf2eModel\.Model\.IEntity](https://docs.microsoft.com/en-us/dotnet/api/Pf2eModel.Model.IEntity 'Pf2eModel\.Model\.IEntity') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/EntityView._getters.md b/Documentation/Pf2eDataScrapper/EntityView._getters.md new file mode 100644 index 0000000..9004c67 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/EntityView._getters.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Helpers](Pf2eDataScrapper.Helpers.md 'Pf2eDataScrapper\.Helpers').[EntityView](EntityView.md 'Pf2eDataScrapper\.Helpers\.EntityView') + +## EntityView\.\_getters Field + +Словарь, содержащий методы получения сущностей из базы данных\. + +```csharp +private readonly ICollection _getters; +``` + +#### Field Value +[System\.Collections\.Generic\.ICollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1')[Getter](EntityView.Getter.md 'Pf2eDataScrapper\.Helpers\.EntityView\.Getter')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/EntityView.md b/Documentation/Pf2eDataScrapper/EntityView.md new file mode 100644 index 0000000..b11a9c2 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/EntityView.md @@ -0,0 +1,25 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Helpers](Pf2eDataScrapper.Helpers.md 'Pf2eDataScrapper\.Helpers') + +## EntityView Class + +Класс, обрабатывающий запросы к сущностям и подключающий необходимые данные\. + +```csharp +public class EntityView +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 EntityView + +| Constructors | | +| :--- | :--- | +| [EntityView\(Pf2eDbContext, EntityType, int\)](EntityView.EntityView(Pf2eDbContext,EntityType,int).md 'Pf2eDataScrapper\.Helpers\.EntityView\.EntityView\(Pf2eModel\.Pf2eDbContext, Pf2eModel\.Model\.Enum\.EntityType, int\)') | Конструктор класса, который получает сущность из базы данных и заполняет её данными\. | + +| Fields | | +| :--- | :--- | +| [\_getters](EntityView._getters.md 'Pf2eDataScrapper\.Helpers\.EntityView\.\_getters') | Словарь, содержащий методы получения сущностей из базы данных\. | + +| Properties | | +| :--- | :--- | +| [Entity](EntityView.Entity.md 'Pf2eDataScrapper\.Helpers\.EntityView\.Entity') | Корневая сущность\. | +| [SubEntity](EntityView.SubEntity.md 'Pf2eDataScrapper\.Helpers\.EntityView\.SubEntity') | Основная сущность\. | diff --git a/Documentation/Pf2eDataScrapper/EnumSolver_TEnum_.Data.md b/Documentation/Pf2eDataScrapper/EnumSolver_TEnum_.Data.md new file mode 100644 index 0000000..d5955ae --- /dev/null +++ b/Documentation/Pf2eDataScrapper/EnumSolver_TEnum_.Data.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Processors](Pf2eDataScrapper.Processors.md 'Pf2eDataScrapper\.Processors').[EnumSolver<TEnum>](EnumSolver_TEnum_.md 'Pf2eDataScrapper\.Processors\.EnumSolver\') + +## EnumSolver\\.Data Property + +Словарь, содержащий данные для разрешения значений перечислений\. + +```csharp +public abstract System.Collections.Generic.Dictionary Data { get; } +``` + +#### Property Value +[System\.Collections\.Generic\.Dictionary<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.Dictionary-2 'System\.Collections\.Generic\.Dictionary\`2')[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.Dictionary-2 'System\.Collections\.Generic\.Dictionary\`2')[TEnum](EnumSolver_TEnum_.md#Pf2eDataScrapper.Processors.EnumSolver_TEnum_.TEnum 'Pf2eDataScrapper\.Processors\.EnumSolver\\.TEnum')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.Dictionary-2 'System\.Collections\.Generic\.Dictionary\`2') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/EnumSolver_TEnum_.SolveEnum(string).md b/Documentation/Pf2eDataScrapper/EnumSolver_TEnum_.SolveEnum(string).md new file mode 100644 index 0000000..52de261 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/EnumSolver_TEnum_.SolveEnum(string).md @@ -0,0 +1,21 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Processors](Pf2eDataScrapper.Processors.md 'Pf2eDataScrapper\.Processors').[EnumSolver<TEnum>](EnumSolver_TEnum_.md 'Pf2eDataScrapper\.Processors\.EnumSolver\') + +## EnumSolver\\.SolveEnum\(string\) Method + +Метод для разрешения значения перечисления по строковому вводу\. + +```csharp +public TEnum? SolveEnum(string input); +``` +#### Parameters + + + +`input` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +Строка, представляющая значение перечисления\. + +#### Returns +[TEnum](EnumSolver_TEnum_.md#Pf2eDataScrapper.Processors.EnumSolver_TEnum_.TEnum 'Pf2eDataScrapper\.Processors\.EnumSolver\\.TEnum') +Элемент перечисления [TEnum](EnumSolver_TEnum_.md#Pf2eDataScrapper.Processors.EnumSolver_TEnum_.TEnum 'Pf2eDataScrapper\.Processors\.EnumSolver\\.TEnum'), если найден; иначе `null`\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/EnumSolver_TEnum_.md b/Documentation/Pf2eDataScrapper/EnumSolver_TEnum_.md new file mode 100644 index 0000000..10d493c --- /dev/null +++ b/Documentation/Pf2eDataScrapper/EnumSolver_TEnum_.md @@ -0,0 +1,28 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Processors](Pf2eDataScrapper.Processors.md 'Pf2eDataScrapper\.Processors') + +## EnumSolver\ Class + +Абстрактный класс для разрешения значений перечислений\. + +```csharp +public abstract class EnumSolver + where TEnum : System.Enum +``` +#### Type parameters + + + +`TEnum` + +Тип перечисления, который будет разрешаться\. + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 EnumSolver + +| Properties | | +| :--- | :--- | +| [Data](EnumSolver_TEnum_.Data.md 'Pf2eDataScrapper\.Processors\.EnumSolver\\.Data') | Словарь, содержащий данные для разрешения значений перечислений\. | + +| Methods | | +| :--- | :--- | +| [SolveEnum\(string\)](EnumSolver_TEnum_.SolveEnum(string).md 'Pf2eDataScrapper\.Processors\.EnumSolver\\.SolveEnum\(string\)') | Метод для разрешения значения перечисления по строковому вводу\. | diff --git a/Documentation/Pf2eDataScrapper/EnvSettings.DataDir.md b/Documentation/Pf2eDataScrapper/EnvSettings.DataDir.md new file mode 100644 index 0000000..2ff99d4 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/EnvSettings.DataDir.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper](Pf2eDataScrapper.md 'Pf2eDataScrapper').[EnvSettings](EnvSettings.md 'Pf2eDataScrapper\.EnvSettings') + +## EnvSettings\.DataDir Property + +Папка в входными данными\. + +```csharp +public static System.IO.DirectoryInfo DataDir { get; } +``` + +#### Property Value +[System\.IO\.DirectoryInfo](https://docs.microsoft.com/en-us/dotnet/api/System.IO.DirectoryInfo 'System\.IO\.DirectoryInfo') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/EnvSettings.DataDirPath.md b/Documentation/Pf2eDataScrapper/EnvSettings.DataDirPath.md new file mode 100644 index 0000000..7b21d2a --- /dev/null +++ b/Documentation/Pf2eDataScrapper/EnvSettings.DataDirPath.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper](Pf2eDataScrapper.md 'Pf2eDataScrapper').[EnvSettings](EnvSettings.md 'Pf2eDataScrapper\.EnvSettings') + +## EnvSettings\.DataDirPath Property + +Путь к папке с входными данными\. + +```csharp +public static string DataDirPath { get; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/EnvSettings.DatabaseConnection.md b/Documentation/Pf2eDataScrapper/EnvSettings.DatabaseConnection.md new file mode 100644 index 0000000..579d5d7 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/EnvSettings.DatabaseConnection.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper](Pf2eDataScrapper.md 'Pf2eDataScrapper').[EnvSettings](EnvSettings.md 'Pf2eDataScrapper\.EnvSettings') + +## EnvSettings\.DatabaseConnection Property + +Строка подключения к базе данных\. + +```csharp +public static string DatabaseConnection { get; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/EnvSettings.Load().md b/Documentation/Pf2eDataScrapper/EnvSettings.Load().md new file mode 100644 index 0000000..ae5e9cd --- /dev/null +++ b/Documentation/Pf2eDataScrapper/EnvSettings.Load().md @@ -0,0 +1,10 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper](Pf2eDataScrapper.md 'Pf2eDataScrapper').[EnvSettings](EnvSettings.md 'Pf2eDataScrapper\.EnvSettings') + +## EnvSettings\.Load\(\) Method + +Загрузка файла настроек \`\.env\`\. + +```csharp +public static void Load(); +``` \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/EnvSettings.OutputDir.md b/Documentation/Pf2eDataScrapper/EnvSettings.OutputDir.md new file mode 100644 index 0000000..e9e5725 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/EnvSettings.OutputDir.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper](Pf2eDataScrapper.md 'Pf2eDataScrapper').[EnvSettings](EnvSettings.md 'Pf2eDataScrapper\.EnvSettings') + +## EnvSettings\.OutputDir Property + +Папка для сохранения результатов\. + +```csharp +public static string OutputDir { get; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/EnvSettings.OutputDirPath.md b/Documentation/Pf2eDataScrapper/EnvSettings.OutputDirPath.md new file mode 100644 index 0000000..10bc610 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/EnvSettings.OutputDirPath.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper](Pf2eDataScrapper.md 'Pf2eDataScrapper').[EnvSettings](EnvSettings.md 'Pf2eDataScrapper\.EnvSettings') + +## EnvSettings\.OutputDirPath Property + +Путь к папке для сохранения результатов\. + +```csharp +public static string OutputDirPath { get; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/EnvSettings.md b/Documentation/Pf2eDataScrapper/EnvSettings.md new file mode 100644 index 0000000..d796cdc --- /dev/null +++ b/Documentation/Pf2eDataScrapper/EnvSettings.md @@ -0,0 +1,24 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper](Pf2eDataScrapper.md 'Pf2eDataScrapper') + +## EnvSettings Class + +Класс настроек\. + +```csharp +public static class EnvSettings +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 EnvSettings + +| Properties | | +| :--- | :--- | +| [DatabaseConnection](EnvSettings.DatabaseConnection.md 'Pf2eDataScrapper\.EnvSettings\.DatabaseConnection') | Строка подключения к базе данных\. | +| [DataDir](EnvSettings.DataDir.md 'Pf2eDataScrapper\.EnvSettings\.DataDir') | Папка в входными данными\. | +| [DataDirPath](EnvSettings.DataDirPath.md 'Pf2eDataScrapper\.EnvSettings\.DataDirPath') | Путь к папке с входными данными\. | +| [OutputDir](EnvSettings.OutputDir.md 'Pf2eDataScrapper\.EnvSettings\.OutputDir') | Папка для сохранения результатов\. | +| [OutputDirPath](EnvSettings.OutputDirPath.md 'Pf2eDataScrapper\.EnvSettings\.OutputDirPath') | Путь к папке для сохранения результатов\. | + +| Methods | | +| :--- | :--- | +| [Load\(\)](EnvSettings.Load().md 'Pf2eDataScrapper\.EnvSettings\.Load\(\)') | Загрузка файла настроек \`\.env\`\. | diff --git a/Documentation/Pf2eDataScrapper/FeatProcessor.Add().md b/Documentation/Pf2eDataScrapper/FeatProcessor.Add().md new file mode 100644 index 0000000..8bd8424 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/FeatProcessor.Add().md @@ -0,0 +1,10 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types').[FeatProcessor](FeatProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.FeatProcessor') + +## FeatProcessor\.Add\(\) Method + +Добавление основной сущности в контекст базы данных\. + +```csharp +protected override void Add(); +``` \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/FeatProcessor.GetDescription().md b/Documentation/Pf2eDataScrapper/FeatProcessor.GetDescription().md new file mode 100644 index 0000000..0193045 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/FeatProcessor.GetDescription().md @@ -0,0 +1,14 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types').[FeatProcessor](FeatProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.FeatProcessor') + +## FeatProcessor\.GetDescription\(\) Method + +Сгенерировать описание сущности\. + +```csharp +protected override string GetDescription(); +``` + +#### Returns +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') +Описание сущности \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/FeatProcessor.Object.md b/Documentation/Pf2eDataScrapper/FeatProcessor.Object.md new file mode 100644 index 0000000..a2f10ee --- /dev/null +++ b/Documentation/Pf2eDataScrapper/FeatProcessor.Object.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types').[FeatProcessor](FeatProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.FeatProcessor') + +## FeatProcessor\.Object Property + +Основная сущность\. + +```csharp +public virtual Pf2eModel.Model.Structure.Feat Object { get; } +``` + +#### Property Value +[Pf2eModel\.Model\.Structure\.Feat](https://docs.microsoft.com/en-us/dotnet/api/Pf2eModel.Model.Structure.Feat 'Pf2eModel\.Model\.Structure\.Feat') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/FeatProcessor.Process().md b/Documentation/Pf2eDataScrapper/FeatProcessor.Process().md new file mode 100644 index 0000000..a334456 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/FeatProcessor.Process().md @@ -0,0 +1,12 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types').[FeatProcessor](FeatProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.FeatProcessor') + +## FeatProcessor\.Process\(\) Method + +Основной метод обработки данных\. + +```csharp +public override void Process(); +``` + +Implements [Process\(\)](IProcessor.Process().md 'Pf2eDataScrapper\.Processors\.Definitions\.IProcessor\.Process\(\)') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/FeatProcessor.Type.md b/Documentation/Pf2eDataScrapper/FeatProcessor.Type.md new file mode 100644 index 0000000..9d5dbfe --- /dev/null +++ b/Documentation/Pf2eDataScrapper/FeatProcessor.Type.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types').[FeatProcessor](FeatProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.FeatProcessor') + +## FeatProcessor\.Type Property + +Тип сущности\. + +```csharp +public override Pf2eModel.Model.Enum.EntityType Type { get; } +``` + +#### Property Value +[Pf2eModel\.Model\.Enum\.EntityType](https://docs.microsoft.com/en-us/dotnet/api/Pf2eModel.Model.Enum.EntityType 'Pf2eModel\.Model\.Enum\.EntityType') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/FeatProcessor.md b/Documentation/Pf2eDataScrapper/FeatProcessor.md new file mode 100644 index 0000000..9a55664 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/FeatProcessor.md @@ -0,0 +1,21 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types') + +## FeatProcessor Class + +```csharp +internal class FeatProcessor : Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.AbstractEntityProcessor +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [AbstractInputProcessor](AbstractInputProcessor.md 'Pf2eDataScrapper\.Processors\.Definitions\.AbstractInputProcessor') 🡒 [AbstractEntityProcessor](AbstractEntityProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.AbstractEntityProcessor') 🡒 FeatProcessor + +| Properties | | +| :--- | :--- | +| [Object](FeatProcessor.Object.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.FeatProcessor\.Object') | Основная сущность\. | +| [Type](FeatProcessor.Type.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.FeatProcessor\.Type') | Тип сущности\. | + +| Methods | | +| :--- | :--- | +| [Add\(\)](FeatProcessor.Add().md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.FeatProcessor\.Add\(\)') | Добавление основной сущности в контекст базы данных\. | +| [GetDescription\(\)](FeatProcessor.GetDescription().md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.FeatProcessor\.GetDescription\(\)') | Сгенерировать описание сущности\. | +| [Process\(\)](FeatProcessor.Process().md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.FeatProcessor\.Process\(\)') | Основной метод обработки данных\. | diff --git a/Documentation/Pf2eDataScrapper/FoundryEnCompendium.Count(ICollection_string_).md b/Documentation/Pf2eDataScrapper/FoundryEnCompendium.Count(ICollection_string_).md new file mode 100644 index 0000000..73dbc5c --- /dev/null +++ b/Documentation/Pf2eDataScrapper/FoundryEnCompendium.Count(ICollection_string_).md @@ -0,0 +1,19 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium](Pf2eDataScrapper.Importers.Implementations.FoundryEn.Compendium.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium').[FoundryEnCompendium](FoundryEnCompendium.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium\.FoundryEnCompendium') + +## FoundryEnCompendium\.Count\(ICollection\\) Method + +Возвращает количество элементов для указанного типа данных\. + +```csharp +public override int Count(System.Collections.Generic.ICollection types); +``` +#### Parameters + + + +`types` [System\.Collections\.Generic\.ICollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1')[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1') + +#### Returns +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') +Количество элементов\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/FoundryEnCompendium.Folders.md b/Documentation/Pf2eDataScrapper/FoundryEnCompendium.Folders.md new file mode 100644 index 0000000..8ead3a1 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/FoundryEnCompendium.Folders.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium](Pf2eDataScrapper.Importers.Implementations.FoundryEn.Compendium.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium').[FoundryEnCompendium](FoundryEnCompendium.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium\.FoundryEnCompendium') + +## FoundryEnCompendium\.Folders Property + +Набор папок компендиума + +```csharp +public Pf2eDataScrapper.Importers.Implementations.FoundryEn.Compendium.CompendiumFolderCollection Folders { get; } +``` + +#### Property Value +[CompendiumFolderCollection](CompendiumFolderCollection.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium\.CompendiumFolderCollection') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/FoundryEnCompendium.FoundryEnCompendium(FoundryEnRepository,CompendiumFolderCollection).md b/Documentation/Pf2eDataScrapper/FoundryEnCompendium.FoundryEnCompendium(FoundryEnRepository,CompendiumFolderCollection).md new file mode 100644 index 0000000..be92a4a --- /dev/null +++ b/Documentation/Pf2eDataScrapper/FoundryEnCompendium.FoundryEnCompendium(FoundryEnRepository,CompendiumFolderCollection).md @@ -0,0 +1,23 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium](Pf2eDataScrapper.Importers.Implementations.FoundryEn.Compendium.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium').[FoundryEnCompendium](FoundryEnCompendium.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium\.FoundryEnCompendium') + +## FoundryEnCompendium\(FoundryEnRepository, CompendiumFolderCollection\) Constructor + +Загрузчик данных компендиума\. + +```csharp +public FoundryEnCompendium(Pf2eDataScrapper.Importers.Implementations.FoundryEn.FoundryEnRepository repository, Pf2eDataScrapper.Importers.Implementations.FoundryEn.Compendium.CompendiumFolderCollection folders); +``` +#### Parameters + + + +`repository` [FoundryEnRepository](FoundryEnRepository.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.FoundryEnRepository') + +Репозиторий данных\. + + + +`folders` [CompendiumFolderCollection](CompendiumFolderCollection.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium\.CompendiumFolderCollection') + +\[DI\] Коллекция папок компендиумов\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/FoundryEnCompendium.Items.md b/Documentation/Pf2eDataScrapper/FoundryEnCompendium.Items.md new file mode 100644 index 0000000..72981a1 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/FoundryEnCompendium.Items.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium](Pf2eDataScrapper.Importers.Implementations.FoundryEn.Compendium.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium').[FoundryEnCompendium](FoundryEnCompendium.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium\.FoundryEnCompendium') + +## FoundryEnCompendium\.Items Property + +Коллекция всех записей компендиума\. + +```csharp +public System.Collections.Concurrent.ConcurrentBag Items { get; } +``` + +#### Property Value +[System\.Collections\.Concurrent\.ConcurrentBag<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Concurrent.ConcurrentBag-1 'System\.Collections\.Concurrent\.ConcurrentBag\`1')[FoundryEnCompendiumItem](FoundryEnCompendiumItem.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium\.FoundryEnCompendiumItem')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Concurrent.ConcurrentBag-1 'System\.Collections\.Concurrent\.ConcurrentBag\`1') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/FoundryEnCompendium.Iterate(ICollection_string_).md b/Documentation/Pf2eDataScrapper/FoundryEnCompendium.Iterate(ICollection_string_).md new file mode 100644 index 0000000..b8f35bb --- /dev/null +++ b/Documentation/Pf2eDataScrapper/FoundryEnCompendium.Iterate(ICollection_string_).md @@ -0,0 +1,19 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium](Pf2eDataScrapper.Importers.Implementations.FoundryEn.Compendium.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium').[FoundryEnCompendium](FoundryEnCompendium.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium\.FoundryEnCompendium') + +## FoundryEnCompendium\.Iterate\(ICollection\\) Method + +Получение итератора сущностей\. Если указан тип type \- то только указанного типа\. + +```csharp +public override System.Collections.Generic.IEnumerable> Iterate(System.Collections.Generic.ICollection types); +``` +#### Parameters + + + +`types` [System\.Collections\.Generic\.ICollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1')[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1') + +#### Returns +[System\.Collections\.Generic\.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System\.Collections\.Generic\.IEnumerable\`1')[System\.Tuple<](https://docs.microsoft.com/en-us/dotnet/api/System.Tuple-2 'System\.Tuple\`2')[AbstractCompendiumItem](AbstractCompendiumItem.md 'Pf2eDataScrapper\.Importers\.AbstractCompendiumItem')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Tuple-2 'System\.Tuple\`2')[Newtonsoft\.Json\.Linq\.JObject](https://docs.microsoft.com/en-us/dotnet/api/Newtonsoft.Json.Linq.JObject 'Newtonsoft\.Json\.Linq\.JObject')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Tuple-2 'System\.Tuple\`2')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System\.Collections\.Generic\.IEnumerable\`1') +Итератор сущностей\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/FoundryEnCompendium.Repository.md b/Documentation/Pf2eDataScrapper/FoundryEnCompendium.Repository.md new file mode 100644 index 0000000..a217ed3 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/FoundryEnCompendium.Repository.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium](Pf2eDataScrapper.Importers.Implementations.FoundryEn.Compendium.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium').[FoundryEnCompendium](FoundryEnCompendium.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium\.FoundryEnCompendium') + +## FoundryEnCompendium\.Repository Property + +Репозиторий данных\. + +```csharp +public virtual Pf2eDataScrapper.Importers.Implementations.FoundryEn.FoundryEnRepository Repository { get; } +``` + +#### Property Value +[FoundryEnRepository](FoundryEnRepository.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.FoundryEnRepository') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/FoundryEnCompendium.md b/Documentation/Pf2eDataScrapper/FoundryEnCompendium.md new file mode 100644 index 0000000..d0733d6 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/FoundryEnCompendium.md @@ -0,0 +1,27 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium](Pf2eDataScrapper.Importers.Implementations.FoundryEn.Compendium.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium') + +## FoundryEnCompendium Class + +Загрузчик данных компендиума\. + +```csharp +internal sealed class FoundryEnCompendium : Pf2eDataScrapper.Importers.AbstractCompendium +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [AbstractCompendium](AbstractCompendium.md 'Pf2eDataScrapper\.Importers\.AbstractCompendium') 🡒 FoundryEnCompendium + +| Constructors | | +| :--- | :--- | +| [FoundryEnCompendium\(FoundryEnRepository, CompendiumFolderCollection\)](FoundryEnCompendium.FoundryEnCompendium(FoundryEnRepository,CompendiumFolderCollection).md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium\.FoundryEnCompendium\.FoundryEnCompendium\(Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.FoundryEnRepository, Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium\.CompendiumFolderCollection\)') | Загрузчик данных компендиума\. | + +| Properties | | +| :--- | :--- | +| [Folders](FoundryEnCompendium.Folders.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium\.FoundryEnCompendium\.Folders') | Набор папок компендиума | +| [Items](FoundryEnCompendium.Items.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium\.FoundryEnCompendium\.Items') | Коллекция всех записей компендиума\. | +| [Repository](FoundryEnCompendium.Repository.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium\.FoundryEnCompendium\.Repository') | Репозиторий данных\. | + +| Methods | | +| :--- | :--- | +| [Count\(ICollection<string>\)](FoundryEnCompendium.Count(ICollection_string_).md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium\.FoundryEnCompendium\.Count\(System\.Collections\.Generic\.ICollection\\)') | Возвращает количество элементов для указанного типа данных\. | +| [Iterate\(ICollection<string>\)](FoundryEnCompendium.Iterate(ICollection_string_).md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium\.FoundryEnCompendium\.Iterate\(System\.Collections\.Generic\.ICollection\\)') | Получение итератора сущностей\. Если указан тип type \- то только указанного типа\. | diff --git a/Documentation/Pf2eDataScrapper/FoundryEnCompendiumItem.File.md b/Documentation/Pf2eDataScrapper/FoundryEnCompendiumItem.File.md new file mode 100644 index 0000000..c5d13c5 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/FoundryEnCompendiumItem.File.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium](Pf2eDataScrapper.Importers.Implementations.FoundryEn.Compendium.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium').[FoundryEnCompendiumItem](FoundryEnCompendiumItem.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium\.FoundryEnCompendiumItem') + +## FoundryEnCompendiumItem\.File Property + +Имя файла, в котором хранится сущность\. + +```csharp +public string File { get; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/FoundryEnCompendiumItem.FoundryEnCompendiumItem(string,string,string).md b/Documentation/Pf2eDataScrapper/FoundryEnCompendiumItem.FoundryEnCompendiumItem(string,string,string).md new file mode 100644 index 0000000..b9afeb9 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/FoundryEnCompendiumItem.FoundryEnCompendiumItem(string,string,string).md @@ -0,0 +1,29 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium](Pf2eDataScrapper.Importers.Implementations.FoundryEn.Compendium.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium').[FoundryEnCompendiumItem](FoundryEnCompendiumItem.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium\.FoundryEnCompendiumItem') + +## FoundryEnCompendiumItem\(string, string, string\) Constructor + +Ссылка на сущность с указанием файла, в котором она хранится\. + +```csharp +public FoundryEnCompendiumItem(string id, string type, string file); +``` +#### Parameters + + + +`id` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +Идентификатор сущности\. + + + +`type` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +Тип сущности\. + + + +`file` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +Имя файла, в котором хранится сущность\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/FoundryEnCompendiumItem.Id.md b/Documentation/Pf2eDataScrapper/FoundryEnCompendiumItem.Id.md new file mode 100644 index 0000000..3e1ec42 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/FoundryEnCompendiumItem.Id.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium](Pf2eDataScrapper.Importers.Implementations.FoundryEn.Compendium.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium').[FoundryEnCompendiumItem](FoundryEnCompendiumItem.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium\.FoundryEnCompendiumItem') + +## FoundryEnCompendiumItem\.Id Property + +Идентификатор сущности\. + +```csharp +public override string Id { get; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/FoundryEnCompendiumItem.Type.md b/Documentation/Pf2eDataScrapper/FoundryEnCompendiumItem.Type.md new file mode 100644 index 0000000..c289deb --- /dev/null +++ b/Documentation/Pf2eDataScrapper/FoundryEnCompendiumItem.Type.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium](Pf2eDataScrapper.Importers.Implementations.FoundryEn.Compendium.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium').[FoundryEnCompendiumItem](FoundryEnCompendiumItem.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium\.FoundryEnCompendiumItem') + +## FoundryEnCompendiumItem\.Type Property + +Тип сущности\. + +```csharp +public override string Type { get; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/FoundryEnCompendiumItem.md b/Documentation/Pf2eDataScrapper/FoundryEnCompendiumItem.md new file mode 100644 index 0000000..42bfc84 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/FoundryEnCompendiumItem.md @@ -0,0 +1,22 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium](Pf2eDataScrapper.Importers.Implementations.FoundryEn.Compendium.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium') + +## FoundryEnCompendiumItem Class + +Ссылка на сущность с указанием файла, в котором она хранится\. + +```csharp +internal class FoundryEnCompendiumItem : Pf2eDataScrapper.Importers.AbstractCompendiumItem +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [AbstractCompendiumItem](AbstractCompendiumItem.md 'Pf2eDataScrapper\.Importers\.AbstractCompendiumItem') 🡒 FoundryEnCompendiumItem + +| Constructors | | +| :--- | :--- | +| [FoundryEnCompendiumItem\(string, string, string\)](FoundryEnCompendiumItem.FoundryEnCompendiumItem(string,string,string).md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium\.FoundryEnCompendiumItem\.FoundryEnCompendiumItem\(string, string, string\)') | Ссылка на сущность с указанием файла, в котором она хранится\. | + +| Properties | | +| :--- | :--- | +| [File](FoundryEnCompendiumItem.File.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium\.FoundryEnCompendiumItem\.File') | Имя файла, в котором хранится сущность\. | +| [Id](FoundryEnCompendiumItem.Id.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium\.FoundryEnCompendiumItem\.Id') | Идентификатор сущности\. | +| [Type](FoundryEnCompendiumItem.Type.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium\.FoundryEnCompendiumItem\.Type') | Тип сущности\. | diff --git a/Documentation/Pf2eDataScrapper/FoundryEnImporter.Name.md b/Documentation/Pf2eDataScrapper/FoundryEnImporter.Name.md new file mode 100644 index 0000000..a569f44 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/FoundryEnImporter.Name.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn](Pf2eDataScrapper.Importers.Implementations.FoundryEn.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn').[FoundryEnImporter](FoundryEnImporter.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.FoundryEnImporter') + +## FoundryEnImporter\.Name Property + +Отображаемое имя импортёра\. + +```csharp +public override string Name { get; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/FoundryEnImporter.Slug.md b/Documentation/Pf2eDataScrapper/FoundryEnImporter.Slug.md new file mode 100644 index 0000000..ad55f3b --- /dev/null +++ b/Documentation/Pf2eDataScrapper/FoundryEnImporter.Slug.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn](Pf2eDataScrapper.Importers.Implementations.FoundryEn.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn').[FoundryEnImporter](FoundryEnImporter.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.FoundryEnImporter') + +## FoundryEnImporter\.Slug Property + +Короткое имя импортёра\. + +```csharp +public override string Slug { get; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/FoundryEnImporter.TargetName.md b/Documentation/Pf2eDataScrapper/FoundryEnImporter.TargetName.md new file mode 100644 index 0000000..0c11aa6 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/FoundryEnImporter.TargetName.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn](Pf2eDataScrapper.Importers.Implementations.FoundryEn.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn').[FoundryEnImporter](FoundryEnImporter.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.FoundryEnImporter') + +## FoundryEnImporter\.TargetName Field + +Название внешней ссылки\. + +```csharp +public const string TargetName = "Pf2e FoundryVTT module"; +``` + +#### Field Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/FoundryEnImporter.md b/Documentation/Pf2eDataScrapper/FoundryEnImporter.md new file mode 100644 index 0000000..9791591 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/FoundryEnImporter.md @@ -0,0 +1,21 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn](Pf2eDataScrapper.Importers.Implementations.FoundryEn.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn') + +## FoundryEnImporter Class + +Импортёр для модуля Pf2e FoundryVTT\. + +```csharp +internal class FoundryEnImporter : Pf2eDataScrapper.Importers.AbstractImporter +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [AbstractImporter](AbstractImporter.md 'Pf2eDataScrapper\.Importers\.AbstractImporter') 🡒 FoundryEnImporter + +| Fields | | +| :--- | :--- | +| [TargetName](FoundryEnImporter.TargetName.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.FoundryEnImporter\.TargetName') | Название внешней ссылки\. | + +| Properties | | +| :--- | :--- | +| [Name](FoundryEnImporter.Name.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.FoundryEnImporter\.Name') | Отображаемое имя импортёра\. | +| [Slug](FoundryEnImporter.Slug.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.FoundryEnImporter\.Slug') | Короткое имя импортёра\. | diff --git a/Documentation/Pf2eDataScrapper/FoundryEnRepository.FoundryEnRepository(FoundryEnImporter).md b/Documentation/Pf2eDataScrapper/FoundryEnRepository.FoundryEnRepository(FoundryEnImporter).md new file mode 100644 index 0000000..235c1ad --- /dev/null +++ b/Documentation/Pf2eDataScrapper/FoundryEnRepository.FoundryEnRepository(FoundryEnImporter).md @@ -0,0 +1,17 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn](Pf2eDataScrapper.Importers.Implementations.FoundryEn.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn').[FoundryEnRepository](FoundryEnRepository.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.FoundryEnRepository') + +## FoundryEnRepository\(FoundryEnImporter\) Constructor + +Git\-репозиторий данных FoundryVTT\-модуля "pf2e"\. + +```csharp +public FoundryEnRepository(Pf2eDataScrapper.Importers.Implementations.FoundryEn.FoundryEnImporter importer); +``` +#### Parameters + + + +`importer` [FoundryEnImporter](FoundryEnImporter.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.FoundryEnImporter') + +\ \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/FoundryEnRepository.md b/Documentation/Pf2eDataScrapper/FoundryEnRepository.md new file mode 100644 index 0000000..6cc12d3 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/FoundryEnRepository.md @@ -0,0 +1,16 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn](Pf2eDataScrapper.Importers.Implementations.FoundryEn.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn') + +## FoundryEnRepository Class + +Git\-репозиторий данных FoundryVTT\-модуля "pf2e"\. + +```csharp +internal class FoundryEnRepository : Pf2eDataScrapper.Importers.Repositories.GitRepository +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [AbstractImporterRepository](AbstractImporterRepository.md 'Pf2eDataScrapper\.Importers\.Repositories\.AbstractImporterRepository') 🡒 [GitRepository](GitRepository.md 'Pf2eDataScrapper\.Importers\.Repositories\.GitRepository') 🡒 FoundryEnRepository + +| Constructors | | +| :--- | :--- | +| [FoundryEnRepository\(FoundryEnImporter\)](FoundryEnRepository.FoundryEnRepository(FoundryEnImporter).md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.FoundryEnRepository\.FoundryEnRepository\(Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.FoundryEnImporter\)') | Git\-репозиторий данных FoundryVTT\-модуля "pf2e"\. | diff --git a/Documentation/Pf2eDataScrapper/GeneratedInternalTypeHelper.AddEventHandler(EventInfo,object,Delegate).md b/Documentation/Pf2eDataScrapper/GeneratedInternalTypeHelper.AddEventHandler(EventInfo,object,Delegate).md new file mode 100644 index 0000000..9cf85e0 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/GeneratedInternalTypeHelper.AddEventHandler(EventInfo,object,Delegate).md @@ -0,0 +1,23 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [XamlGeneratedNamespace](XamlGeneratedNamespace.md 'XamlGeneratedNamespace').[GeneratedInternalTypeHelper](GeneratedInternalTypeHelper.md 'XamlGeneratedNamespace\.GeneratedInternalTypeHelper') + +## GeneratedInternalTypeHelper\.AddEventHandler\(EventInfo, object, Delegate\) Method + +AddEventHandler + +```csharp +protected override void AddEventHandler(System.Reflection.EventInfo eventInfo, object target, System.Delegate handler); +``` +#### Parameters + + + +`eventInfo` [System\.Reflection\.EventInfo](https://docs.microsoft.com/en-us/dotnet/api/System.Reflection.EventInfo 'System\.Reflection\.EventInfo') + + + +`target` [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') + + + +`handler` [System\.Delegate](https://docs.microsoft.com/en-us/dotnet/api/System.Delegate 'System\.Delegate') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/GeneratedInternalTypeHelper.CreateDelegate(Type,object,string).md b/Documentation/Pf2eDataScrapper/GeneratedInternalTypeHelper.CreateDelegate(Type,object,string).md new file mode 100644 index 0000000..767ce06 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/GeneratedInternalTypeHelper.CreateDelegate(Type,object,string).md @@ -0,0 +1,26 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [XamlGeneratedNamespace](XamlGeneratedNamespace.md 'XamlGeneratedNamespace').[GeneratedInternalTypeHelper](GeneratedInternalTypeHelper.md 'XamlGeneratedNamespace\.GeneratedInternalTypeHelper') + +## GeneratedInternalTypeHelper\.CreateDelegate\(Type, object, string\) Method + +CreateDelegate + +```csharp +protected override System.Delegate CreateDelegate(System.Type delegateType, object target, string handler); +``` +#### Parameters + + + +`delegateType` [System\.Type](https://docs.microsoft.com/en-us/dotnet/api/System.Type 'System\.Type') + + + +`target` [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') + + + +`handler` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +#### Returns +[System\.Delegate](https://docs.microsoft.com/en-us/dotnet/api/System.Delegate 'System\.Delegate') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/GeneratedInternalTypeHelper.CreateInstance(Type,CultureInfo).md b/Documentation/Pf2eDataScrapper/GeneratedInternalTypeHelper.CreateInstance(Type,CultureInfo).md new file mode 100644 index 0000000..207f8ed --- /dev/null +++ b/Documentation/Pf2eDataScrapper/GeneratedInternalTypeHelper.CreateInstance(Type,CultureInfo).md @@ -0,0 +1,22 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [XamlGeneratedNamespace](XamlGeneratedNamespace.md 'XamlGeneratedNamespace').[GeneratedInternalTypeHelper](GeneratedInternalTypeHelper.md 'XamlGeneratedNamespace\.GeneratedInternalTypeHelper') + +## GeneratedInternalTypeHelper\.CreateInstance\(Type, CultureInfo\) Method + +CreateInstance + +```csharp +protected override object CreateInstance(System.Type type, System.Globalization.CultureInfo culture); +``` +#### Parameters + + + +`type` [System\.Type](https://docs.microsoft.com/en-us/dotnet/api/System.Type 'System\.Type') + + + +`culture` [System\.Globalization\.CultureInfo](https://docs.microsoft.com/en-us/dotnet/api/System.Globalization.CultureInfo 'System\.Globalization\.CultureInfo') + +#### Returns +[System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/GeneratedInternalTypeHelper.GetPropertyValue(PropertyInfo,object,CultureInfo).md b/Documentation/Pf2eDataScrapper/GeneratedInternalTypeHelper.GetPropertyValue(PropertyInfo,object,CultureInfo).md new file mode 100644 index 0000000..6980d24 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/GeneratedInternalTypeHelper.GetPropertyValue(PropertyInfo,object,CultureInfo).md @@ -0,0 +1,26 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [XamlGeneratedNamespace](XamlGeneratedNamespace.md 'XamlGeneratedNamespace').[GeneratedInternalTypeHelper](GeneratedInternalTypeHelper.md 'XamlGeneratedNamespace\.GeneratedInternalTypeHelper') + +## GeneratedInternalTypeHelper\.GetPropertyValue\(PropertyInfo, object, CultureInfo\) Method + +GetPropertyValue + +```csharp +protected override object GetPropertyValue(System.Reflection.PropertyInfo propertyInfo, object target, System.Globalization.CultureInfo culture); +``` +#### Parameters + + + +`propertyInfo` [System\.Reflection\.PropertyInfo](https://docs.microsoft.com/en-us/dotnet/api/System.Reflection.PropertyInfo 'System\.Reflection\.PropertyInfo') + + + +`target` [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') + + + +`culture` [System\.Globalization\.CultureInfo](https://docs.microsoft.com/en-us/dotnet/api/System.Globalization.CultureInfo 'System\.Globalization\.CultureInfo') + +#### Returns +[System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/GeneratedInternalTypeHelper.SetPropertyValue(PropertyInfo,object,object,CultureInfo).md b/Documentation/Pf2eDataScrapper/GeneratedInternalTypeHelper.SetPropertyValue(PropertyInfo,object,object,CultureInfo).md new file mode 100644 index 0000000..5f130dd --- /dev/null +++ b/Documentation/Pf2eDataScrapper/GeneratedInternalTypeHelper.SetPropertyValue(PropertyInfo,object,object,CultureInfo).md @@ -0,0 +1,27 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [XamlGeneratedNamespace](XamlGeneratedNamespace.md 'XamlGeneratedNamespace').[GeneratedInternalTypeHelper](GeneratedInternalTypeHelper.md 'XamlGeneratedNamespace\.GeneratedInternalTypeHelper') + +## GeneratedInternalTypeHelper\.SetPropertyValue\(PropertyInfo, object, object, CultureInfo\) Method + +SetPropertyValue + +```csharp +protected override void SetPropertyValue(System.Reflection.PropertyInfo propertyInfo, object target, object value, System.Globalization.CultureInfo culture); +``` +#### Parameters + + + +`propertyInfo` [System\.Reflection\.PropertyInfo](https://docs.microsoft.com/en-us/dotnet/api/System.Reflection.PropertyInfo 'System\.Reflection\.PropertyInfo') + + + +`target` [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') + + + +`value` [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') + + + +`culture` [System\.Globalization\.CultureInfo](https://docs.microsoft.com/en-us/dotnet/api/System.Globalization.CultureInfo 'System\.Globalization\.CultureInfo') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/GeneratedInternalTypeHelper.md b/Documentation/Pf2eDataScrapper/GeneratedInternalTypeHelper.md new file mode 100644 index 0000000..7b40245 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/GeneratedInternalTypeHelper.md @@ -0,0 +1,20 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [XamlGeneratedNamespace](XamlGeneratedNamespace.md 'XamlGeneratedNamespace') + +## GeneratedInternalTypeHelper Class + +GeneratedInternalTypeHelper + +```csharp +public sealed class GeneratedInternalTypeHelper : System.Windows.Markup.InternalTypeHelper +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [System\.Windows\.Markup\.InternalTypeHelper](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.Markup.InternalTypeHelper 'System\.Windows\.Markup\.InternalTypeHelper') 🡒 GeneratedInternalTypeHelper + +| Methods | | +| :--- | :--- | +| [AddEventHandler\(EventInfo, object, Delegate\)](GeneratedInternalTypeHelper.AddEventHandler(EventInfo,object,Delegate).md 'XamlGeneratedNamespace\.GeneratedInternalTypeHelper\.AddEventHandler\(System\.Reflection\.EventInfo, object, System\.Delegate\)') | AddEventHandler | +| [CreateDelegate\(Type, object, string\)](GeneratedInternalTypeHelper.CreateDelegate(Type,object,string).md 'XamlGeneratedNamespace\.GeneratedInternalTypeHelper\.CreateDelegate\(System\.Type, object, string\)') | CreateDelegate | +| [CreateInstance\(Type, CultureInfo\)](GeneratedInternalTypeHelper.CreateInstance(Type,CultureInfo).md 'XamlGeneratedNamespace\.GeneratedInternalTypeHelper\.CreateInstance\(System\.Type, System\.Globalization\.CultureInfo\)') | CreateInstance | +| [GetPropertyValue\(PropertyInfo, object, CultureInfo\)](GeneratedInternalTypeHelper.GetPropertyValue(PropertyInfo,object,CultureInfo).md 'XamlGeneratedNamespace\.GeneratedInternalTypeHelper\.GetPropertyValue\(System\.Reflection\.PropertyInfo, object, System\.Globalization\.CultureInfo\)') | GetPropertyValue | +| [SetPropertyValue\(PropertyInfo, object, object, CultureInfo\)](GeneratedInternalTypeHelper.SetPropertyValue(PropertyInfo,object,object,CultureInfo).md 'XamlGeneratedNamespace\.GeneratedInternalTypeHelper\.SetPropertyValue\(System\.Reflection\.PropertyInfo, object, object, System\.Globalization\.CultureInfo\)') | SetPropertyValue | diff --git a/Documentation/Pf2eDataScrapper/GitRepository.GitRepository(AbstractImporter,string).md b/Documentation/Pf2eDataScrapper/GitRepository.GitRepository(AbstractImporter,string).md new file mode 100644 index 0000000..897f29d --- /dev/null +++ b/Documentation/Pf2eDataScrapper/GitRepository.GitRepository(AbstractImporter,string).md @@ -0,0 +1,23 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Repositories](Pf2eDataScrapper.Importers.Repositories.md 'Pf2eDataScrapper\.Importers\.Repositories').[GitRepository](GitRepository.md 'Pf2eDataScrapper\.Importers\.Repositories\.GitRepository') + +## GitRepository\(AbstractImporter, string\) Constructor + +Репозиторий, загружающий данные из GIT\-источника\. + +```csharp +public GitRepository(Pf2eDataScrapper.Importers.AbstractImporter importer, string url); +``` +#### Parameters + + + +`importer` [AbstractImporter](AbstractImporter.md 'Pf2eDataScrapper\.Importers\.AbstractImporter') + +Импортёр, использующий репозиторий\. + + + +`url` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +Ссылка на GIT\-репозиторий\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/GitRepository.Update(ProcessProgress).md b/Documentation/Pf2eDataScrapper/GitRepository.Update(ProcessProgress).md new file mode 100644 index 0000000..7a1ef62 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/GitRepository.Update(ProcessProgress).md @@ -0,0 +1,15 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Repositories](Pf2eDataScrapper.Importers.Repositories.md 'Pf2eDataScrapper\.Importers\.Repositories').[GitRepository](GitRepository.md 'Pf2eDataScrapper\.Importers\.Repositories\.GitRepository') + +## GitRepository\.Update\(ProcessProgress\) Method + +Обновление данных в репозитории\. + +```csharp +public override void Update(Pf2eDataScrapper.Helpers.ProcessProgress progress); +``` +#### Parameters + + + +`progress` [ProcessProgress](ProcessProgress.md 'Pf2eDataScrapper\.Helpers\.ProcessProgress') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/GitRepository.Url.md b/Documentation/Pf2eDataScrapper/GitRepository.Url.md new file mode 100644 index 0000000..96e4b4e --- /dev/null +++ b/Documentation/Pf2eDataScrapper/GitRepository.Url.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Repositories](Pf2eDataScrapper.Importers.Repositories.md 'Pf2eDataScrapper\.Importers\.Repositories').[GitRepository](GitRepository.md 'Pf2eDataScrapper\.Importers\.Repositories\.GitRepository') + +## GitRepository\.Url Property + +Ссылка на GIT\-репозиторий\. + +```csharp +public string Url { get; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/GitRepository.md b/Documentation/Pf2eDataScrapper/GitRepository.md new file mode 100644 index 0000000..ffd3212 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/GitRepository.md @@ -0,0 +1,27 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Repositories](Pf2eDataScrapper.Importers.Repositories.md 'Pf2eDataScrapper\.Importers\.Repositories') + +## GitRepository Class + +Репозиторий, загружающий данные из GIT\-источника\. + +```csharp +internal class GitRepository : Pf2eDataScrapper.Importers.Repositories.AbstractImporterRepository +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [AbstractImporterRepository](AbstractImporterRepository.md 'Pf2eDataScrapper\.Importers\.Repositories\.AbstractImporterRepository') 🡒 GitRepository + +Derived +↳ [FoundryEnRepository](FoundryEnRepository.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.FoundryEnRepository') + +| Constructors | | +| :--- | :--- | +| [GitRepository\(AbstractImporter, string\)](GitRepository.GitRepository(AbstractImporter,string).md 'Pf2eDataScrapper\.Importers\.Repositories\.GitRepository\.GitRepository\(Pf2eDataScrapper\.Importers\.AbstractImporter, string\)') | Репозиторий, загружающий данные из GIT\-источника\. | + +| Properties | | +| :--- | :--- | +| [Url](GitRepository.Url.md 'Pf2eDataScrapper\.Importers\.Repositories\.GitRepository\.Url') | Ссылка на GIT\-репозиторий\. | + +| Methods | | +| :--- | :--- | +| [Update\(ProcessProgress\)](GitRepository.Update(ProcessProgress).md 'Pf2eDataScrapper\.Importers\.Repositories\.GitRepository\.Update\(Pf2eDataScrapper\.Helpers\.ProcessProgress\)') | Обновление данных в репозитории\. | diff --git a/Documentation/Pf2eDataScrapper/HeritageProcessor.Add().md b/Documentation/Pf2eDataScrapper/HeritageProcessor.Add().md new file mode 100644 index 0000000..2b2b984 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/HeritageProcessor.Add().md @@ -0,0 +1,10 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types').[HeritageProcessor](HeritageProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.HeritageProcessor') + +## HeritageProcessor\.Add\(\) Method + +Добавление основной сущности в контекст базы данных\. + +```csharp +protected override void Add(); +``` \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/HeritageProcessor.Object.md b/Documentation/Pf2eDataScrapper/HeritageProcessor.Object.md new file mode 100644 index 0000000..659157b --- /dev/null +++ b/Documentation/Pf2eDataScrapper/HeritageProcessor.Object.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types').[HeritageProcessor](HeritageProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.HeritageProcessor') + +## HeritageProcessor\.Object Property + +Основная сущность\. + +```csharp +public virtual Pf2eModel.Model.Structure.Heritage Object { get; } +``` + +#### Property Value +[Pf2eModel\.Model\.Structure\.Heritage](https://docs.microsoft.com/en-us/dotnet/api/Pf2eModel.Model.Structure.Heritage 'Pf2eModel\.Model\.Structure\.Heritage') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/HeritageProcessor.Process().md b/Documentation/Pf2eDataScrapper/HeritageProcessor.Process().md new file mode 100644 index 0000000..a138c21 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/HeritageProcessor.Process().md @@ -0,0 +1,12 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types').[HeritageProcessor](HeritageProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.HeritageProcessor') + +## HeritageProcessor\.Process\(\) Method + +Основной метод обработки данных\. + +```csharp +public override void Process(); +``` + +Implements [Process\(\)](IProcessor.Process().md 'Pf2eDataScrapper\.Processors\.Definitions\.IProcessor\.Process\(\)') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/HeritageProcessor.Type.md b/Documentation/Pf2eDataScrapper/HeritageProcessor.Type.md new file mode 100644 index 0000000..bff1121 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/HeritageProcessor.Type.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types').[HeritageProcessor](HeritageProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.HeritageProcessor') + +## HeritageProcessor\.Type Property + +Тип сущности\. + +```csharp +public override Pf2eModel.Model.Enum.EntityType Type { get; } +``` + +#### Property Value +[Pf2eModel\.Model\.Enum\.EntityType](https://docs.microsoft.com/en-us/dotnet/api/Pf2eModel.Model.Enum.EntityType 'Pf2eModel\.Model\.Enum\.EntityType') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/HeritageProcessor.md b/Documentation/Pf2eDataScrapper/HeritageProcessor.md new file mode 100644 index 0000000..ab3c9a4 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/HeritageProcessor.md @@ -0,0 +1,20 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types') + +## HeritageProcessor Class + +```csharp +internal class HeritageProcessor : Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.AbstractEntityProcessor +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [AbstractInputProcessor](AbstractInputProcessor.md 'Pf2eDataScrapper\.Processors\.Definitions\.AbstractInputProcessor') 🡒 [AbstractEntityProcessor](AbstractEntityProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.AbstractEntityProcessor') 🡒 HeritageProcessor + +| Properties | | +| :--- | :--- | +| [Object](HeritageProcessor.Object.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.HeritageProcessor\.Object') | Основная сущность\. | +| [Type](HeritageProcessor.Type.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.HeritageProcessor\.Type') | Тип сущности\. | + +| Methods | | +| :--- | :--- | +| [Add\(\)](HeritageProcessor.Add().md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.HeritageProcessor\.Add\(\)') | Добавление основной сущности в контекст базы данных\. | +| [Process\(\)](HeritageProcessor.Process().md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.HeritageProcessor\.Process\(\)') | Основной метод обработки данных\. | diff --git a/Documentation/Pf2eDataScrapper/IEnumSolver.md b/Documentation/Pf2eDataScrapper/IEnumSolver.md new file mode 100644 index 0000000..f40c250 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/IEnumSolver.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Processors](Pf2eDataScrapper.Processors.md 'Pf2eDataScrapper\.Processors') + +## IEnumSolver Interface + +Интерфейс для решения значений перечислений\. + +```csharp +internal interface IEnumSolver +``` + +Derived +↳ [EnumSolver<TEnum>](EnumSolver_TEnum_.md 'Pf2eDataScrapper\.Processors\.EnumSolver\') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/IProcessor.Process().md b/Documentation/Pf2eDataScrapper/IProcessor.Process().md new file mode 100644 index 0000000..9e924c8 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/IProcessor.Process().md @@ -0,0 +1,10 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Processors\.Definitions](Pf2eDataScrapper.Processors.Definitions.md 'Pf2eDataScrapper\.Processors\.Definitions').[IProcessor](IProcessor.md 'Pf2eDataScrapper\.Processors\.Definitions\.IProcessor') + +## IProcessor\.Process\(\) Method + +Основной метод обработки данных\. + +```csharp +void Process(); +``` \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/IProcessor.Save().md b/Documentation/Pf2eDataScrapper/IProcessor.Save().md new file mode 100644 index 0000000..080758c --- /dev/null +++ b/Documentation/Pf2eDataScrapper/IProcessor.Save().md @@ -0,0 +1,10 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Processors\.Definitions](Pf2eDataScrapper.Processors.Definitions.md 'Pf2eDataScrapper\.Processors\.Definitions').[IProcessor](IProcessor.md 'Pf2eDataScrapper\.Processors\.Definitions\.IProcessor') + +## IProcessor\.Save\(\) Method + +Метод для сохранения изменений в базе данных\. + +```csharp +void Save(); +``` \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/IProcessor.md b/Documentation/Pf2eDataScrapper/IProcessor.md new file mode 100644 index 0000000..a86897d --- /dev/null +++ b/Documentation/Pf2eDataScrapper/IProcessor.md @@ -0,0 +1,23 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Processors\.Definitions](Pf2eDataScrapper.Processors.Definitions.md 'Pf2eDataScrapper\.Processors\.Definitions') + +## IProcessor Interface + +Интерфейс для обработчиков данных\. + +```csharp +public interface IProcessor +``` + +Derived +↳ [RulesOrderProcessor](RulesOrderProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules\.RulesOrderProcessor') +↳ [RulesTocProcessor](RulesTocProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules\.RulesTocProcessor') +↳ [CompendiumFolderProcessor](CompendiumFolderProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Processors\.Preparation\.CompendiumFolderProcessor') +↳ [AbstractInputProcessor](AbstractInputProcessor.md 'Pf2eDataScrapper\.Processors\.Definitions\.AbstractInputProcessor') +↳ [AbstractSimpleProcessor](AbstractSimpleProcessor.md 'Pf2eDataScrapper\.Processors\.Definitions\.AbstractSimpleProcessor') +↳ [AbstractSchemaBuildProcessor](AbstractSchemaBuildProcessor.md 'Pf2eDataScrapper\.SchemaBuilder\.AbstractSchemaBuildProcessor') + +| Methods | | +| :--- | :--- | +| [Process\(\)](IProcessor.Process().md 'Pf2eDataScrapper\.Processors\.Definitions\.IProcessor\.Process\(\)') | Основной метод обработки данных\. | +| [Save\(\)](IProcessor.Save().md 'Pf2eDataScrapper\.Processors\.Definitions\.IProcessor\.Save\(\)') | Метод для сохранения изменений в базе данных\. | diff --git a/Documentation/Pf2eDataScrapper/IgnoreSchemaType.AddValue(JToken).md b/Documentation/Pf2eDataScrapper/IgnoreSchemaType.AddValue(JToken).md new file mode 100644 index 0000000..cb62bf2 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/IgnoreSchemaType.AddValue(JToken).md @@ -0,0 +1,17 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder\.Types](Pf2eDataScrapper.SchemaBuilder.Types.md 'Pf2eDataScrapper\.SchemaBuilder\.Types').[IgnoreSchemaType](IgnoreSchemaType.md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.IgnoreSchemaType') + +## IgnoreSchemaType\.AddValue\(JToken\) Method + +Добавление нового значения\. + +```csharp +public override void AddValue(Newtonsoft.Json.Linq.JToken value); +``` +#### Parameters + + + +`value` [Newtonsoft\.Json\.Linq\.JToken](https://docs.microsoft.com/en-us/dotnet/api/Newtonsoft.Json.Linq.JToken 'Newtonsoft\.Json\.Linq\.JToken') + +Новое значение\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/IgnoreSchemaType.Beautify().md b/Documentation/Pf2eDataScrapper/IgnoreSchemaType.Beautify().md new file mode 100644 index 0000000..181b9c2 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/IgnoreSchemaType.Beautify().md @@ -0,0 +1,10 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder\.Types](Pf2eDataScrapper.SchemaBuilder.Types.md 'Pf2eDataScrapper\.SchemaBuilder\.Types').[IgnoreSchemaType](IgnoreSchemaType.md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.IgnoreSchemaType') + +## IgnoreSchemaType\.Beautify\(\) Method + +Подготовка типа к красивому представлению\. + +```csharp +public override void Beautify(); +``` \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/IgnoreSchemaType.GetTypeName().md b/Documentation/Pf2eDataScrapper/IgnoreSchemaType.GetTypeName().md new file mode 100644 index 0000000..c66e1fd --- /dev/null +++ b/Documentation/Pf2eDataScrapper/IgnoreSchemaType.GetTypeName().md @@ -0,0 +1,14 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder\.Types](Pf2eDataScrapper.SchemaBuilder.Types.md 'Pf2eDataScrapper\.SchemaBuilder\.Types').[IgnoreSchemaType](IgnoreSchemaType.md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.IgnoreSchemaType') + +## IgnoreSchemaType\.GetTypeName\(\) Method + +Получение строкового представоения типа элемента\. + +```csharp +public override string GetTypeName(); +``` + +#### Returns +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') +Строковое представоение типа элемента \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/IgnoreSchemaType.GetYamlData().md b/Documentation/Pf2eDataScrapper/IgnoreSchemaType.GetYamlData().md new file mode 100644 index 0000000..2d764d0 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/IgnoreSchemaType.GetYamlData().md @@ -0,0 +1,14 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder\.Types](Pf2eDataScrapper.SchemaBuilder.Types.md 'Pf2eDataScrapper\.SchemaBuilder\.Types').[IgnoreSchemaType](IgnoreSchemaType.md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.IgnoreSchemaType') + +## IgnoreSchemaType\.GetYamlData\(\) Method + +Получение данных для форматирования в YAML\. + +```csharp +public override System.Collections.Generic.Dictionary GetYamlData(); +``` + +#### Returns +[System\.Collections\.Generic\.Dictionary<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.Dictionary-2 'System\.Collections\.Generic\.Dictionary\`2')[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.Dictionary-2 'System\.Collections\.Generic\.Dictionary\`2')[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.Dictionary-2 'System\.Collections\.Generic\.Dictionary\`2') +Словарь данных \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/IgnoreSchemaType.IgnoreSchemaType(SchemaNode).md b/Documentation/Pf2eDataScrapper/IgnoreSchemaType.IgnoreSchemaType(SchemaNode).md new file mode 100644 index 0000000..10fde64 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/IgnoreSchemaType.IgnoreSchemaType(SchemaNode).md @@ -0,0 +1,17 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder\.Types](Pf2eDataScrapper.SchemaBuilder.Types.md 'Pf2eDataScrapper\.SchemaBuilder\.Types').[IgnoreSchemaType](IgnoreSchemaType.md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.IgnoreSchemaType') + +## IgnoreSchemaType\(SchemaNode\) Constructor + +Тип, указывающий, что данные игнорируются\. + +```csharp +public IgnoreSchemaType(Pf2eDataScrapper.SchemaBuilder.SchemaNode parent); +``` +#### Parameters + + + +`parent` [SchemaNode](SchemaNode.md 'Pf2eDataScrapper\.SchemaBuilder\.SchemaNode') + +Элемент, к которому добавляется тип\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/IgnoreSchemaType.IsCompatibleValue(JToken).md b/Documentation/Pf2eDataScrapper/IgnoreSchemaType.IsCompatibleValue(JToken).md new file mode 100644 index 0000000..73cfe0c --- /dev/null +++ b/Documentation/Pf2eDataScrapper/IgnoreSchemaType.IsCompatibleValue(JToken).md @@ -0,0 +1,21 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder\.Types](Pf2eDataScrapper.SchemaBuilder.Types.md 'Pf2eDataScrapper\.SchemaBuilder\.Types').[IgnoreSchemaType](IgnoreSchemaType.md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.IgnoreSchemaType') + +## IgnoreSchemaType\.IsCompatibleValue\(JToken\) Method + +Проверка, что значение совместимо с текущим типом\. + +```csharp +public override bool IsCompatibleValue(Newtonsoft.Json.Linq.JToken value); +``` +#### Parameters + + + +`value` [Newtonsoft\.Json\.Linq\.JToken](https://docs.microsoft.com/en-us/dotnet/api/Newtonsoft.Json.Linq.JToken 'Newtonsoft\.Json\.Linq\.JToken') + +Проверяемое значение\. + +#### Returns +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') +\`true\`, если значение совместимо с текущим типом\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/IgnoreSchemaType.md b/Documentation/Pf2eDataScrapper/IgnoreSchemaType.md new file mode 100644 index 0000000..e6b648a --- /dev/null +++ b/Documentation/Pf2eDataScrapper/IgnoreSchemaType.md @@ -0,0 +1,24 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder\.Types](Pf2eDataScrapper.SchemaBuilder.Types.md 'Pf2eDataScrapper\.SchemaBuilder\.Types') + +## IgnoreSchemaType Class + +Тип, указывающий, что данные игнорируются\. + +```csharp +internal class IgnoreSchemaType : Pf2eDataScrapper.SchemaBuilder.Types.AbstractSchemaType +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [AbstractSchemaType](AbstractSchemaType.md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.AbstractSchemaType') 🡒 IgnoreSchemaType + +| Constructors | | +| :--- | :--- | +| [IgnoreSchemaType\(SchemaNode\)](IgnoreSchemaType.IgnoreSchemaType(SchemaNode).md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.IgnoreSchemaType\.IgnoreSchemaType\(Pf2eDataScrapper\.SchemaBuilder\.SchemaNode\)') | Тип, указывающий, что данные игнорируются\. | + +| Methods | | +| :--- | :--- | +| [AddValue\(JToken\)](IgnoreSchemaType.AddValue(JToken).md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.IgnoreSchemaType\.AddValue\(Newtonsoft\.Json\.Linq\.JToken\)') | Добавление нового значения\. | +| [Beautify\(\)](IgnoreSchemaType.Beautify().md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.IgnoreSchemaType\.Beautify\(\)') | Подготовка типа к красивому представлению\. | +| [GetTypeName\(\)](IgnoreSchemaType.GetTypeName().md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.IgnoreSchemaType\.GetTypeName\(\)') | Получение строкового представоения типа элемента\. | +| [GetYamlData\(\)](IgnoreSchemaType.GetYamlData().md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.IgnoreSchemaType\.GetYamlData\(\)') | Получение данных для форматирования в YAML\. | +| [IsCompatibleValue\(JToken\)](IgnoreSchemaType.IsCompatibleValue(JToken).md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.IgnoreSchemaType\.IsCompatibleValue\(Newtonsoft\.Json\.Linq\.JToken\)') | Проверка, что значение совместимо с текущим типом\. | diff --git a/Documentation/Pf2eDataScrapper/ImportApplication.CurrentStage.md b/Documentation/Pf2eDataScrapper/ImportApplication.CurrentStage.md new file mode 100644 index 0000000..87b923c --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ImportApplication.CurrentStage.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper](Pf2eDataScrapper.md 'Pf2eDataScrapper').[ImportApplication](ImportApplication.md 'Pf2eDataScrapper\.ImportApplication') + +## ImportApplication\.CurrentStage Property + +Текущий этап выполнения программы\. + +```csharp +public Pf2eDataScrapper.ApplicationStage CurrentStage { get; set; } +``` + +#### Property Value +[Pf2eDataScrapper\.ApplicationStage](https://docs.microsoft.com/en-us/dotnet/api/Pf2eDataScrapper.ApplicationStage 'Pf2eDataScrapper\.ApplicationStage') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ImportApplication.md b/Documentation/Pf2eDataScrapper/ImportApplication.md new file mode 100644 index 0000000..7d3fd1e --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ImportApplication.md @@ -0,0 +1,14 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper](Pf2eDataScrapper.md 'Pf2eDataScrapper') + +## ImportApplication Class + +```csharp +internal sealed class ImportApplication : System.Windows.Application +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [System\.Windows\.Threading\.DispatcherObject](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.Threading.DispatcherObject 'System\.Windows\.Threading\.DispatcherObject') 🡒 [System\.Windows\.Application](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.Application 'System\.Windows\.Application') 🡒 ImportApplication + +| Properties | | +| :--- | :--- | +| [CurrentStage](ImportApplication.CurrentStage.md 'Pf2eDataScrapper\.ImportApplication\.CurrentStage') | Текущий этап выполнения программы\. | diff --git a/Documentation/Pf2eDataScrapper/LadderType.md b/Documentation/Pf2eDataScrapper/LadderType.md new file mode 100644 index 0000000..6bd300f --- /dev/null +++ b/Documentation/Pf2eDataScrapper/LadderType.md @@ -0,0 +1,29 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure') + +## LadderType Enum + +Тип лестницы глубины\. + +```csharp +internal enum LadderType +``` +### Fields + + + +`Empty` 0 + +Пустой элемент: \[ \]\. + + + +`Last` 1 + +Последний элемент: \[└\]\. + + + +`Through` 2 + +Проходной элемент: \[├\] или \[│\]\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/LanguageProcessor.Add().md b/Documentation/Pf2eDataScrapper/LanguageProcessor.Add().md new file mode 100644 index 0000000..6c7a98b --- /dev/null +++ b/Documentation/Pf2eDataScrapper/LanguageProcessor.Add().md @@ -0,0 +1,10 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types').[LanguageProcessor](LanguageProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.LanguageProcessor') + +## LanguageProcessor\.Add\(\) Method + +Добавление основной сущности в контекст базы данных\. + +```csharp +protected override void Add(); +``` \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/LanguageProcessor.Object.md b/Documentation/Pf2eDataScrapper/LanguageProcessor.Object.md new file mode 100644 index 0000000..329c9d3 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/LanguageProcessor.Object.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types').[LanguageProcessor](LanguageProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.LanguageProcessor') + +## LanguageProcessor\.Object Property + +Основная сущность\. + +```csharp +public virtual Pf2eModel.Model.Structure.Language Object { get; } +``` + +#### Property Value +[Pf2eModel\.Model\.Structure\.Language](https://docs.microsoft.com/en-us/dotnet/api/Pf2eModel.Model.Structure.Language 'Pf2eModel\.Model\.Structure\.Language') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/LanguageProcessor.Type.md b/Documentation/Pf2eDataScrapper/LanguageProcessor.Type.md new file mode 100644 index 0000000..d134f0f --- /dev/null +++ b/Documentation/Pf2eDataScrapper/LanguageProcessor.Type.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types').[LanguageProcessor](LanguageProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.LanguageProcessor') + +## LanguageProcessor\.Type Property + +Тип сущности\. + +```csharp +public override Pf2eModel.Model.Enum.EntityType Type { get; } +``` + +#### Property Value +[Pf2eModel\.Model\.Enum\.EntityType](https://docs.microsoft.com/en-us/dotnet/api/Pf2eModel.Model.Enum.EntityType 'Pf2eModel\.Model\.Enum\.EntityType') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/LanguageProcessor.md b/Documentation/Pf2eDataScrapper/LanguageProcessor.md new file mode 100644 index 0000000..65abbbb --- /dev/null +++ b/Documentation/Pf2eDataScrapper/LanguageProcessor.md @@ -0,0 +1,19 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types') + +## LanguageProcessor Class + +```csharp +internal class LanguageProcessor : Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.AbstractEntityProcessor +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [AbstractInputProcessor](AbstractInputProcessor.md 'Pf2eDataScrapper\.Processors\.Definitions\.AbstractInputProcessor') 🡒 [AbstractEntityProcessor](AbstractEntityProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.AbstractEntityProcessor') 🡒 LanguageProcessor + +| Properties | | +| :--- | :--- | +| [Object](LanguageProcessor.Object.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.LanguageProcessor\.Object') | Основная сущность\. | +| [Type](LanguageProcessor.Type.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.LanguageProcessor\.Type') | Тип сущности\. | + +| Methods | | +| :--- | :--- | +| [Add\(\)](LanguageProcessor.Add().md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.LanguageProcessor\.Add\(\)') | Добавление основной сущности в контекст базы данных\. | diff --git a/Documentation/Pf2eDataScrapper/LegacyItemException.LegacyItemException(string).md b/Documentation/Pf2eDataScrapper/LegacyItemException.LegacyItemException(string).md new file mode 100644 index 0000000..00478d3 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/LegacyItemException.LegacyItemException(string).md @@ -0,0 +1,17 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Processors](Pf2eDataScrapper.Processors.md 'Pf2eDataScrapper\.Processors').[LegacyItemException](LegacyItemException.md 'Pf2eDataScrapper\.Processors\.LegacyItemException') + +## LegacyItemException\(string\) Constructor + +Исключение, показывающее, что обработка сущности пропускается как устаревшая\. + +```csharp +public LegacyItemException(string name); +``` +#### Parameters + + + +`name` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +Название сущности\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/LegacyItemException.md b/Documentation/Pf2eDataScrapper/LegacyItemException.md new file mode 100644 index 0000000..18fc324 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/LegacyItemException.md @@ -0,0 +1,16 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Processors](Pf2eDataScrapper.Processors.md 'Pf2eDataScrapper\.Processors') + +## LegacyItemException Class + +Исключение, показывающее, что обработка сущности пропускается как устаревшая\. + +```csharp +public class LegacyItemException : Pf2eDataScrapper.Processors.SkipItemException +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [System\.Exception](https://docs.microsoft.com/en-us/dotnet/api/System.Exception 'System\.Exception') 🡒 [SkipItemException](SkipItemException.md 'Pf2eDataScrapper\.Processors\.SkipItemException') 🡒 LegacyItemException + +| Constructors | | +| :--- | :--- | +| [LegacyItemException\(string\)](LegacyItemException.LegacyItemException(string).md 'Pf2eDataScrapper\.Processors\.LegacyItemException\.LegacyItemException\(string\)') | Исключение, показывающее, что обработка сущности пропускается как устаревшая\. | diff --git a/Documentation/Pf2eDataScrapper/MarkdownLink.Prefix.md b/Documentation/Pf2eDataScrapper/MarkdownLink.Prefix.md new file mode 100644 index 0000000..1818a76 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/MarkdownLink.Prefix.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers](Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers').[MarkdownLink](MarkdownLink.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.MarkdownLink') + +## MarkdownLink\.Prefix Property + +Данные, содержащиеся до ссылки\. + +```csharp +public string Prefix { get; init; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/MarkdownLink.Text.md b/Documentation/Pf2eDataScrapper/MarkdownLink.Text.md new file mode 100644 index 0000000..00f4bd2 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/MarkdownLink.Text.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers](Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers').[MarkdownLink](MarkdownLink.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.MarkdownLink') + +## MarkdownLink\.Text Property + +Текст ссылки\. + +```csharp +public string Text { get; init; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/MarkdownLink.Url.md b/Documentation/Pf2eDataScrapper/MarkdownLink.Url.md new file mode 100644 index 0000000..6cd5c26 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/MarkdownLink.Url.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers](Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers').[MarkdownLink](MarkdownLink.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.MarkdownLink') + +## MarkdownLink\.Url Property + +URL ссылки\. + +```csharp +public string Url { get; init; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/MarkdownLink.md b/Documentation/Pf2eDataScrapper/MarkdownLink.md new file mode 100644 index 0000000..8675f7f --- /dev/null +++ b/Documentation/Pf2eDataScrapper/MarkdownLink.md @@ -0,0 +1,18 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers](Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers') + +## MarkdownLink Class + +Информация о ссылке в строке\. + +```csharp +internal class MarkdownLink +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 MarkdownLink + +| Properties | | +| :--- | :--- | +| [Prefix](MarkdownLink.Prefix.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.MarkdownLink\.Prefix') | Данные, содержащиеся до ссылки\. | +| [Text](MarkdownLink.Text.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.MarkdownLink\.Text') | Текст ссылки\. | +| [Url](MarkdownLink.Url.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.MarkdownLink\.Url') | URL ссылки\. | diff --git a/Documentation/Pf2eDataScrapper/MarkdownLinkSplit.Links.md b/Documentation/Pf2eDataScrapper/MarkdownLinkSplit.Links.md new file mode 100644 index 0000000..342ec01 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/MarkdownLinkSplit.Links.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers](Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers').[MarkdownLinkSplit](MarkdownLinkSplit.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.MarkdownLinkSplit') + +## MarkdownLinkSplit\.Links Property + +Список содержащихся ссылок\. + +```csharp +public System.Collections.Generic.List Links { get; } +``` + +#### Property Value +[System\.Collections\.Generic\.List<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.List-1 'System\.Collections\.Generic\.List\`1')[MarkdownLink](MarkdownLink.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.MarkdownLink')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.List-1 'System\.Collections\.Generic\.List\`1') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/MarkdownLinkSplit.Suffix.md b/Documentation/Pf2eDataScrapper/MarkdownLinkSplit.Suffix.md new file mode 100644 index 0000000..ec6c43d --- /dev/null +++ b/Documentation/Pf2eDataScrapper/MarkdownLinkSplit.Suffix.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers](Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers').[MarkdownLinkSplit](MarkdownLinkSplit.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.MarkdownLinkSplit') + +## MarkdownLinkSplit\.Suffix Property + +Завершающая часть ссылки\. + +```csharp +public string Suffix { get; set; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/MarkdownLinkSplit.md b/Documentation/Pf2eDataScrapper/MarkdownLinkSplit.md new file mode 100644 index 0000000..cc95dfe --- /dev/null +++ b/Documentation/Pf2eDataScrapper/MarkdownLinkSplit.md @@ -0,0 +1,17 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers](Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers') + +## MarkdownLinkSplit Class + +Класс структуры, содеражащая информацию разбиении строки по ссылкам\. + +```csharp +internal class MarkdownLinkSplit +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 MarkdownLinkSplit + +| Properties | | +| :--- | :--- | +| [Links](MarkdownLinkSplit.Links.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.MarkdownLinkSplit\.Links') | Список содержащихся ссылок\. | +| [Suffix](MarkdownLinkSplit.Suffix.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.MarkdownLinkSplit\.Suffix') | Завершающая часть ссылки\. | diff --git a/Documentation/Pf2eDataScrapper/ObjectSchemaType.AddValue(JToken).md b/Documentation/Pf2eDataScrapper/ObjectSchemaType.AddValue(JToken).md new file mode 100644 index 0000000..3ccb592 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ObjectSchemaType.AddValue(JToken).md @@ -0,0 +1,17 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder\.Types](Pf2eDataScrapper.SchemaBuilder.Types.md 'Pf2eDataScrapper\.SchemaBuilder\.Types').[ObjectSchemaType](ObjectSchemaType.md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.ObjectSchemaType') + +## ObjectSchemaType\.AddValue\(JToken\) Method + +Добавление нового значения\. + +```csharp +public override void AddValue(Newtonsoft.Json.Linq.JToken value); +``` +#### Parameters + + + +`value` [Newtonsoft\.Json\.Linq\.JToken](https://docs.microsoft.com/en-us/dotnet/api/Newtonsoft.Json.Linq.JToken 'Newtonsoft\.Json\.Linq\.JToken') + +Новое значение\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ObjectSchemaType.Beautify().md b/Documentation/Pf2eDataScrapper/ObjectSchemaType.Beautify().md new file mode 100644 index 0000000..13da4b9 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ObjectSchemaType.Beautify().md @@ -0,0 +1,10 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder\.Types](Pf2eDataScrapper.SchemaBuilder.Types.md 'Pf2eDataScrapper\.SchemaBuilder\.Types').[ObjectSchemaType](ObjectSchemaType.md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.ObjectSchemaType') + +## ObjectSchemaType\.Beautify\(\) Method + +Подготовка типа к красивому представлению\. + +```csharp +public override void Beautify(); +``` \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ObjectSchemaType.Fields.md b/Documentation/Pf2eDataScrapper/ObjectSchemaType.Fields.md new file mode 100644 index 0000000..9e6d2b9 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ObjectSchemaType.Fields.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder\.Types](Pf2eDataScrapper.SchemaBuilder.Types.md 'Pf2eDataScrapper\.SchemaBuilder\.Types').[ObjectSchemaType](ObjectSchemaType.md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.ObjectSchemaType') + +## ObjectSchemaType\.Fields Field + +Элемнты полей объекта\. + +```csharp +public readonly List Fields; +``` + +#### Field Value +[System\.Collections\.Generic\.List<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.List-1 'System\.Collections\.Generic\.List\`1')[SchemaNode](SchemaNode.md 'Pf2eDataScrapper\.SchemaBuilder\.SchemaNode')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.List-1 'System\.Collections\.Generic\.List\`1') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ObjectSchemaType.GetSchemaYaml().md b/Documentation/Pf2eDataScrapper/ObjectSchemaType.GetSchemaYaml().md new file mode 100644 index 0000000..adfa8fb --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ObjectSchemaType.GetSchemaYaml().md @@ -0,0 +1,14 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder\.Types](Pf2eDataScrapper.SchemaBuilder.Types.md 'Pf2eDataScrapper\.SchemaBuilder\.Types').[ObjectSchemaType](ObjectSchemaType.md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.ObjectSchemaType') + +## ObjectSchemaType\.GetSchemaYaml\(\) Method + +Получение данных для форматирования структуры в YAML\. + +```csharp +public System.Collections.Generic.Dictionary GetSchemaYaml(); +``` + +#### Returns +[System\.Collections\.Generic\.Dictionary<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.Dictionary-2 'System\.Collections\.Generic\.Dictionary\`2')[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.Dictionary-2 'System\.Collections\.Generic\.Dictionary\`2')[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.Dictionary-2 'System\.Collections\.Generic\.Dictionary\`2') +Словарь данных \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ObjectSchemaType.GetTypeName().md b/Documentation/Pf2eDataScrapper/ObjectSchemaType.GetTypeName().md new file mode 100644 index 0000000..679ce64 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ObjectSchemaType.GetTypeName().md @@ -0,0 +1,14 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder\.Types](Pf2eDataScrapper.SchemaBuilder.Types.md 'Pf2eDataScrapper\.SchemaBuilder\.Types').[ObjectSchemaType](ObjectSchemaType.md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.ObjectSchemaType') + +## ObjectSchemaType\.GetTypeName\(\) Method + +Получение строкового представоения типа элемента\. + +```csharp +public override string GetTypeName(); +``` + +#### Returns +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') +Строковое представоение типа элемента \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ObjectSchemaType.GetYamlData().md b/Documentation/Pf2eDataScrapper/ObjectSchemaType.GetYamlData().md new file mode 100644 index 0000000..0df5ba2 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ObjectSchemaType.GetYamlData().md @@ -0,0 +1,14 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder\.Types](Pf2eDataScrapper.SchemaBuilder.Types.md 'Pf2eDataScrapper\.SchemaBuilder\.Types').[ObjectSchemaType](ObjectSchemaType.md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.ObjectSchemaType') + +## ObjectSchemaType\.GetYamlData\(\) Method + +Получение данных для форматирования в YAML\. + +```csharp +public override System.Collections.Generic.Dictionary GetYamlData(); +``` + +#### Returns +[System\.Collections\.Generic\.Dictionary<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.Dictionary-2 'System\.Collections\.Generic\.Dictionary\`2')[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.Dictionary-2 'System\.Collections\.Generic\.Dictionary\`2')[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.Dictionary-2 'System\.Collections\.Generic\.Dictionary\`2') +Словарь данных \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ObjectSchemaType.IsCompatibleValue(JToken).md b/Documentation/Pf2eDataScrapper/ObjectSchemaType.IsCompatibleValue(JToken).md new file mode 100644 index 0000000..69cba4d --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ObjectSchemaType.IsCompatibleValue(JToken).md @@ -0,0 +1,21 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder\.Types](Pf2eDataScrapper.SchemaBuilder.Types.md 'Pf2eDataScrapper\.SchemaBuilder\.Types').[ObjectSchemaType](ObjectSchemaType.md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.ObjectSchemaType') + +## ObjectSchemaType\.IsCompatibleValue\(JToken\) Method + +Проверка, что значение совместимо с текущим типом\. + +```csharp +public override bool IsCompatibleValue(Newtonsoft.Json.Linq.JToken value); +``` +#### Parameters + + + +`value` [Newtonsoft\.Json\.Linq\.JToken](https://docs.microsoft.com/en-us/dotnet/api/Newtonsoft.Json.Linq.JToken 'Newtonsoft\.Json\.Linq\.JToken') + +Проверяемое значение\. + +#### Returns +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') +\`true\`, если значение совместимо с текущим типом\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ObjectSchemaType.ObjectSchemaType(SchemaNode).md b/Documentation/Pf2eDataScrapper/ObjectSchemaType.ObjectSchemaType(SchemaNode).md new file mode 100644 index 0000000..a2f9e0c --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ObjectSchemaType.ObjectSchemaType(SchemaNode).md @@ -0,0 +1,17 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder\.Types](Pf2eDataScrapper.SchemaBuilder.Types.md 'Pf2eDataScrapper\.SchemaBuilder\.Types').[ObjectSchemaType](ObjectSchemaType.md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.ObjectSchemaType') + +## ObjectSchemaType\(SchemaNode\) Constructor + +Тип представоления объектов в схеме\. + +```csharp +public ObjectSchemaType(Pf2eDataScrapper.SchemaBuilder.SchemaNode parent); +``` +#### Parameters + + + +`parent` [SchemaNode](SchemaNode.md 'Pf2eDataScrapper\.SchemaBuilder\.SchemaNode') + +Элемент, к которому добавляется тип\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ObjectSchemaType.md b/Documentation/Pf2eDataScrapper/ObjectSchemaType.md new file mode 100644 index 0000000..7550314 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ObjectSchemaType.md @@ -0,0 +1,29 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder\.Types](Pf2eDataScrapper.SchemaBuilder.Types.md 'Pf2eDataScrapper\.SchemaBuilder\.Types') + +## ObjectSchemaType Class + +Тип представоления объектов в схеме\. + +```csharp +internal class ObjectSchemaType : Pf2eDataScrapper.SchemaBuilder.Types.AbstractSchemaType +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [AbstractSchemaType](AbstractSchemaType.md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.AbstractSchemaType') 🡒 ObjectSchemaType + +| Constructors | | +| :--- | :--- | +| [ObjectSchemaType\(SchemaNode\)](ObjectSchemaType.ObjectSchemaType(SchemaNode).md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.ObjectSchemaType\.ObjectSchemaType\(Pf2eDataScrapper\.SchemaBuilder\.SchemaNode\)') | Тип представоления объектов в схеме\. | + +| Fields | | +| :--- | :--- | +| [Fields](ObjectSchemaType.Fields.md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.ObjectSchemaType\.Fields') | Элемнты полей объекта\. | + +| Methods | | +| :--- | :--- | +| [AddValue\(JToken\)](ObjectSchemaType.AddValue(JToken).md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.ObjectSchemaType\.AddValue\(Newtonsoft\.Json\.Linq\.JToken\)') | Добавление нового значения\. | +| [Beautify\(\)](ObjectSchemaType.Beautify().md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.ObjectSchemaType\.Beautify\(\)') | Подготовка типа к красивому представлению\. | +| [GetSchemaYaml\(\)](ObjectSchemaType.GetSchemaYaml().md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.ObjectSchemaType\.GetSchemaYaml\(\)') | Получение данных для форматирования структуры в YAML\. | +| [GetTypeName\(\)](ObjectSchemaType.GetTypeName().md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.ObjectSchemaType\.GetTypeName\(\)') | Получение строкового представоения типа элемента\. | +| [GetYamlData\(\)](ObjectSchemaType.GetYamlData().md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.ObjectSchemaType\.GetYamlData\(\)') | Получение данных для форматирования в YAML\. | +| [IsCompatibleValue\(JToken\)](ObjectSchemaType.IsCompatibleValue(JToken).md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.ObjectSchemaType\.IsCompatibleValue\(Newtonsoft\.Json\.Linq\.JToken\)') | Проверка, что значение совместимо с текущим типом\. | diff --git a/Documentation/Pf2eDataScrapper/PageNavigationCommand.Action.md b/Documentation/Pf2eDataScrapper/PageNavigationCommand.Action.md new file mode 100644 index 0000000..818d5ef --- /dev/null +++ b/Documentation/Pf2eDataScrapper/PageNavigationCommand.Action.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.ViewModel](Pf2eDataScrapper.WPF.EntityViewer.ViewModel.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.ViewModel').[PageNavigationCommand](PageNavigationCommand.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.ViewModel\.PageNavigationCommand') + +## PageNavigationCommand\.Action Property + +Действие, выполняемое при выполнении команды\. + +```csharp +public System.Action Action { get; } +``` + +#### Property Value +[System\.Action](https://docs.microsoft.com/en-us/dotnet/api/System.Action 'System\.Action') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/PageNavigationCommand.CanExecute(object).md b/Documentation/Pf2eDataScrapper/PageNavigationCommand.CanExecute(object).md new file mode 100644 index 0000000..5a0d3c3 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/PageNavigationCommand.CanExecute(object).md @@ -0,0 +1,23 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.ViewModel](Pf2eDataScrapper.WPF.EntityViewer.ViewModel.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.ViewModel').[PageNavigationCommand](PageNavigationCommand.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.ViewModel\.PageNavigationCommand') + +## PageNavigationCommand\.CanExecute\(object\) Method + +Проверяет, может ли команда быть выполнена с указанным параметром\. + +```csharp +public bool CanExecute(object? parameter); +``` +#### Parameters + + + +`parameter` [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') + +Параметр команды\. + +Implements [CanExecute\(object\)](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.Input.ICommand.CanExecute#System_Windows_Input_ICommand_CanExecute_System_Object_ 'System\.Windows\.Input\.ICommand\.CanExecute\(System\.Object\)') + +#### Returns +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') +Флаг, указывающий, может ли команда быть выполнена\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/PageNavigationCommand.CanExecuteChanged.md b/Documentation/Pf2eDataScrapper/PageNavigationCommand.CanExecuteChanged.md new file mode 100644 index 0000000..b181c54 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/PageNavigationCommand.CanExecuteChanged.md @@ -0,0 +1,15 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.ViewModel](Pf2eDataScrapper.WPF.EntityViewer.ViewModel.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.ViewModel').[PageNavigationCommand](PageNavigationCommand.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.ViewModel\.PageNavigationCommand') + +## PageNavigationCommand\.CanExecuteChanged Event + +Событие, вызываемое при изменении возможности выполнения команды\. + +```csharp +public event EventHandler? CanExecuteChanged; +``` + +Implements [CanExecuteChanged](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.Input.ICommand.CanExecuteChanged 'System\.Windows\.Input\.ICommand\.CanExecuteChanged') + +#### Event Type +[System\.EventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.EventHandler 'System\.EventHandler') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/PageNavigationCommand.Execute(object).md b/Documentation/Pf2eDataScrapper/PageNavigationCommand.Execute(object).md new file mode 100644 index 0000000..9893ee6 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/PageNavigationCommand.Execute(object).md @@ -0,0 +1,19 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.ViewModel](Pf2eDataScrapper.WPF.EntityViewer.ViewModel.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.ViewModel').[PageNavigationCommand](PageNavigationCommand.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.ViewModel\.PageNavigationCommand') + +## PageNavigationCommand\.Execute\(object\) Method + +Выполняет команду с указанным параметром\. + +```csharp +public void Execute(object? parameter); +``` +#### Parameters + + + +`parameter` [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') + +Параметр команды\. + +Implements [Execute\(object\)](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.Input.ICommand.Execute#System_Windows_Input_ICommand_Execute_System_Object_ 'System\.Windows\.Input\.ICommand\.Execute\(System\.Object\)') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/PageNavigationCommand.PageNavigationCommand(Action).md b/Documentation/Pf2eDataScrapper/PageNavigationCommand.PageNavigationCommand(Action).md new file mode 100644 index 0000000..1f86cf2 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/PageNavigationCommand.PageNavigationCommand(Action).md @@ -0,0 +1,17 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.ViewModel](Pf2eDataScrapper.WPF.EntityViewer.ViewModel.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.ViewModel').[PageNavigationCommand](PageNavigationCommand.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.ViewModel\.PageNavigationCommand') + +## PageNavigationCommand\(Action\) Constructor + +Команда для навигации по страницам\. + +```csharp +public PageNavigationCommand(System.Action action); +``` +#### Parameters + + + +`action` [System\.Action](https://docs.microsoft.com/en-us/dotnet/api/System.Action 'System\.Action') + +Действие, выполняемое при выполнении команды\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/PageNavigationCommand.md b/Documentation/Pf2eDataScrapper/PageNavigationCommand.md new file mode 100644 index 0000000..9306844 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/PageNavigationCommand.md @@ -0,0 +1,31 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.ViewModel](Pf2eDataScrapper.WPF.EntityViewer.ViewModel.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.ViewModel') + +## PageNavigationCommand Class + +Команда для навигации по страницам\. + +```csharp +public class PageNavigationCommand : System.Windows.Input.ICommand +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 PageNavigationCommand + +Implements [System\.Windows\.Input\.ICommand](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.Input.ICommand 'System\.Windows\.Input\.ICommand') + +| Constructors | | +| :--- | :--- | +| [PageNavigationCommand\(Action\)](PageNavigationCommand.PageNavigationCommand(Action).md 'Pf2eDataScrapper\.WPF\.EntityViewer\.ViewModel\.PageNavigationCommand\.PageNavigationCommand\(System\.Action\)') | Команда для навигации по страницам\. | + +| Properties | | +| :--- | :--- | +| [Action](PageNavigationCommand.Action.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.ViewModel\.PageNavigationCommand\.Action') | Действие, выполняемое при выполнении команды\. | + +| Methods | | +| :--- | :--- | +| [CanExecute\(object\)](PageNavigationCommand.CanExecute(object).md 'Pf2eDataScrapper\.WPF\.EntityViewer\.ViewModel\.PageNavigationCommand\.CanExecute\(object\)') | Проверяет, может ли команда быть выполнена с указанным параметром\. | +| [Execute\(object\)](PageNavigationCommand.Execute(object).md 'Pf2eDataScrapper\.WPF\.EntityViewer\.ViewModel\.PageNavigationCommand\.Execute\(object\)') | Выполняет команду с указанным параметром\. | + +| Events | | +| :--- | :--- | +| [CanExecuteChanged](PageNavigationCommand.CanExecuteChanged.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.ViewModel\.PageNavigationCommand\.CanExecuteChanged') | Событие, вызываемое при изменении возможности выполнения команды\. | diff --git a/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.Helpers.md b/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.Helpers.md new file mode 100644 index 0000000..cf14dfd --- /dev/null +++ b/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.Helpers.md @@ -0,0 +1,18 @@ +#### [Pf2eDataScrapper](index.md 'index') + +## Pf2eDataScrapper\.Helpers Namespace + +Классы\-помощники, используемые во всех частях проекта\. + +| Classes | | +| :--- | :--- | +| [DatabaseHelper](DatabaseHelper.md 'Pf2eDataScrapper\.Helpers\.DatabaseHelper') | Класс предоставляет методы для работы с базой данных\. | +| [EntityView](EntityView.md 'Pf2eDataScrapper\.Helpers\.EntityView') | Класс, обрабатывающий запросы к сущностям и подключающий необходимые данные\. | +| [EntityView\.Getter](EntityView.Getter.md 'Pf2eDataScrapper\.Helpers\.EntityView\.Getter') | Абстрактный класс, который определяет метод получения сущности из базы данных\. | +| [EntityView\.Getter<T>](EntityView.Getter_T_.md 'Pf2eDataScrapper\.Helpers\.EntityView\.Getter\') | Класс, определяющий метод получения сущности из базы данных\. | +| [ProcessProgress](ProcessProgress.md 'Pf2eDataScrapper\.Helpers\.ProcessProgress') | | +| [ProcessProgress\.ProgressItem](ProcessProgress.ProgressItem.md 'Pf2eDataScrapper\.Helpers\.ProcessProgress\.ProgressItem') | Класс прогресса\. | + +| Delegates | | +| :--- | :--- | +| [ProcessProgress\.ProgressItem\.UpdateDelegate\(\)](ProcessProgress.ProgressItem.UpdateDelegate().md 'Pf2eDataScrapper\.Helpers\.ProcessProgress\.ProgressItem\.UpdateDelegate\(\)') | Делегат события обновления\. | diff --git a/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.Importers.Implementations.Aonprd.Compendium.md b/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.Importers.Implementations.Aonprd.Compendium.md new file mode 100644 index 0000000..9d5a83c --- /dev/null +++ b/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.Importers.Implementations.Aonprd.Compendium.md @@ -0,0 +1,10 @@ +#### [Pf2eDataScrapper](index.md 'index') + +## Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Compendium Namespace + +Компендиум данных из сайта [Archives of Nethys Pathfinder 2e](https://aonprd.com/ 'https://aonprd\.com/')\. + +| Classes | | +| :--- | :--- | +| [AonprdCompendium](AonprdCompendium.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Compendium\.AonprdCompendium') | Класс хранения данных компендиума\. | +| [AonprdCompendiumItem](AonprdCompendiumItem.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Compendium\.AonprdCompendiumItem') | Ссылка на сущность с указанием файла, в котором она хранится\. | diff --git a/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.md b/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.md new file mode 100644 index 0000000..2dfd27b --- /dev/null +++ b/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.md @@ -0,0 +1,17 @@ +#### [Pf2eDataScrapper](index.md 'index') + +## Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers Namespace + +Класс\-помощники, которые используются в импортере данных из сайта [Archives of Nethys Pathfinder 2e](https://aonprd.com/ 'https://aonprd\.com/')\. + +| Classes | | +| :--- | :--- | +| [AonprdBuilderGlobals](AonprdBuilderGlobals.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.AonprdBuilderGlobals') | Класс\-помощник, хранящий необходимые глобальные данные\. | +| [AonprdProcessorInputExtension](AonprdProcessorInputExtension.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.AonprdProcessorInputExtension') | | +| [AonprdProcessorInputExtension\.ActionStruct](AonprdProcessorInputExtension.ActionStruct.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.AonprdProcessorInputExtension\.ActionStruct') | Класс структуры, хранящей информацию о количетсве действий\. | +| [MarkdownLink](MarkdownLink.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.MarkdownLink') | Информация о ссылке в строке\. | +| [MarkdownLinkSplit](MarkdownLinkSplit.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.MarkdownLinkSplit') | Класс структуры, содеражащая информацию разбиении строки по ссылкам\. | +| [RuleTocBook](RuleTocBook.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocBook') | Класс представляет собой книгу, содержащую правила\. | +| [RuleTocCollection](RuleTocCollection.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocCollection') | Класс коллекции книг, содержащих правила\. Реализует шаблон `Singleton`\. | +| [RuleTocItem](RuleTocItem.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocItem') | Класс представляет собой элемент дерева правил\. | +| [StringHelper](StringHelper.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.StringHelper') | Класс\-помощник, для обработки строкового ввода с Архивов Нефиса\. Реализует шаблон `Singleton`\. | diff --git a/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Preparation.md b/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Preparation.md new file mode 100644 index 0000000..cbb063f --- /dev/null +++ b/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Preparation.md @@ -0,0 +1,12 @@ +#### [Pf2eDataScrapper](index.md 'index') + +## Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Preparation Namespace + +Обработчики для подготовки данных [Archives of Nethys Pathfinder 2e](https://aonprd.com/ 'https://aonprd\.com/')\. + +| Classes | | +| :--- | :--- | +| [AonprdTypeResolver](AonprdTypeResolver.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Preparation\.AonprdTypeResolver') | Класс для определения типа поля в схеме данных\. | +| [SchemaBuildProcessor](SchemaBuildProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Preparation\.SchemaBuildProcessor') | | +| [SkillProcessor](SkillProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Preparation\.SkillProcessor') | | +| [SourceProcessor](SourceProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Preparation\.SourceProcessor') | | diff --git a/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Subclasses.md b/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Subclasses.md new file mode 100644 index 0000000..65032f6 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Subclasses.md @@ -0,0 +1,9 @@ +#### [Pf2eDataScrapper](index.md 'index') + +## Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Subclasses Namespace + +Обработчики подклассов с сайта [Archives of Nethys Pathfinder 2e](https://aonprd.com/ 'https://aonprd\.com/')\. + +| Classes | | +| :--- | :--- | +| [ApparitionProcessor](ApparitionProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Subclasses\.ApparitionProcessor') | | diff --git a/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.Rules.md b/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.Rules.md new file mode 100644 index 0000000..0a3be4c --- /dev/null +++ b/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.Rules.md @@ -0,0 +1,12 @@ +#### [Pf2eDataScrapper](index.md 'index') + +## Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules Namespace + +Обработчики правил с сайта [Archives of Nethys Pathfinder 2e](https://aonprd.com/ 'https://aonprd\.com/')\. + +| Classes | | +| :--- | :--- | +| [RuleProcessor](RuleProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules\.RuleProcessor') | | +| [RulesOrderProcessor](RulesOrderProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules\.RulesOrderProcessor') | | +| [RulesOrderProcessor\.OrderItem](RulesOrderProcessor.OrderItem.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules\.RulesOrderProcessor\.OrderItem') | Запись, указывающая порядок правила в своей главе\. | +| [RulesTocProcessor](RulesTocProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules\.RulesTocProcessor') | | diff --git a/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md b/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md new file mode 100644 index 0000000..03f2a85 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md @@ -0,0 +1,21 @@ +#### [Pf2eDataScrapper](index.md 'index') + +## Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types Namespace + +Обработчики основных сущностей с сайта [Archives of Nethys Pathfinder 2e](https://aonprd.com/ 'https://aonprd\.com/')\. + +| Classes | | +| :--- | :--- | +| [ActionProcessor](ActionProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.ActionProcessor') | | +| [AncestryProcessor](AncestryProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.AncestryProcessor') | | +| [ArchetypeProcessor](ArchetypeProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.ArchetypeProcessor') | | +| [BackgroundProcessor](BackgroundProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.BackgroundProcessor') | | +| [ClassProcessor](ClassProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.ClassProcessor') | | +| [FeatProcessor](FeatProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.FeatProcessor') | | +| [HeritageProcessor](HeritageProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.HeritageProcessor') | | +| [LanguageProcessor](LanguageProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.LanguageProcessor') | | +| [RitualProcessor](RitualProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.RitualProcessor') | | +| [SkillActionsProcessor](SkillActionsProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.SkillActionsProcessor') | | +| [SpellProcessor](SpellProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.SpellProcessor') | | +| [TraitProcessor](TraitProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.TraitProcessor') | | +| [VersitileHeritageProcessor](VersitileHeritageProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.VersitileHeritageProcessor') | | diff --git a/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.md b/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.md new file mode 100644 index 0000000..d8d685d --- /dev/null +++ b/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.md @@ -0,0 +1,10 @@ +#### [Pf2eDataScrapper](index.md 'index') + +## Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors Namespace + +Обработчики данных из сайта [Archives of Nethys Pathfinder 2e](https://aonprd.com/ 'https://aonprd\.com/')\. + +| Classes | | +| :--- | :--- | +| [AbstractEntityProcessor](AbstractEntityProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.AbstractEntityProcessor') | Абстрактный класс\-обработчик сущностей, полученных из Архивов Нефиса\. Класс предназначен для обработки данных с помощью различных обработчиков, для которых указан атрибут [ProcessorAttribute](ProcessorAttribute.md 'Pf2eDataScrapper\.Processors\.Attributes\.ProcessorAttribute')\. | +| [AbstractSubclassProcessor](AbstractSubclassProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.AbstractSubclassProcessor') | Абстрактный класс\-обработчик сущностей подклассов, полученных из Архивов Нефиса\. Класс предназначен для обработки данных с помощью различных обработчиков, для которых указан атрибут [ProcessorAttribute](ProcessorAttribute.md 'Pf2eDataScrapper\.Processors\.Attributes\.ProcessorAttribute')\. | diff --git a/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.Importers.Implementations.Aonprd.md b/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.Importers.Implementations.Aonprd.md new file mode 100644 index 0000000..ae9a2b0 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.Importers.Implementations.Aonprd.md @@ -0,0 +1,10 @@ +#### [Pf2eDataScrapper](index.md 'index') + +## Pf2eDataScrapper\.Importers\.Implementations\.Aonprd Namespace + +Импортёр данных из сайта [Archives of Nethys Pathfinder 2e](https://aonprd.com/ 'https://aonprd\.com/')\. + +| Classes | | +| :--- | :--- | +| [AonprdImporter](AonprdImporter.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.AonprdImporter') | Класс обработки данных с сайта Архивов Нефеса\. | +| [AonprdRepository](AonprdRepository.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.AonprdRepository') | Основной класс для работы с репозиторием данных Aonprd\. | diff --git a/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.Importers.Implementations.FoundryEn.Compendium.md b/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.Importers.Implementations.FoundryEn.Compendium.md new file mode 100644 index 0000000..715689d --- /dev/null +++ b/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.Importers.Implementations.FoundryEn.Compendium.md @@ -0,0 +1,16 @@ +#### [Pf2eDataScrapper](index.md 'index') + +## Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium Namespace + +Компендиум данных из модуля [pf2e](https://github.com/foundryvtt/pf2e 'https://github\.com/foundryvtt/pf2e') для FoundryVTT\. + +| Classes | | +| :--- | :--- | +| [CompendiumFolder](CompendiumFolder.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium\.CompendiumFolder') | Папка компендиума\. | +| [CompendiumFolderCollection](CompendiumFolderCollection.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium\.CompendiumFolderCollection') | Коллекция папок компендиума | +| [FoundryEnCompendium](FoundryEnCompendium.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium\.FoundryEnCompendium') | Загрузчик данных компендиума\. | +| [FoundryEnCompendiumItem](FoundryEnCompendiumItem.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium\.FoundryEnCompendiumItem') | Ссылка на сущность с указанием файла, в котором она хранится\. | + +| Enums | | +| :--- | :--- | +| [CompendiumDocumentType](CompendiumDocumentType.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium\.CompendiumDocumentType') | Тип документов компендиума\. | diff --git a/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.Importers.Implementations.FoundryEn.Processors.Preparation.md b/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.Importers.Implementations.FoundryEn.Processors.Preparation.md new file mode 100644 index 0000000..bb2cc59 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.Importers.Implementations.FoundryEn.Processors.Preparation.md @@ -0,0 +1,11 @@ +#### [Pf2eDataScrapper](index.md 'index') + +## Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Processors\.Preparation Namespace + +Обработчики для подготовки данных из модуля [pf2e](https://github.com/foundryvtt/pf2e 'https://github\.com/foundryvtt/pf2e') для FoundryVTT\. + +| Classes | | +| :--- | :--- | +| [CompendiumFolderProcessor](CompendiumFolderProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Processors\.Preparation\.CompendiumFolderProcessor') | | +| [SchemaBuildProcessor](SchemaBuildProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Processors\.Preparation\.SchemaBuildProcessor') | | +| [SchemaTypeResolver](SchemaTypeResolver.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Processors\.Preparation\.SchemaTypeResolver') | | diff --git a/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.Importers.Implementations.FoundryEn.md b/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.Importers.Implementations.FoundryEn.md new file mode 100644 index 0000000..0f24784 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.Importers.Implementations.FoundryEn.md @@ -0,0 +1,10 @@ +#### [Pf2eDataScrapper](index.md 'index') + +## Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn Namespace + +Импортёр данных из модуля [pf2e](https://github.com/foundryvtt/pf2e 'https://github\.com/foundryvtt/pf2e') для FoundryVTT\. + +| Classes | | +| :--- | :--- | +| [FoundryEnImporter](FoundryEnImporter.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.FoundryEnImporter') | Импортёр для модуля Pf2e FoundryVTT\. | +| [FoundryEnRepository](FoundryEnRepository.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.FoundryEnRepository') | Git\-репозиторий данных FoundryVTT\-модуля "pf2e"\. | diff --git a/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.Importers.Repositories.md b/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.Importers.Repositories.md new file mode 100644 index 0000000..e605d7a --- /dev/null +++ b/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.Importers.Repositories.md @@ -0,0 +1,10 @@ +#### [Pf2eDataScrapper](index.md 'index') + +## Pf2eDataScrapper\.Importers\.Repositories Namespace + +Общее описание репозиториев для хранения данных, которые используются в импортёрах и процессорах\. + +| Classes | | +| :--- | :--- | +| [AbstractImporterRepository](AbstractImporterRepository.md 'Pf2eDataScrapper\.Importers\.Repositories\.AbstractImporterRepository') | Класс абстрактного репозитория\. | +| [GitRepository](GitRepository.md 'Pf2eDataScrapper\.Importers\.Repositories\.GitRepository') | Репозиторий, загружающий данные из GIT\-источника\. | diff --git a/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.Importers.md b/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.Importers.md new file mode 100644 index 0000000..2f4ecc0 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.Importers.md @@ -0,0 +1,11 @@ +#### [Pf2eDataScrapper](index.md 'index') + +## Pf2eDataScrapper\.Importers Namespace + +Описание импортёров, которые определяют наборы обработчиков данных и элементов, необходимых для их работы\. + +| Classes | | +| :--- | :--- | +| [AbstractCompendium](AbstractCompendium.md 'Pf2eDataScrapper\.Importers\.AbstractCompendium') | Компендиум данных\. | +| [AbstractCompendiumItem](AbstractCompendiumItem.md 'Pf2eDataScrapper\.Importers\.AbstractCompendiumItem') | Абстрактная ссылка на сущность\. | +| [AbstractImporter](AbstractImporter.md 'Pf2eDataScrapper\.Importers\.AbstractImporter') | Абстрактный класс импортёра\. | diff --git a/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.Processors.Attributes.md b/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.Processors.Attributes.md new file mode 100644 index 0000000..5991609 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.Processors.Attributes.md @@ -0,0 +1,20 @@ +#### [Pf2eDataScrapper](index.md 'index') + +## Pf2eDataScrapper\.Processors\.Attributes Namespace + +Классы\-аттрибуты, которые используются для описания обработчиков данных и их свойств\. + +| Classes | | +| :--- | :--- | +| [AbstractProcessorAttribute](AbstractProcessorAttribute.md 'Pf2eDataScrapper\.Processors\.Attributes\.AbstractProcessorAttribute') | Абстрактный аттрибут обработчика\. | +| [ProcessorAttribute](ProcessorAttribute.md 'Pf2eDataScrapper\.Processors\.Attributes\.ProcessorAttribute') | Общий аттрибут обработчика\. | +| [ProcessorCollectionAttribute](ProcessorCollectionAttribute.md 'Pf2eDataScrapper\.Processors\.Attributes\.ProcessorCollectionAttribute') | Аттрибут обработчика набор элементов\. | +| [ProcessorDependenciesAttribute](ProcessorDependenciesAttribute.md 'Pf2eDataScrapper\.Processors\.Attributes\.ProcessorDependenciesAttribute') | Аттрибут зависимостей обработчика\. | +| [ProcessorFactoryAttribute](ProcessorFactoryAttribute.md 'Pf2eDataScrapper\.Processors\.Attributes\.ProcessorFactoryAttribute') | | +| [ProcessorGroupEnumExtension](ProcessorGroupEnumExtension.md 'Pf2eDataScrapper\.Processors\.Attributes\.ProcessorGroupEnumExtension') | Расширение для перечисления [ProcessorGroupEnum](ProcessorGroupEnum.md 'Pf2eDataScrapper\.Processors\.Attributes\.ProcessorGroupEnum')\. | + +| Enums | | +| :--- | :--- | +| [ProcessorCompendiumEnum](ProcessorCompendiumEnum.md 'Pf2eDataScrapper\.Processors\.Attributes\.ProcessorCompendiumEnum') | Перечисление для типов компендиумов обработчиков\. | +| [ProcessorFactoryTypeEnum](ProcessorFactoryTypeEnum.md 'Pf2eDataScrapper\.Processors\.Attributes\.ProcessorFactoryTypeEnum') | Перечисление для типов фабрик обработчиков\. | +| [ProcessorGroupEnum](ProcessorGroupEnum.md 'Pf2eDataScrapper\.Processors\.Attributes\.ProcessorGroupEnum') | Перечисление для групп обработчиков\. | diff --git a/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.Processors.Collection.md b/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.Processors.Collection.md new file mode 100644 index 0000000..de9601d --- /dev/null +++ b/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.Processors.Collection.md @@ -0,0 +1,10 @@ +#### [Pf2eDataScrapper](index.md 'index') + +## Pf2eDataScrapper\.Processors\.Collection Namespace + +Описание коллекции классов обработчиков данных\. + +| Classes | | +| :--- | :--- | +| [ProcessorCollection](ProcessorCollection.md 'Pf2eDataScrapper\.Processors\.Collection\.ProcessorCollection') | Класс с коллекцией обработчиков\. | +| [ProcessorRecord](ProcessorRecord.md 'Pf2eDataScrapper\.Processors\.Collection\.ProcessorRecord') | Элемент коллекции обработчиков\. | diff --git a/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.Processors.Definitions.md b/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.Processors.Definitions.md new file mode 100644 index 0000000..5616cdc --- /dev/null +++ b/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.Processors.Definitions.md @@ -0,0 +1,14 @@ +#### [Pf2eDataScrapper](index.md 'index') + +## Pf2eDataScrapper\.Processors\.Definitions Namespace + +Общее описание классов и интерфейсов, которые используются в обработчиках данных\. + +| Classes | | +| :--- | :--- | +| [AbstractInputProcessor](AbstractInputProcessor.md 'Pf2eDataScrapper\.Processors\.Definitions\.AbstractInputProcessor') | Абстрактный класс\-обработчик данных, полученных из Архивов Нефиса\. Класс предназначен для обработки данных с помощью различных обработчиков, для которых указан атрибут [ProcessorAttribute](ProcessorAttribute.md 'Pf2eDataScrapper\.Processors\.Attributes\.ProcessorAttribute')\. | +| [AbstractSimpleProcessor](AbstractSimpleProcessor.md 'Pf2eDataScrapper\.Processors\.Definitions\.AbstractSimpleProcessor') | Абстрактный класс\-обработчик данных, полученных из Архивов Нефиса\. Класс предназначен для обработки данных с помощью различных обработчиков, для которых указан атрибут [ProcessorAttribute](ProcessorAttribute.md 'Pf2eDataScrapper\.Processors\.Attributes\.ProcessorAttribute')\. | + +| Interfaces | | +| :--- | :--- | +| [IProcessor](IProcessor.md 'Pf2eDataScrapper\.Processors\.Definitions\.IProcessor') | Интерфейс для обработчиков данных\. | diff --git a/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.Processors.Factory.md b/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.Processors.Factory.md new file mode 100644 index 0000000..9f60e3e --- /dev/null +++ b/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.Processors.Factory.md @@ -0,0 +1,9 @@ +#### [Pf2eDataScrapper](index.md 'index') + +## Pf2eDataScrapper\.Processors\.Factory Namespace + +Фабрики для создания экземпляров обработчиков данных на основе их атрибутов и конфигурации\. + +| Classes | | +| :--- | :--- | +| [AbstractProcessorFactory](AbstractProcessorFactory.md 'Pf2eDataScrapper\.Processors\.Factory\.AbstractProcessorFactory') | Абстрактная фабрика создания процессоров\. | diff --git a/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.Processors.md b/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.Processors.md new file mode 100644 index 0000000..92f44a5 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.Processors.md @@ -0,0 +1,18 @@ +#### [Pf2eDataScrapper](index.md 'index') + +## Pf2eDataScrapper\.Processors Namespace + +Общее описание обработчиков данных\. + +| Classes | | +| :--- | :--- | +| [EnumSolver<TEnum>](EnumSolver_TEnum_.md 'Pf2eDataScrapper\.Processors\.EnumSolver\') | Абстрактный класс для разрешения значений перечислений\. | +| [LegacyItemException](LegacyItemException.md 'Pf2eDataScrapper\.Processors\.LegacyItemException') | Исключение, показывающее, что обработка сущности пропускается как устаревшая\. | +| [ProcessorInput](ProcessorInput.md 'Pf2eDataScrapper\.Processors\.ProcessorInput') | Класс для работы с JSON\-объектом\. | +| [ProcessorInput\.InvalidEnumStringException](ProcessorInput.InvalidEnumStringException.md 'Pf2eDataScrapper\.Processors\.ProcessorInput\.InvalidEnumStringException') | Исключение при неверном значении для перечисленния\. | +| [SilentSkipItemException](SilentSkipItemException.md 'Pf2eDataScrapper\.Processors\.SilentSkipItemException') | Исключение, показывающее, что обработка сущности пропускается без вывода сообщения\. | +| [SkipItemException](SkipItemException.md 'Pf2eDataScrapper\.Processors\.SkipItemException') | Исключение, показывающее, что обработка сущности пропускается\. | + +| Interfaces | | +| :--- | :--- | +| [IEnumSolver](IEnumSolver.md 'Pf2eDataScrapper\.Processors\.IEnumSolver') | Интерфейс для решения значений перечислений\. | diff --git a/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.SchemaBuilder.Types.md b/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.SchemaBuilder.Types.md new file mode 100644 index 0000000..be7f60b --- /dev/null +++ b/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.SchemaBuilder.Types.md @@ -0,0 +1,14 @@ +#### [Pf2eDataScrapper](index.md 'index') + +## Pf2eDataScrapper\.SchemaBuilder\.Types Namespace + +Типы полей, которые используются в схемах данных для описания структуры вводимых JSON\-данных\. + +| Classes | | +| :--- | :--- | +| [AbstractSchemaType](AbstractSchemaType.md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.AbstractSchemaType') | Абстрактный тип представоления данных в схеме\. | +| [ArraySchemaType](ArraySchemaType.md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.ArraySchemaType') | Тип представоления массива в схеме\. | +| [DictionarySchemaType](DictionarySchemaType.md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.DictionarySchemaType') | Тип представоления словаря в схеме\. | +| [IgnoreSchemaType](IgnoreSchemaType.md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.IgnoreSchemaType') | Тип, указывающий, что данные игнорируются\. | +| [ObjectSchemaType](ObjectSchemaType.md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.ObjectSchemaType') | Тип представоления объектов в схеме\. | +| [StaticSchemaType](StaticSchemaType.md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.StaticSchemaType') | Тип представоления простых значений в схеме\. | diff --git a/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.SchemaBuilder.md b/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.SchemaBuilder.md new file mode 100644 index 0000000..bd1c8fd --- /dev/null +++ b/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.SchemaBuilder.md @@ -0,0 +1,11 @@ +#### [Pf2eDataScrapper](index.md 'index') + +## Pf2eDataScrapper\.SchemaBuilder Namespace + +Классы обработки вводимых JSON\-данных и создание схемы данных для использовании при формировании обработчиков данных\. + +| Classes | | +| :--- | :--- | +| [AbstractSchemaBuildProcessor](AbstractSchemaBuildProcessor.md 'Pf2eDataScrapper\.SchemaBuilder\.AbstractSchemaBuildProcessor') | | +| [SchemaNode](SchemaNode.md 'Pf2eDataScrapper\.SchemaBuilder\.SchemaNode') | Элемент схемы данных\. | +| [TypeResolver](TypeResolver.md 'Pf2eDataScrapper\.SchemaBuilder\.TypeResolver') | Класс для определения типа поля в схеме данных\. | diff --git a/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.WPF.EntityViewer.Component.md b/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.WPF.EntityViewer.Component.md new file mode 100644 index 0000000..cc8f4b4 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.WPF.EntityViewer.Component.md @@ -0,0 +1,11 @@ +#### [Pf2eDataScrapper](index.md 'index') + +## Pf2eDataScrapper\.WPF\.EntityViewer\.Component Namespace + +Компоненты, которые используются в WPF\-окне просмотра сущностей Pathfinder 2e\. + +| Classes | | +| :--- | :--- | +| [EntityListControl](EntityListControl.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.Component\.EntityListControl') | Логика взаимодействия для DbEntityListControl\.xaml | +| [ViewControl](ViewControl.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.Component\.ViewControl') | | +| [ViewLadder](ViewLadder.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.Component\.ViewLadder') | Логика взаимодействия для ViewLadder\.xaml | diff --git a/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md b/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md new file mode 100644 index 0000000..e2f6d41 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md @@ -0,0 +1,26 @@ +#### [Pf2eDataScrapper](index.md 'index') + +## Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure Namespace + +Структура представления сущностей Pathfinder 2e в WPF\-приложении, включая классы и интерфейсы для отображения данных\. + +| Classes | | +| :--- | :--- | +| [CollapseCommand](CollapseCommand.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.CollapseCommand') | Команда для сворачивания/разворачивания поля структуры\. | +| [ColorAdapterConverter](ColorAdapterConverter.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.ColorAdapterConverter') | Преобразователь, который адаптирует цвет в зависимости от типа целевого свойства\. | +| [StructureBuilder](StructureBuilder.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureBuilder') | Класс для построения структуры данных класса\. | +| [StructureField](StructureField.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureField') | Базовый класс для полей структуры\. | +| [StructureFieldComplex](StructureFieldComplex.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldComplex') | Поле стркутуры с объектом\. | +| [StructureFieldComplex\.FieldRecord](StructureFieldComplex.FieldRecord.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldComplex\.FieldRecord') | Запись поля структуры\. | +| [StructureFieldEnum](StructureFieldEnum.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldEnum') | Поле структуры с перечислением\. | +| [StructureFieldIgnored](StructureFieldIgnored.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldIgnored') | Поле структуры пропускаемого объекта\. | +| [StructureFieldNull](StructureFieldNull.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldNull') | Пустое поле структуры\. | +| [StructureFieldPrimitive](StructureFieldPrimitive.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldPrimitive') | Простое поле структуры\. | +| [StructureFieldReference](StructureFieldReference.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldReference') | Поле структуры с ссылкой на объект\. | +| [StructureProcessedObject](StructureProcessedObject.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureProcessedObject') | Класс для хранения обработанного объекта\. | +| [StructureRow](StructureRow.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureRow') | Строка структуры, представляющая поле сущности\. | + +| Enums | | +| :--- | :--- | +| [LadderType](LadderType.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.LadderType') | Тип лестницы глубины\. | +| [StructureFieldType](StructureFieldType.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldType') | Тип поля структуры\. | diff --git a/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.WPF.EntityViewer.Stores.md b/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.WPF.EntityViewer.Stores.md new file mode 100644 index 0000000..005f7a9 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.WPF.EntityViewer.Stores.md @@ -0,0 +1,9 @@ +#### [Pf2eDataScrapper](index.md 'index') + +## Pf2eDataScrapper\.WPF\.EntityViewer\.Stores Namespace + +Хранилища данных для WPF\-приложения просмотра сущностей Pathfinder 2e, которые управляют состоянием и данными приложения\. + +| Classes | | +| :--- | :--- | +| [SelectedEntityStore](SelectedEntityStore.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.Stores\.SelectedEntityStore') | Хранилище выбранной сущности\. | diff --git a/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.WPF.EntityViewer.ViewModel.md b/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.WPF.EntityViewer.ViewModel.md new file mode 100644 index 0000000..1b4a99c --- /dev/null +++ b/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.WPF.EntityViewer.ViewModel.md @@ -0,0 +1,11 @@ +#### [Pf2eDataScrapper](index.md 'index') + +## Pf2eDataScrapper\.WPF\.EntityViewer\.ViewModel Namespace + +ViewModel для WPF\-приложения просмотра сущностей Pathfinder 2e, которые связывают данные и представление\. + +| Classes | | +| :--- | :--- | +| [EntityListViewModel](EntityListViewModel.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.ViewModel\.EntityListViewModel') | | +| [PageNavigationCommand](PageNavigationCommand.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.ViewModel\.PageNavigationCommand') | Команда для навигации по страницам\. | +| [ViewViewModel](ViewViewModel.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.ViewModel\.ViewViewModel') | | diff --git a/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.WPF.EntityViewer.md b/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.WPF.EntityViewer.md new file mode 100644 index 0000000..0b523ef --- /dev/null +++ b/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.WPF.EntityViewer.md @@ -0,0 +1,9 @@ +#### [Pf2eDataScrapper](index.md 'index') + +## Pf2eDataScrapper\.WPF\.EntityViewer Namespace + +WPF\-окно для просмотра сущностей Pathfinder 2e, с возможностью фильтрации и поиска по данным\. + +| Classes | | +| :--- | :--- | +| [EntityForm](EntityForm.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityForm') | | diff --git a/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.WPF.ProgressForm.md b/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.WPF.ProgressForm.md new file mode 100644 index 0000000..e725907 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.WPF.ProgressForm.md @@ -0,0 +1,9 @@ +#### [Pf2eDataScrapper](index.md 'index') + +## Pf2eDataScrapper\.WPF\.ProgressForm Namespace + +WPF\-окно для отображения прогресса выполнения операций, таких как импорт данных или обработка сущностей Pathfinder 2e\. + +| Classes | | +| :--- | :--- | +| [ProgressForm](ProgressForm.md 'Pf2eDataScrapper\.WPF\.ProgressForm\.ProgressForm') | Логика взаимодействия для ProgressFormWpf\.xaml | diff --git a/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.WPF.StartForm.Components.md b/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.WPF.StartForm.Components.md new file mode 100644 index 0000000..9815f70 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.WPF.StartForm.Components.md @@ -0,0 +1,9 @@ +#### [Pf2eDataScrapper](index.md 'index') + +## Pf2eDataScrapper\.WPF\.StartForm\.Components Namespace + +Компоненты, которые используются в WPF\-окне запуска приложения для выбора импортёра и настройки параметров обработки данных Pathfinder 2e\. + +| Classes | | +| :--- | :--- | +| [ProcessorCollectionControl](ProcessorCollectionControl.md 'Pf2eDataScrapper\.WPF\.StartForm\.Components\.ProcessorCollectionControl') | Логика взаимодействия для ProcessorCollectionControl\.xaml | diff --git a/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.WPF.StartForm.md b/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.WPF.StartForm.md new file mode 100644 index 0000000..2151766 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.WPF.StartForm.md @@ -0,0 +1,9 @@ +#### [Pf2eDataScrapper](index.md 'index') + +## Pf2eDataScrapper\.WPF\.StartForm Namespace + +WPF\-окно для запуска приложения, которое позволяет пользователю выбрать импортёр и начать обработку данных Pathfinder 2e\. + +| Classes | | +| :--- | :--- | +| [StartForm](StartForm.md 'Pf2eDataScrapper\.WPF\.StartForm\.StartForm') | | diff --git a/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.WPF.md b/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.WPF.md new file mode 100644 index 0000000..53f9d2d --- /dev/null +++ b/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.WPF.md @@ -0,0 +1,9 @@ +#### [Pf2eDataScrapper](index.md 'index') + +## Pf2eDataScrapper\.WPF Namespace + +WPF\-приложение для запуска обработчиков и просмотра данных Pathfinder 2e\. + +| Classes | | +| :--- | :--- | +| [WpfServiceProviderExtension](WpfServiceProviderExtension.md 'Pf2eDataScrapper\.WPF\.WpfServiceProviderExtension') | Расширение для IServiceCollection, позволяющее регистрировать сервисы WPF\. | diff --git a/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.md b/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.md new file mode 100644 index 0000000..b21305f --- /dev/null +++ b/Documentation/Pf2eDataScrapper/Pf2eDataScrapper.md @@ -0,0 +1,12 @@ +#### [Pf2eDataScrapper](index.md 'index') + +## Pf2eDataScrapper Namespace + +Модель классов ORM EntityFramework\. + +| Classes | | +| :--- | :--- | +| [ApplicationSettings](ApplicationSettings.md 'Pf2eDataScrapper\.ApplicationSettings') | Настройки программы\. | +| [EnvSettings](EnvSettings.md 'Pf2eDataScrapper\.EnvSettings') | Класс настроек\. | +| [ImportApplication](ImportApplication.md 'Pf2eDataScrapper\.ImportApplication') | | +| [Program](Program.md 'Pf2eDataScrapper\.Program') | | diff --git a/Documentation/Pf2eDataScrapper/ProcessProgress.Local.md b/Documentation/Pf2eDataScrapper/ProcessProgress.Local.md new file mode 100644 index 0000000..01108d8 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ProcessProgress.Local.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Helpers](Pf2eDataScrapper.Helpers.md 'Pf2eDataScrapper\.Helpers').[ProcessProgress](ProcessProgress.md 'Pf2eDataScrapper\.Helpers\.ProcessProgress') + +## ProcessProgress\.Local Property + +Прогресс работы конкретного обработчика [IProcessor](IProcessor.md 'Pf2eDataScrapper\.Processors\.Definitions\.IProcessor')\. + +```csharp +public Pf2eDataScrapper.Helpers.ProcessProgress.ProgressItem Local { get; } +``` + +#### Property Value +[ProgressItem](ProcessProgress.ProgressItem.md 'Pf2eDataScrapper\.Helpers\.ProcessProgress\.ProgressItem') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ProcessProgress.ProcessProgress().md b/Documentation/Pf2eDataScrapper/ProcessProgress.ProcessProgress().md new file mode 100644 index 0000000..5681102 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ProcessProgress.ProcessProgress().md @@ -0,0 +1,10 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Helpers](Pf2eDataScrapper.Helpers.md 'Pf2eDataScrapper\.Helpers').[ProcessProgress](ProcessProgress.md 'Pf2eDataScrapper\.Helpers\.ProcessProgress') + +## ProcessProgress\(\) Constructor + +Конструктор класса [ProcessProgress](ProcessProgress.md 'Pf2eDataScrapper\.Helpers\.ProcessProgress')\. + +```csharp +public ProcessProgress(); +``` \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ProcessProgress.Processors.md b/Documentation/Pf2eDataScrapper/ProcessProgress.Processors.md new file mode 100644 index 0000000..8ece215 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ProcessProgress.Processors.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Helpers](Pf2eDataScrapper.Helpers.md 'Pf2eDataScrapper\.Helpers').[ProcessProgress](ProcessProgress.md 'Pf2eDataScrapper\.Helpers\.ProcessProgress') + +## ProcessProgress\.Processors Property + +Прогресс обработки обработчиков [IProcessor](IProcessor.md 'Pf2eDataScrapper\.Processors\.Definitions\.IProcessor')\. + +```csharp +public Pf2eDataScrapper.Helpers.ProcessProgress.ProgressItem Processors { get; } +``` + +#### Property Value +[ProgressItem](ProcessProgress.ProgressItem.md 'Pf2eDataScrapper\.Helpers\.ProcessProgress\.ProgressItem') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ProcessProgress.ProgressItem.Complete().md b/Documentation/Pf2eDataScrapper/ProcessProgress.ProgressItem.Complete().md new file mode 100644 index 0000000..d3064d1 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ProcessProgress.ProgressItem.Complete().md @@ -0,0 +1,10 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Helpers](Pf2eDataScrapper.Helpers.md 'Pf2eDataScrapper\.Helpers').[ProcessProgress](ProcessProgress.md 'Pf2eDataScrapper\.Helpers\.ProcessProgress').[ProgressItem](ProcessProgress.ProgressItem.md 'Pf2eDataScrapper\.Helpers\.ProcessProgress\.ProgressItem') + +## ProcessProgress\.ProgressItem\.Complete\(\) Method + +Отмечает прогресс завершённым\. + +```csharp +public void Complete(); +``` \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ProcessProgress.ProgressItem.Count.md b/Documentation/Pf2eDataScrapper/ProcessProgress.ProgressItem.Count.md new file mode 100644 index 0000000..e24236a --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ProcessProgress.ProgressItem.Count.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Helpers](Pf2eDataScrapper.Helpers.md 'Pf2eDataScrapper\.Helpers').[ProcessProgress](ProcessProgress.md 'Pf2eDataScrapper\.Helpers\.ProcessProgress').[ProgressItem](ProcessProgress.ProgressItem.md 'Pf2eDataScrapper\.Helpers\.ProcessProgress\.ProgressItem') + +## ProcessProgress\.ProgressItem\.Count Property + +Количество обрабатываемых процессов\. + +```csharp +public int Count { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ProcessProgress.ProgressItem.Current.md b/Documentation/Pf2eDataScrapper/ProcessProgress.ProgressItem.Current.md new file mode 100644 index 0000000..ec7a98a --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ProcessProgress.ProgressItem.Current.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Helpers](Pf2eDataScrapper.Helpers.md 'Pf2eDataScrapper\.Helpers').[ProcessProgress](ProcessProgress.md 'Pf2eDataScrapper\.Helpers\.ProcessProgress').[ProgressItem](ProcessProgress.ProgressItem.md 'Pf2eDataScrapper\.Helpers\.ProcessProgress\.ProgressItem') + +## ProcessProgress\.ProgressItem\.Current Property + +Индекс текущего обрабатываемого процесса\. + +```csharp +public int Current { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ProcessProgress.ProgressItem.End().md b/Documentation/Pf2eDataScrapper/ProcessProgress.ProgressItem.End().md new file mode 100644 index 0000000..a72e778 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ProcessProgress.ProgressItem.End().md @@ -0,0 +1,10 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Helpers](Pf2eDataScrapper.Helpers.md 'Pf2eDataScrapper\.Helpers').[ProcessProgress](ProcessProgress.md 'Pf2eDataScrapper\.Helpers\.ProcessProgress').[ProgressItem](ProcessProgress.ProgressItem.md 'Pf2eDataScrapper\.Helpers\.ProcessProgress\.ProgressItem') + +## ProcessProgress\.ProgressItem\.End\(\) Method + +Отмечает конец работы над процессом и увеличивает значение прогресса\. + +```csharp +public void End(); +``` \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ProcessProgress.ProgressItem.Percent.md b/Documentation/Pf2eDataScrapper/ProcessProgress.ProgressItem.Percent.md new file mode 100644 index 0000000..8386c97 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ProcessProgress.ProgressItem.Percent.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Helpers](Pf2eDataScrapper.Helpers.md 'Pf2eDataScrapper\.Helpers').[ProcessProgress](ProcessProgress.md 'Pf2eDataScrapper\.Helpers\.ProcessProgress').[ProgressItem](ProcessProgress.ProgressItem.md 'Pf2eDataScrapper\.Helpers\.ProcessProgress\.ProgressItem') + +## ProcessProgress\.ProgressItem\.Percent Property + +Значение прогресса\. + +```csharp +public double Percent { get; } +``` + +#### Property Value +[System\.Double](https://docs.microsoft.com/en-us/dotnet/api/System.Double 'System\.Double') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ProcessProgress.ProgressItem.Reset(int).md b/Documentation/Pf2eDataScrapper/ProcessProgress.ProgressItem.Reset(int).md new file mode 100644 index 0000000..936da62 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ProcessProgress.ProgressItem.Reset(int).md @@ -0,0 +1,15 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Helpers](Pf2eDataScrapper.Helpers.md 'Pf2eDataScrapper\.Helpers').[ProcessProgress](ProcessProgress.md 'Pf2eDataScrapper\.Helpers\.ProcessProgress').[ProgressItem](ProcessProgress.ProgressItem.md 'Pf2eDataScrapper\.Helpers\.ProcessProgress\.ProgressItem') + +## ProcessProgress\.ProgressItem\.Reset\(int\) Method + +Сброс прогресса до нуля и установка нового максимального значения\. + +```csharp +public void Reset(int max=0); +``` +#### Parameters + + + +`max` [System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ProcessProgress.ProgressItem.Start(string).md b/Documentation/Pf2eDataScrapper/ProcessProgress.ProgressItem.Start(string).md new file mode 100644 index 0000000..3a0b513 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ProcessProgress.ProgressItem.Start(string).md @@ -0,0 +1,17 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Helpers](Pf2eDataScrapper.Helpers.md 'Pf2eDataScrapper\.Helpers').[ProcessProgress](ProcessProgress.md 'Pf2eDataScrapper\.Helpers\.ProcessProgress').[ProgressItem](ProcessProgress.ProgressItem.md 'Pf2eDataScrapper\.Helpers\.ProcessProgress\.ProgressItem') + +## ProcessProgress\.ProgressItem\.Start\(string\) Method + +Отмечает начало работы над процессом, описываемым строкой [text](ProcessProgress.ProgressItem.Start(string).md#Pf2eDataScrapper.Helpers.ProcessProgress.ProgressItem.Start(string).text 'Pf2eDataScrapper\.Helpers\.ProcessProgress\.ProgressItem\.Start\(string\)\.text')\. + +```csharp +public void Start(string text); +``` +#### Parameters + + + +`text` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +Строка, описывающая процесс\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ProcessProgress.ProgressItem.Text.md b/Documentation/Pf2eDataScrapper/ProcessProgress.ProgressItem.Text.md new file mode 100644 index 0000000..f86185f --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ProcessProgress.ProgressItem.Text.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Helpers](Pf2eDataScrapper.Helpers.md 'Pf2eDataScrapper\.Helpers').[ProcessProgress](ProcessProgress.md 'Pf2eDataScrapper\.Helpers\.ProcessProgress').[ProgressItem](ProcessProgress.ProgressItem.md 'Pf2eDataScrapper\.Helpers\.ProcessProgress\.ProgressItem') + +## ProcessProgress\.ProgressItem\.Text Property + +Название текущего обрабатываемого процесса\. + +```csharp +public string Text { get; set; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ProcessProgress.ProgressItem.ToString().md b/Documentation/Pf2eDataScrapper/ProcessProgress.ProgressItem.ToString().md new file mode 100644 index 0000000..4608e5d --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ProcessProgress.ProgressItem.ToString().md @@ -0,0 +1,14 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Helpers](Pf2eDataScrapper.Helpers.md 'Pf2eDataScrapper\.Helpers').[ProcessProgress](ProcessProgress.md 'Pf2eDataScrapper\.Helpers\.ProcessProgress').[ProgressItem](ProcessProgress.ProgressItem.md 'Pf2eDataScrapper\.Helpers\.ProcessProgress\.ProgressItem') + +## ProcessProgress\.ProgressItem\.ToString\(\) Method + +Получение строкового представления прогресса\. + +```csharp +public override string ToString(); +``` + +#### Returns +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') +Строковое представление прогресса\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ProcessProgress.ProgressItem.Update.md b/Documentation/Pf2eDataScrapper/ProcessProgress.ProgressItem.Update.md new file mode 100644 index 0000000..558029a --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ProcessProgress.ProgressItem.Update.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Helpers](Pf2eDataScrapper.Helpers.md 'Pf2eDataScrapper\.Helpers').[ProcessProgress](ProcessProgress.md 'Pf2eDataScrapper\.Helpers\.ProcessProgress').[ProgressItem](ProcessProgress.ProgressItem.md 'Pf2eDataScrapper\.Helpers\.ProcessProgress\.ProgressItem') + +## ProcessProgress\.ProgressItem\.Update Event + +Событие обновление\. + +```csharp +public event UpdateDelegate? Update; +``` + +#### Event Type +[UpdateDelegate\(\)](ProcessProgress.ProgressItem.UpdateDelegate().md 'Pf2eDataScrapper\.Helpers\.ProcessProgress\.ProgressItem\.UpdateDelegate\(\)') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ProcessProgress.ProgressItem.UpdateDelegate().md b/Documentation/Pf2eDataScrapper/ProcessProgress.ProgressItem.UpdateDelegate().md new file mode 100644 index 0000000..8cb6070 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ProcessProgress.ProgressItem.UpdateDelegate().md @@ -0,0 +1,10 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Helpers](Pf2eDataScrapper.Helpers.md 'Pf2eDataScrapper\.Helpers').[ProcessProgress](ProcessProgress.md 'Pf2eDataScrapper\.Helpers\.ProcessProgress').[ProgressItem](ProcessProgress.ProgressItem.md 'Pf2eDataScrapper\.Helpers\.ProcessProgress\.ProgressItem') + +## ProcessProgress\.ProgressItem\.UpdateDelegate\(\) Delegate + +Делегат события обновления\. + +```csharp +public delegate void ProcessProgress.ProgressItem.UpdateDelegate(); +``` \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ProcessProgress.ProgressItem.md b/Documentation/Pf2eDataScrapper/ProcessProgress.ProgressItem.md new file mode 100644 index 0000000..a672f15 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ProcessProgress.ProgressItem.md @@ -0,0 +1,31 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Helpers](Pf2eDataScrapper.Helpers.md 'Pf2eDataScrapper\.Helpers').[ProcessProgress](ProcessProgress.md 'Pf2eDataScrapper\.Helpers\.ProcessProgress') + +## ProcessProgress\.ProgressItem Class + +Класс прогресса\. + +```csharp +public class ProcessProgress.ProgressItem +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 ProgressItem + +| Properties | | +| :--- | :--- | +| [Count](ProcessProgress.ProgressItem.Count.md 'Pf2eDataScrapper\.Helpers\.ProcessProgress\.ProgressItem\.Count') | Количество обрабатываемых процессов\. | +| [Current](ProcessProgress.ProgressItem.Current.md 'Pf2eDataScrapper\.Helpers\.ProcessProgress\.ProgressItem\.Current') | Индекс текущего обрабатываемого процесса\. | +| [Percent](ProcessProgress.ProgressItem.Percent.md 'Pf2eDataScrapper\.Helpers\.ProcessProgress\.ProgressItem\.Percent') | Значение прогресса\. | +| [Text](ProcessProgress.ProgressItem.Text.md 'Pf2eDataScrapper\.Helpers\.ProcessProgress\.ProgressItem\.Text') | Название текущего обрабатываемого процесса\. | + +| Methods | | +| :--- | :--- | +| [Complete\(\)](ProcessProgress.ProgressItem.Complete().md 'Pf2eDataScrapper\.Helpers\.ProcessProgress\.ProgressItem\.Complete\(\)') | Отмечает прогресс завершённым\. | +| [End\(\)](ProcessProgress.ProgressItem.End().md 'Pf2eDataScrapper\.Helpers\.ProcessProgress\.ProgressItem\.End\(\)') | Отмечает конец работы над процессом и увеличивает значение прогресса\. | +| [Reset\(int\)](ProcessProgress.ProgressItem.Reset(int).md 'Pf2eDataScrapper\.Helpers\.ProcessProgress\.ProgressItem\.Reset\(int\)') | Сброс прогресса до нуля и установка нового максимального значения\. | +| [Start\(string\)](ProcessProgress.ProgressItem.Start(string).md 'Pf2eDataScrapper\.Helpers\.ProcessProgress\.ProgressItem\.Start\(string\)') | Отмечает начало работы над процессом, описываемым строкой [text](ProcessProgress.ProgressItem.Start(string).md#Pf2eDataScrapper.Helpers.ProcessProgress.ProgressItem.Start(string).text 'Pf2eDataScrapper\.Helpers\.ProcessProgress\.ProgressItem\.Start\(string\)\.text')\. | +| [ToString\(\)](ProcessProgress.ProgressItem.ToString().md 'Pf2eDataScrapper\.Helpers\.ProcessProgress\.ProgressItem\.ToString\(\)') | Получение строкового представления прогресса\. | + +| Events | | +| :--- | :--- | +| [Update](ProcessProgress.ProgressItem.Update.md 'Pf2eDataScrapper\.Helpers\.ProcessProgress\.ProgressItem\.Update') | Событие обновление\. | diff --git a/Documentation/Pf2eDataScrapper/ProcessProgress.Update().md b/Documentation/Pf2eDataScrapper/ProcessProgress.Update().md new file mode 100644 index 0000000..7aee9b2 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ProcessProgress.Update().md @@ -0,0 +1,10 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Helpers](Pf2eDataScrapper.Helpers.md 'Pf2eDataScrapper\.Helpers').[ProcessProgress](ProcessProgress.md 'Pf2eDataScrapper\.Helpers\.ProcessProgress') + +## ProcessProgress\.Update\(\) Method + +Событие обновления + +```csharp +private void Update(); +``` \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ProcessProgress.md b/Documentation/Pf2eDataScrapper/ProcessProgress.md new file mode 100644 index 0000000..3cd7546 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ProcessProgress.md @@ -0,0 +1,23 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Helpers](Pf2eDataScrapper.Helpers.md 'Pf2eDataScrapper\.Helpers') + +## ProcessProgress Class + +```csharp +internal class ProcessProgress : Pf2eDataScrapper.Helpers.AbstractLogger +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [Pf2eDataScrapper\.Helpers\.AbstractLogger](https://docs.microsoft.com/en-us/dotnet/api/Pf2eDataScrapper.Helpers.AbstractLogger 'Pf2eDataScrapper\.Helpers\.AbstractLogger') 🡒 ProcessProgress + +| Constructors | | +| :--- | :--- | +| [ProcessProgress\(\)](ProcessProgress.ProcessProgress().md 'Pf2eDataScrapper\.Helpers\.ProcessProgress\.ProcessProgress\(\)') | Конструктор класса [ProcessProgress](ProcessProgress.md 'Pf2eDataScrapper\.Helpers\.ProcessProgress')\. | + +| Properties | | +| :--- | :--- | +| [Local](ProcessProgress.Local.md 'Pf2eDataScrapper\.Helpers\.ProcessProgress\.Local') | Прогресс работы конкретного обработчика [IProcessor](IProcessor.md 'Pf2eDataScrapper\.Processors\.Definitions\.IProcessor')\. | +| [Processors](ProcessProgress.Processors.md 'Pf2eDataScrapper\.Helpers\.ProcessProgress\.Processors') | Прогресс обработки обработчиков [IProcessor](IProcessor.md 'Pf2eDataScrapper\.Processors\.Definitions\.IProcessor')\. | + +| Methods | | +| :--- | :--- | +| [Update\(\)](ProcessProgress.Update().md 'Pf2eDataScrapper\.Helpers\.ProcessProgress\.Update\(\)') | Событие обновления | diff --git a/Documentation/Pf2eDataScrapper/ProcessorAttribute.ProcessorAttribute(string).md b/Documentation/Pf2eDataScrapper/ProcessorAttribute.ProcessorAttribute(string).md new file mode 100644 index 0000000..ac20dab --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ProcessorAttribute.ProcessorAttribute(string).md @@ -0,0 +1,17 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Processors\.Attributes](Pf2eDataScrapper.Processors.Attributes.md 'Pf2eDataScrapper\.Processors\.Attributes').[ProcessorAttribute](ProcessorAttribute.md 'Pf2eDataScrapper\.Processors\.Attributes\.ProcessorAttribute') + +## ProcessorAttribute\(string\) Constructor + +Общий аттрибут обработчика\. + +```csharp +public ProcessorAttribute(string name); +``` +#### Parameters + + + +`name` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +Название обработчика\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ProcessorAttribute.md b/Documentation/Pf2eDataScrapper/ProcessorAttribute.md new file mode 100644 index 0000000..df67850 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ProcessorAttribute.md @@ -0,0 +1,16 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Processors\.Attributes](Pf2eDataScrapper.Processors.Attributes.md 'Pf2eDataScrapper\.Processors\.Attributes') + +## ProcessorAttribute Class + +Общий аттрибут обработчика\. + +```csharp +internal class ProcessorAttribute : Pf2eDataScrapper.Processors.Attributes.AbstractProcessorAttribute +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [System\.Attribute](https://docs.microsoft.com/en-us/dotnet/api/System.Attribute 'System\.Attribute') 🡒 [AbstractProcessorAttribute](AbstractProcessorAttribute.md 'Pf2eDataScrapper\.Processors\.Attributes\.AbstractProcessorAttribute') 🡒 ProcessorAttribute + +| Constructors | | +| :--- | :--- | +| [ProcessorAttribute\(string\)](ProcessorAttribute.ProcessorAttribute(string).md 'Pf2eDataScrapper\.Processors\.Attributes\.ProcessorAttribute\.ProcessorAttribute\(string\)') | Общий аттрибут обработчика\. | diff --git a/Documentation/Pf2eDataScrapper/ProcessorCollection.AllItems.md b/Documentation/Pf2eDataScrapper/ProcessorCollection.AllItems.md new file mode 100644 index 0000000..8119083 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ProcessorCollection.AllItems.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Processors\.Collection](Pf2eDataScrapper.Processors.Collection.md 'Pf2eDataScrapper\.Processors\.Collection').[ProcessorCollection](ProcessorCollection.md 'Pf2eDataScrapper\.Processors\.Collection\.ProcessorCollection') + +## ProcessorCollection\.AllItems Property + +Коллекция всех доступных обработчиков\. + +```csharp +public System.Collections.Generic.ICollection AllItems { get; } +``` + +#### Property Value +[System\.Collections\.Generic\.ICollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1')[ProcessorRecord](ProcessorRecord.md 'Pf2eDataScrapper\.Processors\.Collection\.ProcessorRecord')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ProcessorCollection.CheckDependencies().md b/Documentation/Pf2eDataScrapper/ProcessorCollection.CheckDependencies().md new file mode 100644 index 0000000..6381395 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ProcessorCollection.CheckDependencies().md @@ -0,0 +1,10 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Processors\.Collection](Pf2eDataScrapper.Processors.Collection.md 'Pf2eDataScrapper\.Processors\.Collection').[ProcessorCollection](ProcessorCollection.md 'Pf2eDataScrapper\.Processors\.Collection\.ProcessorCollection') + +## ProcessorCollection\.CheckDependencies\(\) Method + +Проверка, что все зависимости всех обработчиков могут быть удовлетворены\. + +```csharp +private void CheckDependencies(); +``` \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ProcessorCollection.FilterProcessors(ICollection_string_).md b/Documentation/Pf2eDataScrapper/ProcessorCollection.FilterProcessors(ICollection_string_).md new file mode 100644 index 0000000..a3706fe --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ProcessorCollection.FilterProcessors(ICollection_string_).md @@ -0,0 +1,18 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Processors\.Collection](Pf2eDataScrapper.Processors.Collection.md 'Pf2eDataScrapper\.Processors\.Collection').[ProcessorCollection](ProcessorCollection.md 'Pf2eDataScrapper\.Processors\.Collection\.ProcessorCollection') + +## ProcessorCollection\.FilterProcessors\(ICollection\\) Method + +Ограничить список используемых обработчиков по названию\. +Автоматически включает все обработчики, от которых зависят указанные в аргументе обработчики\. + +```csharp +public void FilterProcessors(System.Collections.Generic.ICollection processorNames); +``` +#### Parameters + + + +`processorNames` [System\.Collections\.Generic\.ICollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1')[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1') + +Коллекция названиий требуемых обработчиков\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ProcessorCollection.GetTypesOfCompendium(ProcessorCompendiumEnum).md b/Documentation/Pf2eDataScrapper/ProcessorCollection.GetTypesOfCompendium(ProcessorCompendiumEnum).md new file mode 100644 index 0000000..96f0752 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ProcessorCollection.GetTypesOfCompendium(ProcessorCompendiumEnum).md @@ -0,0 +1,21 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Processors\.Collection](Pf2eDataScrapper.Processors.Collection.md 'Pf2eDataScrapper\.Processors\.Collection').[ProcessorCollection](ProcessorCollection.md 'Pf2eDataScrapper\.Processors\.Collection\.ProcessorCollection') + +## ProcessorCollection\.GetTypesOfCompendium\(ProcessorCompendiumEnum\) Method + +Получить список типов, которые обрабатываются в компендиуме\. + +```csharp +public System.Collections.Generic.ICollection GetTypesOfCompendium(Pf2eDataScrapper.Processors.Attributes.ProcessorCompendiumEnum compendium); +``` +#### Parameters + + + +`compendium` [ProcessorCompendiumEnum](ProcessorCompendiumEnum.md 'Pf2eDataScrapper\.Processors\.Attributes\.ProcessorCompendiumEnum') + +Тип компендиума\. + +#### Returns +[System\.Collections\.Generic\.ICollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1')[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1') +Набор типов\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ProcessorCollection.Items.md b/Documentation/Pf2eDataScrapper/ProcessorCollection.Items.md new file mode 100644 index 0000000..a48c1fc --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ProcessorCollection.Items.md @@ -0,0 +1,14 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Processors\.Collection](Pf2eDataScrapper.Processors.Collection.md 'Pf2eDataScrapper\.Processors\.Collection').[ProcessorCollection](ProcessorCollection.md 'Pf2eDataScrapper\.Processors\.Collection\.ProcessorCollection') + +## ProcessorCollection\.Items Property + +Коллекция обработчиков, которые будут обрабатываться\. +Для изменения необходимо использовать [FilterProcessors\(ICollection<string>\)](ProcessorCollection.FilterProcessors(ICollection_string_).md 'Pf2eDataScrapper\.Processors\.Collection\.ProcessorCollection\.FilterProcessors\(System\.Collections\.Generic\.ICollection\\)')\. + +```csharp +public System.Collections.Generic.List Items { get; private set; } +``` + +#### Property Value +[System\.Collections\.Generic\.List<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.List-1 'System\.Collections\.Generic\.List\`1')[ProcessorRecord](ProcessorRecord.md 'Pf2eDataScrapper\.Processors\.Collection\.ProcessorRecord')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.List-1 'System\.Collections\.Generic\.List\`1') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ProcessorCollection.ProcessorCollection(IServiceProvider).md b/Documentation/Pf2eDataScrapper/ProcessorCollection.ProcessorCollection(IServiceProvider).md new file mode 100644 index 0000000..65bc1be --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ProcessorCollection.ProcessorCollection(IServiceProvider).md @@ -0,0 +1,15 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Processors\.Collection](Pf2eDataScrapper.Processors.Collection.md 'Pf2eDataScrapper\.Processors\.Collection').[ProcessorCollection](ProcessorCollection.md 'Pf2eDataScrapper\.Processors\.Collection\.ProcessorCollection') + +## ProcessorCollection\(IServiceProvider\) Constructor + +Конструктор класса [ProcessorCollection](ProcessorCollection.md 'Pf2eDataScrapper\.Processors\.Collection\.ProcessorCollection')\. + +```csharp +public ProcessorCollection(System.IServiceProvider serviceProvider); +``` +#### Parameters + + + +`serviceProvider` [System\.IServiceProvider](https://docs.microsoft.com/en-us/dotnet/api/System.IServiceProvider 'System\.IServiceProvider') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ProcessorCollection.SortItems().md b/Documentation/Pf2eDataScrapper/ProcessorCollection.SortItems().md new file mode 100644 index 0000000..a5e0315 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ProcessorCollection.SortItems().md @@ -0,0 +1,10 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Processors\.Collection](Pf2eDataScrapper.Processors.Collection.md 'Pf2eDataScrapper\.Processors\.Collection').[ProcessorCollection](ProcessorCollection.md 'Pf2eDataScrapper\.Processors\.Collection\.ProcessorCollection') + +## ProcessorCollection\.SortItems\(\) Method + +Сортировать обработчики в соответсвии со всеми зависимостями\. + +```csharp +public void SortItems(); +``` \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ProcessorCollection.md b/Documentation/Pf2eDataScrapper/ProcessorCollection.md new file mode 100644 index 0000000..05374db --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ProcessorCollection.md @@ -0,0 +1,29 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Processors\.Collection](Pf2eDataScrapper.Processors.Collection.md 'Pf2eDataScrapper\.Processors\.Collection') + +## ProcessorCollection Class + +Класс с коллекцией обработчиков\. + +```csharp +internal class ProcessorCollection +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 ProcessorCollection + +| Constructors | | +| :--- | :--- | +| [ProcessorCollection\(IServiceProvider\)](ProcessorCollection.ProcessorCollection(IServiceProvider).md 'Pf2eDataScrapper\.Processors\.Collection\.ProcessorCollection\.ProcessorCollection\(System\.IServiceProvider\)') | Конструктор класса [ProcessorCollection](ProcessorCollection.md 'Pf2eDataScrapper\.Processors\.Collection\.ProcessorCollection')\. | + +| Properties | | +| :--- | :--- | +| [AllItems](ProcessorCollection.AllItems.md 'Pf2eDataScrapper\.Processors\.Collection\.ProcessorCollection\.AllItems') | Коллекция всех доступных обработчиков\. | +| [Items](ProcessorCollection.Items.md 'Pf2eDataScrapper\.Processors\.Collection\.ProcessorCollection\.Items') | Коллекция обработчиков, которые будут обрабатываться\. Для изменения необходимо использовать [FilterProcessors\(ICollection<string>\)](ProcessorCollection.FilterProcessors(ICollection_string_).md 'Pf2eDataScrapper\.Processors\.Collection\.ProcessorCollection\.FilterProcessors\(System\.Collections\.Generic\.ICollection\\)')\. | +| [this\[string\]](ProcessorCollection.this[string].md 'Pf2eDataScrapper\.Processors\.Collection\.ProcessorCollection\.this\[string\]') | Обеспечение доступа к элементам обработчиков\. | + +| Methods | | +| :--- | :--- | +| [CheckDependencies\(\)](ProcessorCollection.CheckDependencies().md 'Pf2eDataScrapper\.Processors\.Collection\.ProcessorCollection\.CheckDependencies\(\)') | Проверка, что все зависимости всех обработчиков могут быть удовлетворены\. | +| [FilterProcessors\(ICollection<string>\)](ProcessorCollection.FilterProcessors(ICollection_string_).md 'Pf2eDataScrapper\.Processors\.Collection\.ProcessorCollection\.FilterProcessors\(System\.Collections\.Generic\.ICollection\\)') | Ограничить список используемых обработчиков по названию\. Автоматически включает все обработчики, от которых зависят указанные в аргументе обработчики\. | +| [GetTypesOfCompendium\(ProcessorCompendiumEnum\)](ProcessorCollection.GetTypesOfCompendium(ProcessorCompendiumEnum).md 'Pf2eDataScrapper\.Processors\.Collection\.ProcessorCollection\.GetTypesOfCompendium\(Pf2eDataScrapper\.Processors\.Attributes\.ProcessorCompendiumEnum\)') | Получить список типов, которые обрабатываются в компендиуме\. | +| [SortItems\(\)](ProcessorCollection.SortItems().md 'Pf2eDataScrapper\.Processors\.Collection\.ProcessorCollection\.SortItems\(\)') | Сортировать обработчики в соответсвии со всеми зависимостями\. | diff --git a/Documentation/Pf2eDataScrapper/ProcessorCollection.this[string].md b/Documentation/Pf2eDataScrapper/ProcessorCollection.this[string].md new file mode 100644 index 0000000..922626a --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ProcessorCollection.this[string].md @@ -0,0 +1,18 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Processors\.Collection](Pf2eDataScrapper.Processors.Collection.md 'Pf2eDataScrapper\.Processors\.Collection').[ProcessorCollection](ProcessorCollection.md 'Pf2eDataScrapper\.Processors\.Collection\.ProcessorCollection') + +## ProcessorCollection\.this\[string\] Property + +Обеспечение доступа к элементам обработчиков\. + +```csharp +public Pf2eDataScrapper.Processors.Collection.ProcessorRecord this[string name] { get; } +``` +#### Parameters + + + +`name` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +#### Property Value +[ProcessorRecord](ProcessorRecord.md 'Pf2eDataScrapper\.Processors\.Collection\.ProcessorRecord') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ProcessorCollectionAttribute.CompendiumType.md b/Documentation/Pf2eDataScrapper/ProcessorCollectionAttribute.CompendiumType.md new file mode 100644 index 0000000..2136133 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ProcessorCollectionAttribute.CompendiumType.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Processors\.Attributes](Pf2eDataScrapper.Processors.Attributes.md 'Pf2eDataScrapper\.Processors\.Attributes').[ProcessorCollectionAttribute](ProcessorCollectionAttribute.md 'Pf2eDataScrapper\.Processors\.Attributes\.ProcessorCollectionAttribute') + +## ProcessorCollectionAttribute\.CompendiumType Property + +Тип используемого компендиума\. + +```csharp +public Pf2eDataScrapper.Processors.Attributes.ProcessorCompendiumEnum CompendiumType { get; init; } +``` + +#### Property Value +[ProcessorCompendiumEnum](ProcessorCompendiumEnum.md 'Pf2eDataScrapper\.Processors\.Attributes\.ProcessorCompendiumEnum') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ProcessorCollectionAttribute.InnerType.md b/Documentation/Pf2eDataScrapper/ProcessorCollectionAttribute.InnerType.md new file mode 100644 index 0000000..e02c2a0 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ProcessorCollectionAttribute.InnerType.md @@ -0,0 +1,14 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Processors\.Attributes](Pf2eDataScrapper.Processors.Attributes.md 'Pf2eDataScrapper\.Processors\.Attributes').[ProcessorCollectionAttribute](ProcessorCollectionAttribute.md 'Pf2eDataScrapper\.Processors\.Attributes\.ProcessorCollectionAttribute') + +## ProcessorCollectionAttribute\.InnerType Property + +Название типов, который обрабатывает этот оброботчик\. +`null` \- обработать все типы\. + +```csharp +public string? InnerType { get; init; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ProcessorCollectionAttribute.ProcessorCollectionAttribute(string).md b/Documentation/Pf2eDataScrapper/ProcessorCollectionAttribute.ProcessorCollectionAttribute(string).md new file mode 100644 index 0000000..5d4d6f3 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ProcessorCollectionAttribute.ProcessorCollectionAttribute(string).md @@ -0,0 +1,17 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Processors\.Attributes](Pf2eDataScrapper.Processors.Attributes.md 'Pf2eDataScrapper\.Processors\.Attributes').[ProcessorCollectionAttribute](ProcessorCollectionAttribute.md 'Pf2eDataScrapper\.Processors\.Attributes\.ProcessorCollectionAttribute') + +## ProcessorCollectionAttribute\(string\) Constructor + +Аттрибут обработчика набор элементов\. + +```csharp +public ProcessorCollectionAttribute(string name); +``` +#### Parameters + + + +`name` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +Название обработчика\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ProcessorCollectionAttribute.md b/Documentation/Pf2eDataScrapper/ProcessorCollectionAttribute.md new file mode 100644 index 0000000..a643fd0 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ProcessorCollectionAttribute.md @@ -0,0 +1,21 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Processors\.Attributes](Pf2eDataScrapper.Processors.Attributes.md 'Pf2eDataScrapper\.Processors\.Attributes') + +## ProcessorCollectionAttribute Class + +Аттрибут обработчика набор элементов\. + +```csharp +internal class ProcessorCollectionAttribute : Pf2eDataScrapper.Processors.Attributes.AbstractProcessorAttribute +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [System\.Attribute](https://docs.microsoft.com/en-us/dotnet/api/System.Attribute 'System\.Attribute') 🡒 [AbstractProcessorAttribute](AbstractProcessorAttribute.md 'Pf2eDataScrapper\.Processors\.Attributes\.AbstractProcessorAttribute') 🡒 ProcessorCollectionAttribute + +| Constructors | | +| :--- | :--- | +| [ProcessorCollectionAttribute\(string\)](ProcessorCollectionAttribute.ProcessorCollectionAttribute(string).md 'Pf2eDataScrapper\.Processors\.Attributes\.ProcessorCollectionAttribute\.ProcessorCollectionAttribute\(string\)') | Аттрибут обработчика набор элементов\. | + +| Properties | | +| :--- | :--- | +| [CompendiumType](ProcessorCollectionAttribute.CompendiumType.md 'Pf2eDataScrapper\.Processors\.Attributes\.ProcessorCollectionAttribute\.CompendiumType') | Тип используемого компендиума\. | +| [InnerType](ProcessorCollectionAttribute.InnerType.md 'Pf2eDataScrapper\.Processors\.Attributes\.ProcessorCollectionAttribute\.InnerType') | Название типов, который обрабатывает этот оброботчик\. `null` \- обработать все типы\. | diff --git a/Documentation/Pf2eDataScrapper/ProcessorCollectionControl.InitializeComponent().md b/Documentation/Pf2eDataScrapper/ProcessorCollectionControl.InitializeComponent().md new file mode 100644 index 0000000..0418998 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ProcessorCollectionControl.InitializeComponent().md @@ -0,0 +1,12 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.StartForm\.Components](Pf2eDataScrapper.WPF.StartForm.Components.md 'Pf2eDataScrapper\.WPF\.StartForm\.Components').[ProcessorCollectionControl](ProcessorCollectionControl.md 'Pf2eDataScrapper\.WPF\.StartForm\.Components\.ProcessorCollectionControl') + +## ProcessorCollectionControl\.InitializeComponent\(\) Method + +InitializeComponent + +```csharp +public void InitializeComponent(); +``` + +Implements [InitializeComponent\(\)](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.Markup.IComponentConnector.InitializeComponent 'System\.Windows\.Markup\.IComponentConnector\.InitializeComponent') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ProcessorCollectionControl.md b/Documentation/Pf2eDataScrapper/ProcessorCollectionControl.md new file mode 100644 index 0000000..3c30baf --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ProcessorCollectionControl.md @@ -0,0 +1,18 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.StartForm\.Components](Pf2eDataScrapper.WPF.StartForm.Components.md 'Pf2eDataScrapper\.WPF\.StartForm\.Components') + +## ProcessorCollectionControl Class + +Логика взаимодействия для ProcessorCollectionControl\.xaml + +```csharp +internal class ProcessorCollectionControl : System.Windows.Controls.UserControl, System.Windows.Markup.IComponentConnector +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [System\.Windows\.Threading\.DispatcherObject](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.Threading.DispatcherObject 'System\.Windows\.Threading\.DispatcherObject') 🡒 [System\.Windows\.DependencyObject](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.DependencyObject 'System\.Windows\.DependencyObject') 🡒 [System\.Windows\.Media\.Visual](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.Media.Visual 'System\.Windows\.Media\.Visual') 🡒 [System\.Windows\.UIElement](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.UIElement 'System\.Windows\.UIElement') 🡒 [System\.Windows\.FrameworkElement](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.FrameworkElement 'System\.Windows\.FrameworkElement') 🡒 [System\.Windows\.Controls\.Control](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.Controls.Control 'System\.Windows\.Controls\.Control') 🡒 [System\.Windows\.Controls\.ContentControl](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.Controls.ContentControl 'System\.Windows\.Controls\.ContentControl') 🡒 [System\.Windows\.Controls\.UserControl](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.Controls.UserControl 'System\.Windows\.Controls\.UserControl') 🡒 ProcessorCollectionControl + +Implements [System\.Windows\.Markup\.IComponentConnector](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.Markup.IComponentConnector 'System\.Windows\.Markup\.IComponentConnector') + +| Methods | | +| :--- | :--- | +| [InitializeComponent\(\)](ProcessorCollectionControl.InitializeComponent().md 'Pf2eDataScrapper\.WPF\.StartForm\.Components\.ProcessorCollectionControl\.InitializeComponent\(\)') | InitializeComponent | diff --git a/Documentation/Pf2eDataScrapper/ProcessorCompendiumEnum.md b/Documentation/Pf2eDataScrapper/ProcessorCompendiumEnum.md new file mode 100644 index 0000000..04bd61a --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ProcessorCompendiumEnum.md @@ -0,0 +1,23 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Processors\.Attributes](Pf2eDataScrapper.Processors.Attributes.md 'Pf2eDataScrapper\.Processors\.Attributes') + +## ProcessorCompendiumEnum Enum + +Перечисление для типов компендиумов обработчиков\. + +```csharp +public enum ProcessorCompendiumEnum +``` +### Fields + + + +`Aonprd` 0 + +Компедиум Архивов Нефиса\. + + + +`FoundryEn` 1 + +Компедиум Foundry EN\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ProcessorDependenciesAttribute.Dependencies.md b/Documentation/Pf2eDataScrapper/ProcessorDependenciesAttribute.Dependencies.md new file mode 100644 index 0000000..7752598 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ProcessorDependenciesAttribute.Dependencies.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Processors\.Attributes](Pf2eDataScrapper.Processors.Attributes.md 'Pf2eDataScrapper\.Processors\.Attributes').[ProcessorDependenciesAttribute](ProcessorDependenciesAttribute.md 'Pf2eDataScrapper\.Processors\.Attributes\.ProcessorDependenciesAttribute') + +## ProcessorDependenciesAttribute\.Dependencies Property + +Коллекция названий обработчиков, которые должны быть выполнены до этого оброботчика\. + +```csharp +public System.Collections.Generic.ICollection Dependencies { get; } +``` + +#### Property Value +[System\.Collections\.Generic\.ICollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1')[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ProcessorDependenciesAttribute.ProcessorDependenciesAttribute(string[]).md b/Documentation/Pf2eDataScrapper/ProcessorDependenciesAttribute.ProcessorDependenciesAttribute(string[]).md new file mode 100644 index 0000000..dff81ab --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ProcessorDependenciesAttribute.ProcessorDependenciesAttribute(string[]).md @@ -0,0 +1,17 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Processors\.Attributes](Pf2eDataScrapper.Processors.Attributes.md 'Pf2eDataScrapper\.Processors\.Attributes').[ProcessorDependenciesAttribute](ProcessorDependenciesAttribute.md 'Pf2eDataScrapper\.Processors\.Attributes\.ProcessorDependenciesAttribute') + +## ProcessorDependenciesAttribute\(string\[\]\) Constructor + +Аттрибут зависимостей обработчика\. + +```csharp +public ProcessorDependenciesAttribute(string[] dependencies); +``` +#### Parameters + + + +`dependencies` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String')[\[\]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System\.Array') + +Коллекция названий обработчиков, которые должны быть выполнены до этого оброботчика\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ProcessorDependenciesAttribute.md b/Documentation/Pf2eDataScrapper/ProcessorDependenciesAttribute.md new file mode 100644 index 0000000..463a698 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ProcessorDependenciesAttribute.md @@ -0,0 +1,20 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Processors\.Attributes](Pf2eDataScrapper.Processors.Attributes.md 'Pf2eDataScrapper\.Processors\.Attributes') + +## ProcessorDependenciesAttribute Class + +Аттрибут зависимостей обработчика\. + +```csharp +public class ProcessorDependenciesAttribute : System.Attribute +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [System\.Attribute](https://docs.microsoft.com/en-us/dotnet/api/System.Attribute 'System\.Attribute') 🡒 ProcessorDependenciesAttribute + +| Constructors | | +| :--- | :--- | +| [ProcessorDependenciesAttribute\(string\[\]\)](ProcessorDependenciesAttribute.ProcessorDependenciesAttribute(string[]).md 'Pf2eDataScrapper\.Processors\.Attributes\.ProcessorDependenciesAttribute\.ProcessorDependenciesAttribute\(string\[\]\)') | Аттрибут зависимостей обработчика\. | + +| Properties | | +| :--- | :--- | +| [Dependencies](ProcessorDependenciesAttribute.Dependencies.md 'Pf2eDataScrapper\.Processors\.Attributes\.ProcessorDependenciesAttribute\.Dependencies') | Коллекция названий обработчиков, которые должны быть выполнены до этого оброботчика\. | diff --git a/Documentation/Pf2eDataScrapper/ProcessorFactoryAttribute.ProcessorType.md b/Documentation/Pf2eDataScrapper/ProcessorFactoryAttribute.ProcessorType.md new file mode 100644 index 0000000..4cc2e48 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ProcessorFactoryAttribute.ProcessorType.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Processors\.Attributes](Pf2eDataScrapper.Processors.Attributes.md 'Pf2eDataScrapper\.Processors\.Attributes').[ProcessorFactoryAttribute](ProcessorFactoryAttribute.md 'Pf2eDataScrapper\.Processors\.Attributes\.ProcessorFactoryAttribute') + +## ProcessorFactoryAttribute\.ProcessorType Property + +Тип обрабатывающего процессора + +```csharp +public System.Type ProcessorType { get; init; } +``` + +#### Property Value +[System\.Type](https://docs.microsoft.com/en-us/dotnet/api/System.Type 'System\.Type') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ProcessorFactoryAttribute.md b/Documentation/Pf2eDataScrapper/ProcessorFactoryAttribute.md new file mode 100644 index 0000000..97ce15b --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ProcessorFactoryAttribute.md @@ -0,0 +1,14 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Processors\.Attributes](Pf2eDataScrapper.Processors.Attributes.md 'Pf2eDataScrapper\.Processors\.Attributes') + +## ProcessorFactoryAttribute Class + +```csharp +internal class ProcessorFactoryAttribute : Pf2eDataScrapper.Processors.Attributes.AbstractProcessorAttribute +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [System\.Attribute](https://docs.microsoft.com/en-us/dotnet/api/System.Attribute 'System\.Attribute') 🡒 [AbstractProcessorAttribute](AbstractProcessorAttribute.md 'Pf2eDataScrapper\.Processors\.Attributes\.AbstractProcessorAttribute') 🡒 ProcessorFactoryAttribute + +| Properties | | +| :--- | :--- | +| [ProcessorType](ProcessorFactoryAttribute.ProcessorType.md 'Pf2eDataScrapper\.Processors\.Attributes\.ProcessorFactoryAttribute\.ProcessorType') | Тип обрабатывающего процессора | diff --git a/Documentation/Pf2eDataScrapper/ProcessorFactoryTypeEnum.md b/Documentation/Pf2eDataScrapper/ProcessorFactoryTypeEnum.md new file mode 100644 index 0000000..67b0070 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ProcessorFactoryTypeEnum.md @@ -0,0 +1,29 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Processors\.Attributes](Pf2eDataScrapper.Processors.Attributes.md 'Pf2eDataScrapper\.Processors\.Attributes') + +## ProcessorFactoryTypeEnum Enum + +Перечисление для типов фабрик обработчиков\. + +```csharp +public enum ProcessorFactoryTypeEnum +``` +### Fields + + + +`Simple` 0 + +Простая фабрика одиночного обработчика\. + + + +`Compendium` 1 + +Фабрика для создания обработчиков, которые могут обрабатывать типы данных компедиума\. + + + +`Iterator` 2 + +Фабрика для создания обработчиков, которые могут обрабатывать итераторы данных\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ProcessorGroupEnum.md b/Documentation/Pf2eDataScrapper/ProcessorGroupEnum.md new file mode 100644 index 0000000..b2f6c69 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ProcessorGroupEnum.md @@ -0,0 +1,53 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Processors\.Attributes](Pf2eDataScrapper.Processors.Attributes.md 'Pf2eDataScrapper\.Processors\.Attributes') + +## ProcessorGroupEnum Enum + +Перечисление для групп обработчиков\. + +```csharp +public enum ProcessorGroupEnum +``` +### Fields + + + +`General` 0 + +Общий обработчик\. + + + +`AonprdPreparation` 1 + +Обработчик для подготовки данных с сайта [Archives of Nethys Pathfinder 2e](https://aonprd.com/ 'https://aonprd\.com/')\. + + + +`AonprdEntities` 2 + +Обработчик основных сущностей с сайта [Archives of Nethys Pathfinder 2e](https://aonprd.com/ 'https://aonprd\.com/')\. + + + +`AonprdSubclasses` 3 + +Обработчик подклассов с сайта [Archives of Nethys Pathfinder 2e](https://aonprd.com/ 'https://aonprd\.com/')\. + + + +`AonprdFinalization` 4 + +Обработчик для завершения обработки данных с сайта [Archives of Nethys Pathfinder 2e](https://aonprd.com/ 'https://aonprd\.com/')\. + + + +`FoundryEnPreparation` 5 + +Обработчик для подготовки данных из модуля [pf2e](https://github.com/foundryvtt/pf2e 'https://github\.com/foundryvtt/pf2e') для FoundryVTT\. + + + +`FoundryEnEntities` 6 + +Обработчик основных сущностей из модуля [pf2e](https://github.com/foundryvtt/pf2e 'https://github\.com/foundryvtt/pf2e') для FoundryVTT\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ProcessorGroupEnumExtension.GetDescription(thisProcessorGroupEnum).md b/Documentation/Pf2eDataScrapper/ProcessorGroupEnumExtension.GetDescription(thisProcessorGroupEnum).md new file mode 100644 index 0000000..5eea2b8 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ProcessorGroupEnumExtension.GetDescription(thisProcessorGroupEnum).md @@ -0,0 +1,21 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Processors\.Attributes](Pf2eDataScrapper.Processors.Attributes.md 'Pf2eDataScrapper\.Processors\.Attributes').[ProcessorGroupEnumExtension](ProcessorGroupEnumExtension.md 'Pf2eDataScrapper\.Processors\.Attributes\.ProcessorGroupEnumExtension') + +## ProcessorGroupEnumExtension\.GetDescription\(this ProcessorGroupEnum\) Method + +Получает описание группы обработчика из атрибута [System\.ComponentModel\.DescriptionAttribute](https://docs.microsoft.com/en-us/dotnet/api/System.ComponentModel.DescriptionAttribute 'System\.ComponentModel\.DescriptionAttribute')\. + +```csharp +public static string GetDescription(this Pf2eDataScrapper.Processors.Attributes.ProcessorGroupEnum group); +``` +#### Parameters + + + +`group` [ProcessorGroupEnum](ProcessorGroupEnum.md 'Pf2eDataScrapper\.Processors\.Attributes\.ProcessorGroupEnum') + +Перечисление группы обработчика\. + +#### Returns +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') +Строка с описанием группы обработчика\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ProcessorGroupEnumExtension.md b/Documentation/Pf2eDataScrapper/ProcessorGroupEnumExtension.md new file mode 100644 index 0000000..df6c2ef --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ProcessorGroupEnumExtension.md @@ -0,0 +1,16 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Processors\.Attributes](Pf2eDataScrapper.Processors.Attributes.md 'Pf2eDataScrapper\.Processors\.Attributes') + +## ProcessorGroupEnumExtension Class + +Расширение для перечисления [ProcessorGroupEnum](ProcessorGroupEnum.md 'Pf2eDataScrapper\.Processors\.Attributes\.ProcessorGroupEnum')\. + +```csharp +public static class ProcessorGroupEnumExtension +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 ProcessorGroupEnumExtension + +| Methods | | +| :--- | :--- | +| [GetDescription\(this ProcessorGroupEnum\)](ProcessorGroupEnumExtension.GetDescription(thisProcessorGroupEnum).md 'Pf2eDataScrapper\.Processors\.Attributes\.ProcessorGroupEnumExtension\.GetDescription\(this Pf2eDataScrapper\.Processors\.Attributes\.ProcessorGroupEnum\)') | Получает описание группы обработчика из атрибута [System\.ComponentModel\.DescriptionAttribute](https://docs.microsoft.com/en-us/dotnet/api/System.ComponentModel.DescriptionAttribute 'System\.ComponentModel\.DescriptionAttribute')\. | diff --git a/Documentation/Pf2eDataScrapper/ProcessorInput.EnumOptional_T_(string,T).md b/Documentation/Pf2eDataScrapper/ProcessorInput.EnumOptional_T_(string,T).md new file mode 100644 index 0000000..a1006ea --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ProcessorInput.EnumOptional_T_(string,T).md @@ -0,0 +1,33 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Processors](Pf2eDataScrapper.Processors.md 'Pf2eDataScrapper\.Processors').[ProcessorInput](ProcessorInput.md 'Pf2eDataScrapper\.Processors\.ProcessorInput') + +## ProcessorInput\.EnumOptional\\(string, T\) Method + +Преобразование значения из JSON по заданному пути в перечисление с возможностью предоставить значение по умолчанию\. + +```csharp +public virtual T EnumOptional(string path, T defaultValue) + where T : System.Enum; +``` +#### Type parameters + + + +`T` +#### Parameters + + + +`path` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +Путь в JSON + + + +`defaultValue` [T](ProcessorInput.EnumOptional_T_(string,T).md#Pf2eDataScrapper.Processors.ProcessorInput.EnumOptional_T_(string,T).T 'Pf2eDataScrapper\.Processors\.ProcessorInput\.EnumOptional\\(string, T\)\.T') + +Значение, которое возвращается, если значение не найдено\. + +#### Returns +[T](ProcessorInput.EnumOptional_T_(string,T).md#Pf2eDataScrapper.Processors.ProcessorInput.EnumOptional_T_(string,T).T 'Pf2eDataScrapper\.Processors\.ProcessorInput\.EnumOptional\\(string, T\)\.T') +Значение перечисления T или defaultValue \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ProcessorInput.EnumRequired_T_(string).md b/Documentation/Pf2eDataScrapper/ProcessorInput.EnumRequired_T_(string).md new file mode 100644 index 0000000..72c21a2 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ProcessorInput.EnumRequired_T_(string).md @@ -0,0 +1,27 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Processors](Pf2eDataScrapper.Processors.md 'Pf2eDataScrapper\.Processors').[ProcessorInput](ProcessorInput.md 'Pf2eDataScrapper\.Processors\.ProcessorInput') + +## ProcessorInput\.EnumRequired\\(string\) Method + +Преобразование значения из JSON по заданному пути в перечисление с использованием \`PgName\` атрибута\. + +```csharp +public virtual T EnumRequired(string path) + where T : System.Enum; +``` +#### Type parameters + + + +`T` +#### Parameters + + + +`path` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +Путь в JSON\. + +#### Returns +[T](ProcessorInput.EnumRequired_T_(string).md#Pf2eDataScrapper.Processors.ProcessorInput.EnumRequired_T_(string).T 'Pf2eDataScrapper\.Processors\.ProcessorInput\.EnumRequired\\(string\)\.T') +Перечисление T или выбрасывает исключение, если значение не соответствует жодному варианту\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ProcessorInput.EnumSolvers.md b/Documentation/Pf2eDataScrapper/ProcessorInput.EnumSolvers.md new file mode 100644 index 0000000..690b503 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ProcessorInput.EnumSolvers.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Processors](Pf2eDataScrapper.Processors.md 'Pf2eDataScrapper\.Processors').[ProcessorInput](ProcessorInput.md 'Pf2eDataScrapper\.Processors\.ProcessorInput') + +## ProcessorInput\.EnumSolvers Property + +Интерфейсы, разрешающие значения перечислений\. + +```csharp +public System.Collections.Generic.IEnumerable EnumSolvers { get; } +``` + +#### Property Value +[System\.Collections\.Generic\.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System\.Collections\.Generic\.IEnumerable\`1')[IEnumSolver](IEnumSolver.md 'Pf2eDataScrapper\.Processors\.IEnumSolver')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System\.Collections\.Generic\.IEnumerable\`1') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ProcessorInput.Enum_T_(string).md b/Documentation/Pf2eDataScrapper/ProcessorInput.Enum_T_(string).md new file mode 100644 index 0000000..67b49c8 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ProcessorInput.Enum_T_(string).md @@ -0,0 +1,27 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Processors](Pf2eDataScrapper.Processors.md 'Pf2eDataScrapper\.Processors').[ProcessorInput](ProcessorInput.md 'Pf2eDataScrapper\.Processors\.ProcessorInput') + +## ProcessorInput\.Enum\\(string\) Method + +Преобразование значения из JSON в перечисление\. + +```csharp +public virtual T Enum(string value) + where T : System.Enum; +``` +#### Type parameters + + + +`T` +#### Parameters + + + +`value` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +Значение, которое нужно преобразовать + +#### Returns +[T](ProcessorInput.Enum_T_(string).md#Pf2eDataScrapper.Processors.ProcessorInput.Enum_T_(string).T 'Pf2eDataScrapper\.Processors\.ProcessorInput\.Enum\\(string\)\.T') +Объект типа \`T\`, если преобразование успешно, иначе выбрасывает исключение \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ProcessorInput.GetOptional.md b/Documentation/Pf2eDataScrapper/ProcessorInput.GetOptional.md new file mode 100644 index 0000000..5f0dd02 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ProcessorInput.GetOptional.md @@ -0,0 +1,67 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Processors](Pf2eDataScrapper.Processors.md 'Pf2eDataScrapper\.Processors').[ProcessorInput](ProcessorInput.md 'Pf2eDataScrapper\.Processors\.ProcessorInput') + +## ProcessorInput\.GetOptional Method + +| Overloads | | +| :--- | :--- | +| [GetOptional<T>\(string\)](ProcessorInput.GetOptional.md#Pf2eDataScrapper.Processors.ProcessorInput.GetOptional_T_(string) 'Pf2eDataScrapper\.Processors\.ProcessorInput\.GetOptional\\(string\)') | Значение из JSON по заданному пути, которое может не существовать\. | +| [GetOptional<T>\(string, T\)](ProcessorInput.GetOptional.md#Pf2eDataScrapper.Processors.ProcessorInput.GetOptional_T_(string,T) 'Pf2eDataScrapper\.Processors\.ProcessorInput\.GetOptional\\(string, T\)') | Значение из JSON по заданному пути с возможностью предоставить значение по умолчанию\. | + + + +## ProcessorInput\.GetOptional\\(string\) Method + +Значение из JSON по заданному пути, которое может не существовать\. + +```csharp +public virtual T? GetOptional(string path); +``` +#### Type parameters + + + +`T` +#### Parameters + + + +`path` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +Путь в JSON + +#### Returns +[T](ProcessorInput.md#Pf2eDataScrapper.Processors.ProcessorInput.GetOptional_T_(string).T 'Pf2eDataScrapper\.Processors\.ProcessorInput\.GetOptional\\(string\)\.T') +Объект типа \`T\` или \`null\`, если значение не найдено + + + +## ProcessorInput\.GetOptional\\(string, T\) Method + +Значение из JSON по заданному пути с возможностью предоставить значение по умолчанию\. + +```csharp +public virtual T GetOptional(string path, T defaultValue); +``` +#### Type parameters + + + +`T` +#### Parameters + + + +`path` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +Путь в JSON\. + + + +`defaultValue` [T](ProcessorInput.md#Pf2eDataScrapper.Processors.ProcessorInput.GetOptional_T_(string,T).T 'Pf2eDataScrapper\.Processors\.ProcessorInput\.GetOptional\\(string, T\)\.T') + +Значение, которое возвращается, если значение не найдено\. + +#### Returns +[T](ProcessorInput.md#Pf2eDataScrapper.Processors.ProcessorInput.GetOptional_T_(string,T).T 'Pf2eDataScrapper\.Processors\.ProcessorInput\.GetOptional\\(string, T\)\.T') +Объект типа \`T\` или \`defaultValue\`, если значение не найдено\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ProcessorInput.GetOptionalLocale(string,LocaleType).md b/Documentation/Pf2eDataScrapper/ProcessorInput.GetOptionalLocale(string,LocaleType).md new file mode 100644 index 0000000..f14e046 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ProcessorInput.GetOptionalLocale(string,LocaleType).md @@ -0,0 +1,27 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Processors](Pf2eDataScrapper.Processors.md 'Pf2eDataScrapper\.Processors').[ProcessorInput](ProcessorInput.md 'Pf2eDataScrapper\.Processors\.ProcessorInput') + +## ProcessorInput\.GetOptionalLocale\(string, LocaleType\) Method + +Преобразование значения из JSON по заданному пути в строку локализации для заданного типа локализации\. + +```csharp +public virtual Pf2eModel.Model.Common.I18n.LocaleString? GetOptionalLocale(string path, Pf2eModel.Model.Common.I18n.LocaleType type); +``` +#### Parameters + + + +`path` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +Путь в JSON\. + + + +`type` [Pf2eModel\.Model\.Common\.I18n\.LocaleType](https://docs.microsoft.com/en-us/dotnet/api/Pf2eModel.Model.Common.I18n.LocaleType 'Pf2eModel\.Model\.Common\.I18n\.LocaleType') + +Тип локализации\. + +#### Returns +[Pf2eModel\.Model\.Common\.I18n\.LocaleString](https://docs.microsoft.com/en-us/dotnet/api/Pf2eModel.Model.Common.I18n.LocaleString 'Pf2eModel\.Model\.Common\.I18n\.LocaleString') +Объект [Pf2eModel\.Model\.Common\.I18n\.LocaleString](https://docs.microsoft.com/en-us/dotnet/api/Pf2eModel.Model.Common.I18n.LocaleString 'Pf2eModel\.Model\.Common\.I18n\.LocaleString') или null, если значение не найдено\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ProcessorInput.GetRequiredLocale(string,LocaleType).md b/Documentation/Pf2eDataScrapper/ProcessorInput.GetRequiredLocale(string,LocaleType).md new file mode 100644 index 0000000..ea254fe --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ProcessorInput.GetRequiredLocale(string,LocaleType).md @@ -0,0 +1,27 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Processors](Pf2eDataScrapper.Processors.md 'Pf2eDataScrapper\.Processors').[ProcessorInput](ProcessorInput.md 'Pf2eDataScrapper\.Processors\.ProcessorInput') + +## ProcessorInput\.GetRequiredLocale\(string, LocaleType\) Method + +Преобразование значения из JSON по заданному пути в строку локализации для заданного типа локализации\. + +```csharp +public virtual Pf2eModel.Model.Common.I18n.LocaleString GetRequiredLocale(string path, Pf2eModel.Model.Common.I18n.LocaleType type); +``` +#### Parameters + + + +`path` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +Путь в JSON\. + + + +`type` [Pf2eModel\.Model\.Common\.I18n\.LocaleType](https://docs.microsoft.com/en-us/dotnet/api/Pf2eModel.Model.Common.I18n.LocaleType 'Pf2eModel\.Model\.Common\.I18n\.LocaleType') + +Тип локализации\. + +#### Returns +[Pf2eModel\.Model\.Common\.I18n\.LocaleString](https://docs.microsoft.com/en-us/dotnet/api/Pf2eModel.Model.Common.I18n.LocaleString 'Pf2eModel\.Model\.Common\.I18n\.LocaleString') +Объект [Pf2eModel\.Model\.Common\.I18n\.LocaleString](https://docs.microsoft.com/en-us/dotnet/api/Pf2eModel.Model.Common.I18n.LocaleString 'Pf2eModel\.Model\.Common\.I18n\.LocaleString') с добавленным значением для заданного типа\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ProcessorInput.GetRequired_T_(string).md b/Documentation/Pf2eDataScrapper/ProcessorInput.GetRequired_T_(string).md new file mode 100644 index 0000000..614bb50 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ProcessorInput.GetRequired_T_(string).md @@ -0,0 +1,31 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Processors](Pf2eDataScrapper.Processors.md 'Pf2eDataScrapper\.Processors').[ProcessorInput](ProcessorInput.md 'Pf2eDataScrapper\.Processors\.ProcessorInput') + +## ProcessorInput\.GetRequired\\(string\) Method + +Значение из JSON по заданному пути, которое обязательно должно существовать\. + +```csharp +public virtual T GetRequired(string path); +``` +#### Type parameters + + + +`T` +#### Parameters + + + +`path` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +Путь в JSON\. + +#### Returns +[T](ProcessorInput.GetRequired_T_(string).md#Pf2eDataScrapper.Processors.ProcessorInput.GetRequired_T_(string).T 'Pf2eDataScrapper\.Processors\.ProcessorInput\.GetRequired\\(string\)\.T') +Объект типа \`T\` или \`null\`, если не удалось найти значение\. + +#### Exceptions + +[System\.NullReferenceException](https://docs.microsoft.com/en-us/dotnet/api/System.NullReferenceException 'System\.NullReferenceException') +Если значение не найдено\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ProcessorInput.Input.md b/Documentation/Pf2eDataScrapper/ProcessorInput.Input.md new file mode 100644 index 0000000..e1f5e46 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ProcessorInput.Input.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Processors](Pf2eDataScrapper.Processors.md 'Pf2eDataScrapper\.Processors').[ProcessorInput](ProcessorInput.md 'Pf2eDataScrapper\.Processors\.ProcessorInput') + +## ProcessorInput\.Input Property + +Входящий JSON\-объект, который содержит данные для обработки\. + +```csharp +public Newtonsoft.Json.Linq.JObject Input { get; } +``` + +#### Property Value +[Newtonsoft\.Json\.Linq\.JObject](https://docs.microsoft.com/en-us/dotnet/api/Newtonsoft.Json.Linq.JObject 'Newtonsoft\.Json\.Linq\.JObject') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ProcessorInput.InvalidEnumStringException.InvalidEnumStringException(Type,string).md b/Documentation/Pf2eDataScrapper/ProcessorInput.InvalidEnumStringException.InvalidEnumStringException(Type,string).md new file mode 100644 index 0000000..c9151b6 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ProcessorInput.InvalidEnumStringException.InvalidEnumStringException(Type,string).md @@ -0,0 +1,23 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Processors](Pf2eDataScrapper.Processors.md 'Pf2eDataScrapper\.Processors').[ProcessorInput](ProcessorInput.md 'Pf2eDataScrapper\.Processors\.ProcessorInput').[InvalidEnumStringException](ProcessorInput.InvalidEnumStringException.md 'Pf2eDataScrapper\.Processors\.ProcessorInput\.InvalidEnumStringException') + +## InvalidEnumStringException\(Type, string\) Constructor + +Исключение при неверном значении для перечисленния\. + +```csharp +public InvalidEnumStringException(System.Type type, string value); +``` +#### Parameters + + + +`type` [System\.Type](https://docs.microsoft.com/en-us/dotnet/api/System.Type 'System\.Type') + +Тип перечисленния\. + + + +`value` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +Некорректное значение\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ProcessorInput.InvalidEnumStringException.md b/Documentation/Pf2eDataScrapper/ProcessorInput.InvalidEnumStringException.md new file mode 100644 index 0000000..f597569 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ProcessorInput.InvalidEnumStringException.md @@ -0,0 +1,16 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Processors](Pf2eDataScrapper.Processors.md 'Pf2eDataScrapper\.Processors').[ProcessorInput](ProcessorInput.md 'Pf2eDataScrapper\.Processors\.ProcessorInput') + +## ProcessorInput\.InvalidEnumStringException Class + +Исключение при неверном значении для перечисленния\. + +```csharp +public class ProcessorInput.InvalidEnumStringException : System.Exception +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [System\.Exception](https://docs.microsoft.com/en-us/dotnet/api/System.Exception 'System\.Exception') 🡒 InvalidEnumStringException + +| Constructors | | +| :--- | :--- | +| [InvalidEnumStringException\(Type, string\)](ProcessorInput.InvalidEnumStringException.InvalidEnumStringException(Type,string).md 'Pf2eDataScrapper\.Processors\.ProcessorInput\.InvalidEnumStringException\.InvalidEnumStringException\(System\.Type, string\)') | Исключение при неверном значении для перечисленния\. | diff --git a/Documentation/Pf2eDataScrapper/ProcessorInput.Md5(bool).md b/Documentation/Pf2eDataScrapper/ProcessorInput.Md5(bool).md new file mode 100644 index 0000000..c67294b --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ProcessorInput.Md5(bool).md @@ -0,0 +1,21 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Processors](Pf2eDataScrapper.Processors.md 'Pf2eDataScrapper\.Processors').[ProcessorInput](ProcessorInput.md 'Pf2eDataScrapper\.Processors\.ProcessorInput') + +## ProcessorInput\.Md5\(bool\) Method + +Создание контрольной суммы объекта\. + +```csharp +public string Md5(bool isLowercase=false); +``` +#### Parameters + + + +`isLowercase` [System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') + +Использовать шестнадцатеричные цифры в нижнем регистре\. + +#### Returns +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') +Контрольная сумма объекта\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ProcessorInput.Name.md b/Documentation/Pf2eDataScrapper/ProcessorInput.Name.md new file mode 100644 index 0000000..6457bd2 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ProcessorInput.Name.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Processors](Pf2eDataScrapper.Processors.md 'Pf2eDataScrapper\.Processors').[ProcessorInput](ProcessorInput.md 'Pf2eDataScrapper\.Processors\.ProcessorInput') + +## ProcessorInput\.Name Property + +Название объекта, ассоциированного с вводом\. + +```csharp +public string Name { get; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ProcessorInput.ProcessorInput(string,JObject,IEnumerable_IEnumSolver_).md b/Documentation/Pf2eDataScrapper/ProcessorInput.ProcessorInput(string,JObject,IEnumerable_IEnumSolver_).md new file mode 100644 index 0000000..29331f5 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ProcessorInput.ProcessorInput(string,JObject,IEnumerable_IEnumSolver_).md @@ -0,0 +1,29 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Processors](Pf2eDataScrapper.Processors.md 'Pf2eDataScrapper\.Processors').[ProcessorInput](ProcessorInput.md 'Pf2eDataScrapper\.Processors\.ProcessorInput') + +## ProcessorInput\(string, JObject, IEnumerable\\) Constructor + +Класс для работы с JSON\-объектом\. + +```csharp +public ProcessorInput(string name, Newtonsoft.Json.Linq.JObject input, System.Collections.Generic.IEnumerable enumSolvers); +``` +#### Parameters + + + +`name` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +Название объекта, ассоциированного с вводом\. + + + +`input` [Newtonsoft\.Json\.Linq\.JObject](https://docs.microsoft.com/en-us/dotnet/api/Newtonsoft.Json.Linq.JObject 'Newtonsoft\.Json\.Linq\.JObject') + +JSON\-объект, который будет использоваться для доступа к данным\. + + + +`enumSolvers` [System\.Collections\.Generic\.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System\.Collections\.Generic\.IEnumerable\`1')[IEnumSolver](IEnumSolver.md 'Pf2eDataScrapper\.Processors\.IEnumSolver')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System\.Collections\.Generic\.IEnumerable\`1') + +\[DI\] Набор интерфейсов, разрешающих значения перечислений\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ProcessorInput.md b/Documentation/Pf2eDataScrapper/ProcessorInput.md new file mode 100644 index 0000000..48836f0 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ProcessorInput.md @@ -0,0 +1,34 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Processors](Pf2eDataScrapper.Processors.md 'Pf2eDataScrapper\.Processors') + +## ProcessorInput Class + +Класс для работы с JSON\-объектом\. + +```csharp +internal class ProcessorInput +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 ProcessorInput + +| Constructors | | +| :--- | :--- | +| [ProcessorInput\(string, JObject, IEnumerable<IEnumSolver>\)](ProcessorInput.ProcessorInput(string,JObject,IEnumerable_IEnumSolver_).md 'Pf2eDataScrapper\.Processors\.ProcessorInput\.ProcessorInput\(string, Newtonsoft\.Json\.Linq\.JObject, System\.Collections\.Generic\.IEnumerable\\)') | Класс для работы с JSON\-объектом\. | + +| Properties | | +| :--- | :--- | +| [EnumSolvers](ProcessorInput.EnumSolvers.md 'Pf2eDataScrapper\.Processors\.ProcessorInput\.EnumSolvers') | Интерфейсы, разрешающие значения перечислений\. | +| [Input](ProcessorInput.Input.md 'Pf2eDataScrapper\.Processors\.ProcessorInput\.Input') | Входящий JSON\-объект, который содержит данные для обработки\. | +| [Name](ProcessorInput.Name.md 'Pf2eDataScrapper\.Processors\.ProcessorInput\.Name') | Название объекта, ассоциированного с вводом\. | + +| Methods | | +| :--- | :--- | +| [Enum<T>\(string\)](ProcessorInput.Enum_T_(string).md 'Pf2eDataScrapper\.Processors\.ProcessorInput\.Enum\\(string\)') | Преобразование значения из JSON в перечисление\. | +| [EnumOptional<T>\(string, T\)](ProcessorInput.EnumOptional_T_(string,T).md 'Pf2eDataScrapper\.Processors\.ProcessorInput\.EnumOptional\\(string, T\)') | Преобразование значения из JSON по заданному пути в перечисление с возможностью предоставить значение по умолчанию\. | +| [EnumRequired<T>\(string\)](ProcessorInput.EnumRequired_T_(string).md 'Pf2eDataScrapper\.Processors\.ProcessorInput\.EnumRequired\\(string\)') | Преобразование значения из JSON по заданному пути в перечисление с использованием \`PgName\` атрибута\. | +| [GetOptional<T>\(string\)](ProcessorInput.GetOptional.md#Pf2eDataScrapper.Processors.ProcessorInput.GetOptional_T_(string) 'Pf2eDataScrapper\.Processors\.ProcessorInput\.GetOptional\\(string\)') | Значение из JSON по заданному пути, которое может не существовать\. | +| [GetOptional<T>\(string, T\)](ProcessorInput.GetOptional.md#Pf2eDataScrapper.Processors.ProcessorInput.GetOptional_T_(string,T) 'Pf2eDataScrapper\.Processors\.ProcessorInput\.GetOptional\\(string, T\)') | Значение из JSON по заданному пути с возможностью предоставить значение по умолчанию\. | +| [GetOptionalLocale\(string, LocaleType\)](ProcessorInput.GetOptionalLocale(string,LocaleType).md 'Pf2eDataScrapper\.Processors\.ProcessorInput\.GetOptionalLocale\(string, Pf2eModel\.Model\.Common\.I18n\.LocaleType\)') | Преобразование значения из JSON по заданному пути в строку локализации для заданного типа локализации\. | +| [GetRequired<T>\(string\)](ProcessorInput.GetRequired_T_(string).md 'Pf2eDataScrapper\.Processors\.ProcessorInput\.GetRequired\\(string\)') | Значение из JSON по заданному пути, которое обязательно должно существовать\. | +| [GetRequiredLocale\(string, LocaleType\)](ProcessorInput.GetRequiredLocale(string,LocaleType).md 'Pf2eDataScrapper\.Processors\.ProcessorInput\.GetRequiredLocale\(string, Pf2eModel\.Model\.Common\.I18n\.LocaleType\)') | Преобразование значения из JSON по заданному пути в строку локализации для заданного типа локализации\. | +| [Md5\(bool\)](ProcessorInput.Md5(bool).md 'Pf2eDataScrapper\.Processors\.ProcessorInput\.Md5\(bool\)') | Создание контрольной суммы объекта\. | diff --git a/Documentation/Pf2eDataScrapper/ProcessorRecord.Active.md b/Documentation/Pf2eDataScrapper/ProcessorRecord.Active.md new file mode 100644 index 0000000..58cbdd2 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ProcessorRecord.Active.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Processors\.Collection](Pf2eDataScrapper.Processors.Collection.md 'Pf2eDataScrapper\.Processors\.Collection').[ProcessorRecord](ProcessorRecord.md 'Pf2eDataScrapper\.Processors\.Collection\.ProcessorRecord') + +## ProcessorRecord\.Active Property + +Процессор включён по умолчанию\. + +```csharp +public bool Active { get; init; } +``` + +#### Property Value +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ProcessorRecord.Dependencies.md b/Documentation/Pf2eDataScrapper/ProcessorRecord.Dependencies.md new file mode 100644 index 0000000..95f8e5c --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ProcessorRecord.Dependencies.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Processors\.Collection](Pf2eDataScrapper.Processors.Collection.md 'Pf2eDataScrapper\.Processors\.Collection').[ProcessorRecord](ProcessorRecord.md 'Pf2eDataScrapper\.Processors\.Collection\.ProcessorRecord') + +## ProcessorRecord\.Dependencies Property + +Коллекция названий обработчиков, после которых должен выполняться обработчик\. + +```csharp +public System.Collections.Generic.ICollection Dependencies { get; init; } +``` + +#### Property Value +[System\.Collections\.Generic\.ICollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1')[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ProcessorRecord.Description.md b/Documentation/Pf2eDataScrapper/ProcessorRecord.Description.md new file mode 100644 index 0000000..04c46f8 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ProcessorRecord.Description.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Processors\.Collection](Pf2eDataScrapper.Processors.Collection.md 'Pf2eDataScrapper\.Processors\.Collection').[ProcessorRecord](ProcessorRecord.md 'Pf2eDataScrapper\.Processors\.Collection\.ProcessorRecord') + +## ProcessorRecord\.Description Property + +Описание обработчика\. + +```csharp +public string Description { get; init; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ProcessorRecord.Factory.md b/Documentation/Pf2eDataScrapper/ProcessorRecord.Factory.md new file mode 100644 index 0000000..1c63860 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ProcessorRecord.Factory.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Processors\.Collection](Pf2eDataScrapper.Processors.Collection.md 'Pf2eDataScrapper\.Processors\.Collection').[ProcessorRecord](ProcessorRecord.md 'Pf2eDataScrapper\.Processors\.Collection\.ProcessorRecord') + +## ProcessorRecord\.Factory Property + +Фабрика обработчиков\. + +```csharp +public Pf2eDataScrapper.Processors.Factory.AbstractProcessorFactory Factory { get; set; } +``` + +#### Property Value +[AbstractProcessorFactory](AbstractProcessorFactory.md 'Pf2eDataScrapper\.Processors\.Factory\.AbstractProcessorFactory') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ProcessorRecord.Group.md b/Documentation/Pf2eDataScrapper/ProcessorRecord.Group.md new file mode 100644 index 0000000..a92614e --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ProcessorRecord.Group.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Processors\.Collection](Pf2eDataScrapper.Processors.Collection.md 'Pf2eDataScrapper\.Processors\.Collection').[ProcessorRecord](ProcessorRecord.md 'Pf2eDataScrapper\.Processors\.Collection\.ProcessorRecord') + +## ProcessorRecord\.Group Property + +Группа обработчика\. + +```csharp +public Pf2eDataScrapper.Processors.Attributes.ProcessorGroupEnum Group { get; init; } +``` + +#### Property Value +[ProcessorGroupEnum](ProcessorGroupEnum.md 'Pf2eDataScrapper\.Processors\.Attributes\.ProcessorGroupEnum') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ProcessorRecord.Name.md b/Documentation/Pf2eDataScrapper/ProcessorRecord.Name.md new file mode 100644 index 0000000..4dd0697 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ProcessorRecord.Name.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Processors\.Collection](Pf2eDataScrapper.Processors.Collection.md 'Pf2eDataScrapper\.Processors\.Collection').[ProcessorRecord](ProcessorRecord.md 'Pf2eDataScrapper\.Processors\.Collection\.ProcessorRecord') + +## ProcessorRecord\.Name Property + +Название обработчика\. + +```csharp +public string Name { get; init; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ProcessorRecord.Parallel.md b/Documentation/Pf2eDataScrapper/ProcessorRecord.Parallel.md new file mode 100644 index 0000000..222bb79 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ProcessorRecord.Parallel.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Processors\.Collection](Pf2eDataScrapper.Processors.Collection.md 'Pf2eDataScrapper\.Processors\.Collection').[ProcessorRecord](ProcessorRecord.md 'Pf2eDataScrapper\.Processors\.Collection\.ProcessorRecord') + +## ProcessorRecord\.Parallel Property + +Разрешить выполнять процессов в параллельном режиме + +```csharp +public bool Parallel { get; init; } +``` + +#### Property Value +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ProcessorRecord.Priority.md b/Documentation/Pf2eDataScrapper/ProcessorRecord.Priority.md new file mode 100644 index 0000000..af3d681 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ProcessorRecord.Priority.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Processors\.Collection](Pf2eDataScrapper.Processors.Collection.md 'Pf2eDataScrapper\.Processors\.Collection').[ProcessorRecord](ProcessorRecord.md 'Pf2eDataScrapper\.Processors\.Collection\.ProcessorRecord') + +## ProcessorRecord\.Priority Property + +Приоритет выполнения обработчика\. + +```csharp +public int Priority { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ProcessorRecord.Type.md b/Documentation/Pf2eDataScrapper/ProcessorRecord.Type.md new file mode 100644 index 0000000..293562c --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ProcessorRecord.Type.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Processors\.Collection](Pf2eDataScrapper.Processors.Collection.md 'Pf2eDataScrapper\.Processors\.Collection').[ProcessorRecord](ProcessorRecord.md 'Pf2eDataScrapper\.Processors\.Collection\.ProcessorRecord') + +## ProcessorRecord\.Type Property + +Тип класса обработчика\. + +```csharp +public System.Type Type { get; init; } +``` + +#### Property Value +[System\.Type](https://docs.microsoft.com/en-us/dotnet/api/System.Type 'System\.Type') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ProcessorRecord.md b/Documentation/Pf2eDataScrapper/ProcessorRecord.md new file mode 100644 index 0000000..db76840 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ProcessorRecord.md @@ -0,0 +1,24 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Processors\.Collection](Pf2eDataScrapper.Processors.Collection.md 'Pf2eDataScrapper\.Processors\.Collection') + +## ProcessorRecord Class + +Элемент коллекции обработчиков\. + +```csharp +internal class ProcessorRecord +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 ProcessorRecord + +| Properties | | +| :--- | :--- | +| [Active](ProcessorRecord.Active.md 'Pf2eDataScrapper\.Processors\.Collection\.ProcessorRecord\.Active') | Процессор включён по умолчанию\. | +| [Dependencies](ProcessorRecord.Dependencies.md 'Pf2eDataScrapper\.Processors\.Collection\.ProcessorRecord\.Dependencies') | Коллекция названий обработчиков, после которых должен выполняться обработчик\. | +| [Description](ProcessorRecord.Description.md 'Pf2eDataScrapper\.Processors\.Collection\.ProcessorRecord\.Description') | Описание обработчика\. | +| [Factory](ProcessorRecord.Factory.md 'Pf2eDataScrapper\.Processors\.Collection\.ProcessorRecord\.Factory') | Фабрика обработчиков\. | +| [Group](ProcessorRecord.Group.md 'Pf2eDataScrapper\.Processors\.Collection\.ProcessorRecord\.Group') | Группа обработчика\. | +| [Name](ProcessorRecord.Name.md 'Pf2eDataScrapper\.Processors\.Collection\.ProcessorRecord\.Name') | Название обработчика\. | +| [Parallel](ProcessorRecord.Parallel.md 'Pf2eDataScrapper\.Processors\.Collection\.ProcessorRecord\.Parallel') | Разрешить выполнять процессов в параллельном режиме | +| [Priority](ProcessorRecord.Priority.md 'Pf2eDataScrapper\.Processors\.Collection\.ProcessorRecord\.Priority') | Приоритет выполнения обработчика\. | +| [Type](ProcessorRecord.Type.md 'Pf2eDataScrapper\.Processors\.Collection\.ProcessorRecord\.Type') | Тип класса обработчика\. | diff --git a/Documentation/Pf2eDataScrapper/Program.Main().md b/Documentation/Pf2eDataScrapper/Program.Main().md new file mode 100644 index 0000000..38fe701 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/Program.Main().md @@ -0,0 +1,10 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper](Pf2eDataScrapper.md 'Pf2eDataScrapper').[Program](Program.md 'Pf2eDataScrapper\.Program') + +## Program\.Main\(\) Method + +The main entry point for the application\. + +```csharp +public static void Main(); +``` \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/Program.md b/Documentation/Pf2eDataScrapper/Program.md new file mode 100644 index 0000000..75198e3 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/Program.md @@ -0,0 +1,14 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper](Pf2eDataScrapper.md 'Pf2eDataScrapper') + +## Program Class + +```csharp +internal static class Program +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 Program + +| Methods | | +| :--- | :--- | +| [Main\(\)](Program.Main().md 'Pf2eDataScrapper\.Program\.Main\(\)') | The main entry point for the application\. | diff --git a/Documentation/Pf2eDataScrapper/ProgressForm.InitializeComponent().md b/Documentation/Pf2eDataScrapper/ProgressForm.InitializeComponent().md new file mode 100644 index 0000000..8a95075 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ProgressForm.InitializeComponent().md @@ -0,0 +1,12 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.ProgressForm](Pf2eDataScrapper.WPF.ProgressForm.md 'Pf2eDataScrapper\.WPF\.ProgressForm').[ProgressForm](ProgressForm.md 'Pf2eDataScrapper\.WPF\.ProgressForm\.ProgressForm') + +## ProgressForm\.InitializeComponent\(\) Method + +InitializeComponent + +```csharp +public void InitializeComponent(); +``` + +Implements [InitializeComponent\(\)](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.Markup.IComponentConnector.InitializeComponent 'System\.Windows\.Markup\.IComponentConnector\.InitializeComponent') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ProgressForm.md b/Documentation/Pf2eDataScrapper/ProgressForm.md new file mode 100644 index 0000000..f6349c6 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ProgressForm.md @@ -0,0 +1,18 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.ProgressForm](Pf2eDataScrapper.WPF.ProgressForm.md 'Pf2eDataScrapper\.WPF\.ProgressForm') + +## ProgressForm Class + +Логика взаимодействия для ProgressFormWpf\.xaml + +```csharp +internal class ProgressForm : System.Windows.Window, System.Windows.Markup.IComponentConnector +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [System\.Windows\.Threading\.DispatcherObject](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.Threading.DispatcherObject 'System\.Windows\.Threading\.DispatcherObject') 🡒 [System\.Windows\.DependencyObject](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.DependencyObject 'System\.Windows\.DependencyObject') 🡒 [System\.Windows\.Media\.Visual](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.Media.Visual 'System\.Windows\.Media\.Visual') 🡒 [System\.Windows\.UIElement](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.UIElement 'System\.Windows\.UIElement') 🡒 [System\.Windows\.FrameworkElement](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.FrameworkElement 'System\.Windows\.FrameworkElement') 🡒 [System\.Windows\.Controls\.Control](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.Controls.Control 'System\.Windows\.Controls\.Control') 🡒 [System\.Windows\.Controls\.ContentControl](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.Controls.ContentControl 'System\.Windows\.Controls\.ContentControl') 🡒 [System\.Windows\.Window](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.Window 'System\.Windows\.Window') 🡒 ProgressForm + +Implements [System\.Windows\.Markup\.IComponentConnector](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.Markup.IComponentConnector 'System\.Windows\.Markup\.IComponentConnector') + +| Methods | | +| :--- | :--- | +| [InitializeComponent\(\)](ProgressForm.InitializeComponent().md 'Pf2eDataScrapper\.WPF\.ProgressForm\.ProgressForm\.InitializeComponent\(\)') | InitializeComponent | diff --git a/Documentation/Pf2eDataScrapper/RitualProcessor.Add().md b/Documentation/Pf2eDataScrapper/RitualProcessor.Add().md new file mode 100644 index 0000000..e829601 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/RitualProcessor.Add().md @@ -0,0 +1,10 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types').[RitualProcessor](RitualProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.RitualProcessor') + +## RitualProcessor\.Add\(\) Method + +Добавление основной сущности в контекст базы данных\. + +```csharp +protected override void Add(); +``` \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/RitualProcessor.AddedDescriptionPaths().md b/Documentation/Pf2eDataScrapper/RitualProcessor.AddedDescriptionPaths().md new file mode 100644 index 0000000..48dbdf4 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/RitualProcessor.AddedDescriptionPaths().md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types').[RitualProcessor](RitualProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.RitualProcessor') + +## RitualProcessor\.AddedDescriptionPaths\(\) Method + +Получение списка полей, которые должны быть добавлены в описание\. + +```csharp +protected virtual string[] AddedDescriptionPaths(); +``` + +#### Returns +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String')[\[\]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System\.Array') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/RitualProcessor.CasterRegex().md b/Documentation/Pf2eDataScrapper/RitualProcessor.CasterRegex().md new file mode 100644 index 0000000..39dc7f3 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/RitualProcessor.CasterRegex().md @@ -0,0 +1,41 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types').[RitualProcessor](RitualProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.RitualProcessor') + +## RitualProcessor\.CasterRegex\(\) Method + +```csharp +private static System.Text.RegularExpressions.Regex CasterRegex(); +``` + +#### Returns +[System\.Text\.RegularExpressions\.Regex](https://docs.microsoft.com/en-us/dotnet/api/System.Text.RegularExpressions.Regex 'System\.Text\.RegularExpressions\.Regex') + +### Remarks +Pattern:
+ +```csharp +^(\\d+)(?:\\-(\\d+))?,? *\\(?(.*?)\\)?$ +```
+Options:
+ +```csharp +RegexOptions.Multiline +```
+Explanation:
+ +```csharp +○ Match if at the beginning of a line.
+○ 1st capture group.
+ ○ Match a Unicode digit greedily at least once.
+○ Optional (greedy).
+ ○ Match '-'.
+ ○ 2nd capture group.
+ ○ Match a Unicode digit greedily at least once.
+○ Match ',' greedily, optionally.
+○ Match ' ' greedily any number of times.
+○ Match '(' greedily, optionally.
+○ 3rd capture group.
+ ○ Match a character other than '\n' lazily any number of times.
+○ Match ')' atomically, optionally.
+○ Match if at the end of a line.
+``` \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/RitualProcessor.Object.md b/Documentation/Pf2eDataScrapper/RitualProcessor.Object.md new file mode 100644 index 0000000..1f7e174 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/RitualProcessor.Object.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types').[RitualProcessor](RitualProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.RitualProcessor') + +## RitualProcessor\.Object Property + +Основная сущность\. + +```csharp +public virtual Pf2eModel.Model.Structure.Ritual Object { get; } +``` + +#### Property Value +[Pf2eModel\.Model\.Structure\.Ritual](https://docs.microsoft.com/en-us/dotnet/api/Pf2eModel.Model.Structure.Ritual 'Pf2eModel\.Model\.Structure\.Ritual') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/RitualProcessor.PrimaryRegex1().md b/Documentation/Pf2eDataScrapper/RitualProcessor.PrimaryRegex1().md new file mode 100644 index 0000000..42b420f --- /dev/null +++ b/Documentation/Pf2eDataScrapper/RitualProcessor.PrimaryRegex1().md @@ -0,0 +1,53 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types').[RitualProcessor](RitualProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.RitualProcessor') + +## RitualProcessor\.PrimaryRegex1\(\) Method + +```csharp +private static System.Text.RegularExpressions.Regex PrimaryRegex1(); +``` + +#### Returns +[System\.Text\.RegularExpressions\.Regex](https://docs.microsoft.com/en-us/dotnet/api/System.Text.RegularExpressions.Regex 'System\.Text\.RegularExpressions\.Regex') + +### Remarks +Pattern:
+ +```csharp +^ *\\[\\s*(.*?)\\s*\\]\\((.*?)\\)\\s*([a-z' ]*?)<(.*?)(?:[;,]?\\s*(.*?))?>([a-z' ]*?)$ +```
+Options:
+ +```csharp +RegexOptions.Multiline +```
+Explanation:
+ +```csharp +○ Match if at the beginning of a line.
+○ Match ' ' atomically any number of times.
+○ Match '['.
+○ Match a whitespace character greedily any number of times.
+○ 1st capture group.
+ ○ Match a character other than '\n' lazily any number of times.
+○ Match a whitespace character atomically any number of times.
+○ Match the string "](".
+○ 2nd capture group.
+ ○ Match a character other than '\n' lazily any number of times.
+○ Match ')'.
+○ Match a whitespace character greedily any number of times.
+○ 3rd capture group.
+ ○ Match a character in the set [ 'a-z] atomically any number of times.
+○ Match '<'.
+○ 4th capture group.
+ ○ Match a character other than '\n' lazily any number of times.
+○ Optional (greedy).
+ ○ Match a character in the set [,;] greedily, optionally.
+ ○ Match a whitespace character greedily any number of times.
+ ○ 5th capture group.
+ ○ Match a character other than '\n' lazily any number of times.
+○ Match '>'.
+○ 6th capture group.
+ ○ Match a character in the set [ 'a-z] atomically any number of times.
+○ Match if at the end of a line.
+``` \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/RitualProcessor.PrimaryRegex2().md b/Documentation/Pf2eDataScrapper/RitualProcessor.PrimaryRegex2().md new file mode 100644 index 0000000..45f80e1 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/RitualProcessor.PrimaryRegex2().md @@ -0,0 +1,43 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types').[RitualProcessor](RitualProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.RitualProcessor') + +## RitualProcessor\.PrimaryRegex2\(\) Method + +```csharp +private static System.Text.RegularExpressions.Regex PrimaryRegex2(); +``` + +#### Returns +[System\.Text\.RegularExpressions\.Regex](https://docs.microsoft.com/en-us/dotnet/api/System.Text.RegularExpressions.Regex 'System\.Text\.RegularExpressions\.Regex') + +### Remarks +Pattern:
+ +```csharp +^ *(.*?) *\\[\\s*(.*?)\\s*\\]\\((.*?)\\) *$ +```
+Options:
+ +```csharp +RegexOptions.Multiline +```
+Explanation:
+ +```csharp +○ Match if at the beginning of a line.
+○ Match ' ' greedily any number of times.
+○ 1st capture group.
+ ○ Match a character other than '\n' lazily any number of times.
+○ Match ' ' atomically any number of times.
+○ Match '['.
+○ Match a whitespace character greedily any number of times.
+○ 2nd capture group.
+ ○ Match a character other than '\n' lazily any number of times.
+○ Match a whitespace character atomically any number of times.
+○ Match the string "](".
+○ 3rd capture group.
+ ○ Match a character other than '\n' lazily any number of times.
+○ Match ')'.
+○ Match ' ' atomically any number of times.
+○ Match if at the end of a line.
+``` \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/RitualProcessor.PrimaryRegex3().md b/Documentation/Pf2eDataScrapper/RitualProcessor.PrimaryRegex3().md new file mode 100644 index 0000000..6f6539d --- /dev/null +++ b/Documentation/Pf2eDataScrapper/RitualProcessor.PrimaryRegex3().md @@ -0,0 +1,38 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types').[RitualProcessor](RitualProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.RitualProcessor') + +## RitualProcessor\.PrimaryRegex3\(\) Method + +```csharp +private static System.Text.RegularExpressions.Regex PrimaryRegex3(); +``` + +#### Returns +[System\.Text\.RegularExpressions\.Regex](https://docs.microsoft.com/en-us/dotnet/api/System.Text.RegularExpressions.Regex 'System\.Text\.RegularExpressions\.Regex') + +### Remarks +Pattern:
+ +```csharp +^ *(.*?)\\s*<(.*?)> *$ +```
+Options:
+ +```csharp +RegexOptions.Multiline +```
+Explanation:
+ +```csharp +○ Match if at the beginning of a line.
+○ Match ' ' greedily any number of times.
+○ 1st capture group.
+ ○ Match a character other than '\n' lazily any number of times.
+○ Match a whitespace character atomically any number of times.
+○ Match '<'.
+○ 2nd capture group.
+ ○ Match a character other than '\n' lazily any number of times.
+○ Match '>'.
+○ Match ' ' atomically any number of times.
+○ Match if at the end of a line.
+``` \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/RitualProcessor.Process().md b/Documentation/Pf2eDataScrapper/RitualProcessor.Process().md new file mode 100644 index 0000000..0f1f9a7 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/RitualProcessor.Process().md @@ -0,0 +1,12 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types').[RitualProcessor](RitualProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.RitualProcessor') + +## RitualProcessor\.Process\(\) Method + +Основной метод обработки данных\. + +```csharp +public override void Process(); +``` + +Implements [Process\(\)](IProcessor.Process().md 'Pf2eDataScrapper\.Processors\.Definitions\.IProcessor\.Process\(\)') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/RitualProcessor.Type.md b/Documentation/Pf2eDataScrapper/RitualProcessor.Type.md new file mode 100644 index 0000000..9c6a00a --- /dev/null +++ b/Documentation/Pf2eDataScrapper/RitualProcessor.Type.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types').[RitualProcessor](RitualProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.RitualProcessor') + +## RitualProcessor\.Type Property + +Тип сущности\. + +```csharp +public override Pf2eModel.Model.Enum.EntityType Type { get; } +``` + +#### Property Value +[Pf2eModel\.Model\.Enum\.EntityType](https://docs.microsoft.com/en-us/dotnet/api/Pf2eModel.Model.Enum.EntityType 'Pf2eModel\.Model\.Enum\.EntityType') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/RitualProcessor.md b/Documentation/Pf2eDataScrapper/RitualProcessor.md new file mode 100644 index 0000000..14c5b43 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/RitualProcessor.md @@ -0,0 +1,25 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types') + +## RitualProcessor Class + +```csharp +internal class RitualProcessor : Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.AbstractEntityProcessor +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [AbstractInputProcessor](AbstractInputProcessor.md 'Pf2eDataScrapper\.Processors\.Definitions\.AbstractInputProcessor') 🡒 [AbstractEntityProcessor](AbstractEntityProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.AbstractEntityProcessor') 🡒 RitualProcessor + +| Properties | | +| :--- | :--- | +| [Object](RitualProcessor.Object.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.RitualProcessor\.Object') | Основная сущность\. | +| [Type](RitualProcessor.Type.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.RitualProcessor\.Type') | Тип сущности\. | + +| Methods | | +| :--- | :--- | +| [Add\(\)](RitualProcessor.Add().md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.RitualProcessor\.Add\(\)') | Добавление основной сущности в контекст базы данных\. | +| [AddedDescriptionPaths\(\)](RitualProcessor.AddedDescriptionPaths().md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.RitualProcessor\.AddedDescriptionPaths\(\)') | Получение списка полей, которые должны быть добавлены в описание\. | +| [CasterRegex\(\)](RitualProcessor.CasterRegex().md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.RitualProcessor\.CasterRegex\(\)') | | +| [PrimaryRegex1\(\)](RitualProcessor.PrimaryRegex1().md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.RitualProcessor\.PrimaryRegex1\(\)') | | +| [PrimaryRegex2\(\)](RitualProcessor.PrimaryRegex2().md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.RitualProcessor\.PrimaryRegex2\(\)') | | +| [PrimaryRegex3\(\)](RitualProcessor.PrimaryRegex3().md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.RitualProcessor\.PrimaryRegex3\(\)') | | +| [Process\(\)](RitualProcessor.Process().md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.RitualProcessor\.Process\(\)') | Основной метод обработки данных\. | diff --git a/Documentation/Pf2eDataScrapper/RuleProcessor.Add().md b/Documentation/Pf2eDataScrapper/RuleProcessor.Add().md new file mode 100644 index 0000000..067fd64 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/RuleProcessor.Add().md @@ -0,0 +1,10 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.Rules.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules').[RuleProcessor](RuleProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules\.RuleProcessor') + +## RuleProcessor\.Add\(\) Method + +Добавление основной сущности в контекст базы данных\. + +```csharp +protected override void Add(); +``` \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/RuleProcessor.GetExternal().md b/Documentation/Pf2eDataScrapper/RuleProcessor.GetExternal().md new file mode 100644 index 0000000..c23481d --- /dev/null +++ b/Documentation/Pf2eDataScrapper/RuleProcessor.GetExternal().md @@ -0,0 +1,14 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.Rules.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules').[RuleProcessor](RuleProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules\.RuleProcessor') + +## RuleProcessor\.GetExternal\(\) Method + +Получение внешней ссылки, из которой получено правило\. + +```csharp +private Pf2eModel.Model.Base.Targets.EntityExternal GetExternal(); +``` + +#### Returns +[Pf2eModel\.Model\.Base\.Targets\.EntityExternal](https://docs.microsoft.com/en-us/dotnet/api/Pf2eModel.Model.Base.Targets.EntityExternal 'Pf2eModel\.Model\.Base\.Targets\.EntityExternal') +Внешняя ссылка\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/RuleProcessor.GetSourceId().md b/Documentation/Pf2eDataScrapper/RuleProcessor.GetSourceId().md new file mode 100644 index 0000000..660afff --- /dev/null +++ b/Documentation/Pf2eDataScrapper/RuleProcessor.GetSourceId().md @@ -0,0 +1,14 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.Rules.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules').[RuleProcessor](RuleProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules\.RuleProcessor') + +## RuleProcessor\.GetSourceId\(\) Method + +Получение источника, к которому относится правило\. + +```csharp +private int GetSourceId(); +``` + +#### Returns +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') +Источник, к которому относится правило\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/RuleProcessor.Object.md b/Documentation/Pf2eDataScrapper/RuleProcessor.Object.md new file mode 100644 index 0000000..3e5a4a2 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/RuleProcessor.Object.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.Rules.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules').[RuleProcessor](RuleProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules\.RuleProcessor') + +## RuleProcessor\.Object Property + +Основная сущность\. + +```csharp +public virtual Pf2eModel.Model.Structure.Rule Object { get; } +``` + +#### Property Value +[Pf2eModel\.Model\.Structure\.Rule](https://docs.microsoft.com/en-us/dotnet/api/Pf2eModel.Model.Structure.Rule 'Pf2eModel\.Model\.Structure\.Rule') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/RuleProcessor.Process().md b/Documentation/Pf2eDataScrapper/RuleProcessor.Process().md new file mode 100644 index 0000000..292645a --- /dev/null +++ b/Documentation/Pf2eDataScrapper/RuleProcessor.Process().md @@ -0,0 +1,12 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.Rules.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules').[RuleProcessor](RuleProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules\.RuleProcessor') + +## RuleProcessor\.Process\(\) Method + +Основной метод обработки данных\. + +```csharp +public override void Process(); +``` + +Implements [Process\(\)](IProcessor.Process().md 'Pf2eDataScrapper\.Processors\.Definitions\.IProcessor\.Process\(\)') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/RuleProcessor.Toc.md b/Documentation/Pf2eDataScrapper/RuleProcessor.Toc.md new file mode 100644 index 0000000..935f7b0 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/RuleProcessor.Toc.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.Rules.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules').[RuleProcessor](RuleProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules\.RuleProcessor') + +## RuleProcessor\.Toc Property + +Структура генерации содержания правил\. + +```csharp +public Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.RuleTocCollection Toc { get; } +``` + +#### Property Value +[RuleTocCollection](RuleTocCollection.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocCollection') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/RuleProcessor.Type.md b/Documentation/Pf2eDataScrapper/RuleProcessor.Type.md new file mode 100644 index 0000000..3c8f57d --- /dev/null +++ b/Documentation/Pf2eDataScrapper/RuleProcessor.Type.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.Rules.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules').[RuleProcessor](RuleProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules\.RuleProcessor') + +## RuleProcessor\.Type Property + +Тип сущности\. + +```csharp +public override Pf2eModel.Model.Enum.EntityType Type { get; } +``` + +#### Property Value +[Pf2eModel\.Model\.Enum\.EntityType](https://docs.microsoft.com/en-us/dotnet/api/Pf2eModel.Model.Enum.EntityType 'Pf2eModel\.Model\.Enum\.EntityType') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/RuleProcessor.md b/Documentation/Pf2eDataScrapper/RuleProcessor.md new file mode 100644 index 0000000..770f385 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/RuleProcessor.md @@ -0,0 +1,23 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.Rules.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules') + +## RuleProcessor Class + +```csharp +internal class RuleProcessor : Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.AbstractEntityProcessor +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [AbstractInputProcessor](AbstractInputProcessor.md 'Pf2eDataScrapper\.Processors\.Definitions\.AbstractInputProcessor') 🡒 [AbstractEntityProcessor](AbstractEntityProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.AbstractEntityProcessor') 🡒 RuleProcessor + +| Properties | | +| :--- | :--- | +| [Object](RuleProcessor.Object.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules\.RuleProcessor\.Object') | Основная сущность\. | +| [Toc](RuleProcessor.Toc.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules\.RuleProcessor\.Toc') | Структура генерации содержания правил\. | +| [Type](RuleProcessor.Type.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules\.RuleProcessor\.Type') | Тип сущности\. | + +| Methods | | +| :--- | :--- | +| [Add\(\)](RuleProcessor.Add().md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules\.RuleProcessor\.Add\(\)') | Добавление основной сущности в контекст базы данных\. | +| [GetExternal\(\)](RuleProcessor.GetExternal().md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules\.RuleProcessor\.GetExternal\(\)') | Получение внешней ссылки, из которой получено правило\. | +| [GetSourceId\(\)](RuleProcessor.GetSourceId().md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules\.RuleProcessor\.GetSourceId\(\)') | Получение источника, к которому относится правило\. | +| [Process\(\)](RuleProcessor.Process().md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules\.RuleProcessor\.Process\(\)') | Основной метод обработки данных\. | diff --git a/Documentation/Pf2eDataScrapper/RuleTocBook.Children.md b/Documentation/Pf2eDataScrapper/RuleTocBook.Children.md new file mode 100644 index 0000000..42da202 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/RuleTocBook.Children.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers](Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers').[RuleTocBook](RuleTocBook.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocBook') + +## RuleTocBook\.Children Property + +Список дочерних правил\. + +```csharp +public System.Collections.Generic.List Children { get; } +``` + +#### Property Value +[System\.Collections\.Generic\.List<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.List-1 'System\.Collections\.Generic\.List\`1')[RuleTocItem](RuleTocItem.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocItem')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.List-1 'System\.Collections\.Generic\.List\`1') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/RuleTocBook.Get(string[]).md b/Documentation/Pf2eDataScrapper/RuleTocBook.Get(string[]).md new file mode 100644 index 0000000..847dfa5 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/RuleTocBook.Get(string[]).md @@ -0,0 +1,21 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers](Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers').[RuleTocBook](RuleTocBook.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocBook') + +## RuleTocBook\.Get\(string\[\]\) Method + +Находит элемент по хлебным крошкам\. + +```csharp +public Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.RuleTocItem Get(string[] breadcrumbs); +``` +#### Parameters + + + +`breadcrumbs` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String')[\[\]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System\.Array') + +Массив хлебных крошек, указывающих на путь в дереве\. + +#### Returns +[RuleTocItem](RuleTocItem.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocItem') +[RuleTocItem](RuleTocItem.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocItem') или `null` если элемент не найден\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/RuleTocBook.GetByEntityId(int,RuleTocItem).md b/Documentation/Pf2eDataScrapper/RuleTocBook.GetByEntityId(int,RuleTocItem).md new file mode 100644 index 0000000..4a91f94 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/RuleTocBook.GetByEntityId(int,RuleTocItem).md @@ -0,0 +1,27 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers](Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers').[RuleTocBook](RuleTocBook.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocBook') + +## RuleTocBook\.GetByEntityId\(int, RuleTocItem\) Method + +Находит элемент по идентификатору сущности\. + +```csharp +public Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.RuleTocItem? GetByEntityId(int id, Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.RuleTocItem? node=null); +``` +#### Parameters + + + +`id` [System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') + +Идентификатор сущности\. + + + +`node` [RuleTocItem](RuleTocItem.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocItem') + +Начальный узел для поиска\. + +#### Returns +[RuleTocItem](RuleTocItem.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocItem') +[RuleTocItem](RuleTocItem.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocItem') или `null` если элемент не найден\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/RuleTocBook.IsNameExists(string,RuleTocItem).md b/Documentation/Pf2eDataScrapper/RuleTocBook.IsNameExists(string,RuleTocItem).md new file mode 100644 index 0000000..f5b6893 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/RuleTocBook.IsNameExists(string,RuleTocItem).md @@ -0,0 +1,27 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers](Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers').[RuleTocBook](RuleTocBook.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocBook') + +## RuleTocBook\.IsNameExists\(string, RuleTocItem\) Method + +Проверяет, существует ли имя в текущей книге или дочерних элементах\. + +```csharp +public bool IsNameExists(string name, Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.RuleTocItem? node=null); +``` +#### Parameters + + + +`name` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +Имя для проверки\. + + + +`node` [RuleTocItem](RuleTocItem.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocItem') + +Начальный элемент для поиска\. + +#### Returns +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') +true если имя\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/RuleTocBook.RuleTocBook(Source).md b/Documentation/Pf2eDataScrapper/RuleTocBook.RuleTocBook(Source).md new file mode 100644 index 0000000..02261bc --- /dev/null +++ b/Documentation/Pf2eDataScrapper/RuleTocBook.RuleTocBook(Source).md @@ -0,0 +1,15 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers](Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers').[RuleTocBook](RuleTocBook.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocBook') + +## RuleTocBook\(Source\) Constructor + +Класс представляет собой книгу, содержащую правила\. + +```csharp +public RuleTocBook(Pf2eModel.Model.Base.Source.Source source); +``` +#### Parameters + + + +`source` [Pf2eModel\.Model\.Base\.Source\.Source](https://docs.microsoft.com/en-us/dotnet/api/Pf2eModel.Model.Base.Source.Source 'Pf2eModel\.Model\.Base\.Source\.Source') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/RuleTocBook.SourceId.md b/Documentation/Pf2eDataScrapper/RuleTocBook.SourceId.md new file mode 100644 index 0000000..513ed86 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/RuleTocBook.SourceId.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers](Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers').[RuleTocBook](RuleTocBook.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocBook') + +## RuleTocBook\.SourceId Property + +Идентификатор источника\. + +```csharp +public int SourceId { get; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/RuleTocBook.SourceName.md b/Documentation/Pf2eDataScrapper/RuleTocBook.SourceName.md new file mode 100644 index 0000000..bb6f6e0 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/RuleTocBook.SourceName.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers](Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers').[RuleTocBook](RuleTocBook.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocBook') + +## RuleTocBook\.SourceName Property + +Названия источника\. + +```csharp +public string SourceName { get; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/RuleTocBook.ToString().md b/Documentation/Pf2eDataScrapper/RuleTocBook.ToString().md new file mode 100644 index 0000000..f607f7c --- /dev/null +++ b/Documentation/Pf2eDataScrapper/RuleTocBook.ToString().md @@ -0,0 +1,14 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers](Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers').[RuleTocBook](RuleTocBook.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocBook') + +## RuleTocBook\.ToString\(\) Method + +Возвращает строковое представление книги в файле YAML\. + +```csharp +public override string ToString(); +``` + +#### Returns +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') +Строковое представление книги\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/RuleTocBook.md b/Documentation/Pf2eDataScrapper/RuleTocBook.md new file mode 100644 index 0000000..1581eec --- /dev/null +++ b/Documentation/Pf2eDataScrapper/RuleTocBook.md @@ -0,0 +1,29 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers](Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers') + +## RuleTocBook Class + +Класс представляет собой книгу, содержащую правила\. + +```csharp +internal class RuleTocBook +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 RuleTocBook + +| Constructors | | +| :--- | :--- | +| [RuleTocBook\(Source\)](RuleTocBook.RuleTocBook(Source).md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocBook\.RuleTocBook\(Pf2eModel\.Model\.Base\.Source\.Source\)') | Класс представляет собой книгу, содержащую правила\. | + +| Properties | | +| :--- | :--- | +| [Children](RuleTocBook.Children.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocBook\.Children') | Список дочерних правил\. | +| [SourceId](RuleTocBook.SourceId.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocBook\.SourceId') | Идентификатор источника\. | +| [SourceName](RuleTocBook.SourceName.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocBook\.SourceName') | Названия источника\. | + +| Methods | | +| :--- | :--- | +| [Get\(string\[\]\)](RuleTocBook.Get(string[]).md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocBook\.Get\(string\[\]\)') | Находит элемент по хлебным крошкам\. | +| [GetByEntityId\(int, RuleTocItem\)](RuleTocBook.GetByEntityId(int,RuleTocItem).md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocBook\.GetByEntityId\(int, Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocItem\)') | Находит элемент по идентификатору сущности\. | +| [IsNameExists\(string, RuleTocItem\)](RuleTocBook.IsNameExists(string,RuleTocItem).md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocBook\.IsNameExists\(string, Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocItem\)') | Проверяет, существует ли имя в текущей книге или дочерних элементах\. | +| [ToString\(\)](RuleTocBook.ToString().md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocBook\.ToString\(\)') | Возвращает строковое представление книги в файле YAML\. | diff --git a/Documentation/Pf2eDataScrapper/RuleTocCollection.Books.md b/Documentation/Pf2eDataScrapper/RuleTocCollection.Books.md new file mode 100644 index 0000000..76004e8 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/RuleTocCollection.Books.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers](Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers').[RuleTocCollection](RuleTocCollection.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocCollection') + +## RuleTocCollection\.Books Property + +Список книг, содержащих правила\. + +```csharp +public System.Collections.Generic.List Books { get; } +``` + +#### Property Value +[System\.Collections\.Generic\.List<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.List-1 'System\.Collections\.Generic\.List\`1')[RuleTocBook](RuleTocBook.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocBook')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.List-1 'System\.Collections\.Generic\.List\`1') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/RuleTocCollection.FindEntityId(int).md b/Documentation/Pf2eDataScrapper/RuleTocCollection.FindEntityId(int).md new file mode 100644 index 0000000..7720f11 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/RuleTocCollection.FindEntityId(int).md @@ -0,0 +1,18 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers](Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers').[RuleTocCollection](RuleTocCollection.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocCollection') + +## RuleTocCollection\.FindEntityId\(int\) Method + +Поиск правила по идентификатору\. + +```csharp +public Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.RuleTocItem? FindEntityId(int id); +``` +#### Parameters + + + +`id` [System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') + +#### Returns +[RuleTocItem](RuleTocItem.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocItem') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/RuleTocCollection.FindName(string).md b/Documentation/Pf2eDataScrapper/RuleTocCollection.FindName(string).md new file mode 100644 index 0000000..2fe70f9 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/RuleTocCollection.FindName(string).md @@ -0,0 +1,18 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers](Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers').[RuleTocCollection](RuleTocCollection.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocCollection') + +## RuleTocCollection\.FindName\(string\) Method + +Поиск книги по имени\. + +```csharp +public Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.RuleTocBook? FindName(string name); +``` +#### Parameters + + + +`name` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +#### Returns +[RuleTocBook](RuleTocBook.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocBook') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/RuleTocCollection.Instance.md b/Documentation/Pf2eDataScrapper/RuleTocCollection.Instance.md new file mode 100644 index 0000000..865a67f --- /dev/null +++ b/Documentation/Pf2eDataScrapper/RuleTocCollection.Instance.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers](Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers').[RuleTocCollection](RuleTocCollection.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocCollection') + +## RuleTocCollection\.Instance Property + +Экземпляр класса [RuleTocCollection](RuleTocCollection.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocCollection')\. + +```csharp +public static Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.RuleTocCollection Instance { get; } +``` + +#### Property Value +[RuleTocCollection](RuleTocCollection.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocCollection') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/RuleTocCollection.SaveFile().md b/Documentation/Pf2eDataScrapper/RuleTocCollection.SaveFile().md new file mode 100644 index 0000000..1c4aad4 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/RuleTocCollection.SaveFile().md @@ -0,0 +1,10 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers](Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers').[RuleTocCollection](RuleTocCollection.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocCollection') + +## RuleTocCollection\.SaveFile\(\) Method + +Сохраняет коллекцию в файле YAML\. + +```csharp +public void SaveFile(); +``` \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/RuleTocCollection.ToString().md b/Documentation/Pf2eDataScrapper/RuleTocCollection.ToString().md new file mode 100644 index 0000000..c4ba0e4 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/RuleTocCollection.ToString().md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers](Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers').[RuleTocCollection](RuleTocCollection.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocCollection') + +## RuleTocCollection\.ToString\(\) Method + +Возвращает строковое представление коллекции в файле YAML\. + +```csharp +public override string ToString(); +``` + +#### Returns +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/RuleTocCollection.md b/Documentation/Pf2eDataScrapper/RuleTocCollection.md new file mode 100644 index 0000000..53f0a3f --- /dev/null +++ b/Documentation/Pf2eDataScrapper/RuleTocCollection.md @@ -0,0 +1,27 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers](Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers') + +## RuleTocCollection Class + +Класс коллекции книг, содержащих правила\. +Реализует шаблон `Singleton`\. + +```csharp +internal class RuleTocCollection +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 RuleTocCollection + +| Properties | | +| :--- | :--- | +| [Books](RuleTocCollection.Books.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocCollection\.Books') | Список книг, содержащих правила\. | +| [Instance](RuleTocCollection.Instance.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocCollection\.Instance') | Экземпляр класса [RuleTocCollection](RuleTocCollection.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocCollection')\. | +| [this\[int\]](RuleTocCollection.this[int].md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocCollection\.this\[int\]') | Поиск книги по числовому идентификатору\. | +| [this\[Source\]](RuleTocCollection.this[Source].md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocCollection\.this\[Pf2eModel\.Model\.Base\.Source\.Source\]') | Поиск книги по CLR\-представлению источника\. | + +| Methods | | +| :--- | :--- | +| [FindEntityId\(int\)](RuleTocCollection.FindEntityId(int).md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocCollection\.FindEntityId\(int\)') | Поиск правила по идентификатору\. | +| [FindName\(string\)](RuleTocCollection.FindName(string).md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocCollection\.FindName\(string\)') | Поиск книги по имени\. | +| [SaveFile\(\)](RuleTocCollection.SaveFile().md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocCollection\.SaveFile\(\)') | Сохраняет коллекцию в файле YAML\. | +| [ToString\(\)](RuleTocCollection.ToString().md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocCollection\.ToString\(\)') | Возвращает строковое представление коллекции в файле YAML\. | diff --git a/Documentation/Pf2eDataScrapper/RuleTocCollection.this[Source].md b/Documentation/Pf2eDataScrapper/RuleTocCollection.this[Source].md new file mode 100644 index 0000000..dbeb2d8 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/RuleTocCollection.this[Source].md @@ -0,0 +1,18 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers](Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers').[RuleTocCollection](RuleTocCollection.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocCollection') + +## RuleTocCollection\.this\[Source\] Property + +Поиск книги по CLR\-представлению источника\. + +```csharp +public Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.RuleTocBook this[Pf2eModel.Model.Base.Source.Source source] { get; } +``` +#### Parameters + + + +`source` [Pf2eModel\.Model\.Base\.Source\.Source](https://docs.microsoft.com/en-us/dotnet/api/Pf2eModel.Model.Base.Source.Source 'Pf2eModel\.Model\.Base\.Source\.Source') + +#### Property Value +[RuleTocBook](RuleTocBook.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocBook') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/RuleTocCollection.this[int].md b/Documentation/Pf2eDataScrapper/RuleTocCollection.this[int].md new file mode 100644 index 0000000..d0f065c --- /dev/null +++ b/Documentation/Pf2eDataScrapper/RuleTocCollection.this[int].md @@ -0,0 +1,18 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers](Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers').[RuleTocCollection](RuleTocCollection.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocCollection') + +## RuleTocCollection\.this\[int\] Property + +Поиск книги по числовому идентификатору\. + +```csharp +public Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.RuleTocBook this[int id] { get; } +``` +#### Parameters + + + +`id` [System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') + +#### Property Value +[RuleTocBook](RuleTocBook.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocBook') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/RuleTocItem.Children.md b/Documentation/Pf2eDataScrapper/RuleTocItem.Children.md new file mode 100644 index 0000000..49af14b --- /dev/null +++ b/Documentation/Pf2eDataScrapper/RuleTocItem.Children.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers](Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers').[RuleTocItem](RuleTocItem.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocItem') + +## RuleTocItem\.Children Property + +Коллекция дочерних элементов\. + +```csharp +public System.Collections.Generic.List Children { get; } +``` + +#### Property Value +[System\.Collections\.Generic\.List<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.List-1 'System\.Collections\.Generic\.List\`1')[RuleTocItem](RuleTocItem.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocItem')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.List-1 'System\.Collections\.Generic\.List\`1') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/RuleTocItem.ChildrenOrder.md b/Documentation/Pf2eDataScrapper/RuleTocItem.ChildrenOrder.md new file mode 100644 index 0000000..1ba684d --- /dev/null +++ b/Documentation/Pf2eDataScrapper/RuleTocItem.ChildrenOrder.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers](Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers').[RuleTocItem](RuleTocItem.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocItem') + +## RuleTocItem\.ChildrenOrder Property + +Порядок дочерних элементов\. + +```csharp +public System.Collections.Generic.List? ChildrenOrder { get; set; } +``` + +#### Property Value +[System\.Collections\.Generic\.List<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.List-1 'System\.Collections\.Generic\.List\`1')[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.List-1 'System\.Collections\.Generic\.List\`1') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/RuleTocItem.FirstChildId.md b/Documentation/Pf2eDataScrapper/RuleTocItem.FirstChildId.md new file mode 100644 index 0000000..475d27b --- /dev/null +++ b/Documentation/Pf2eDataScrapper/RuleTocItem.FirstChildId.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers](Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers').[RuleTocItem](RuleTocItem.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocItem') + +## RuleTocItem\.FirstChildId Property + +Идентификатор первого дочернего элемента\. + +```csharp +public string? FirstChildId { get; set; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/RuleTocItem.Indent.md b/Documentation/Pf2eDataScrapper/RuleTocItem.Indent.md new file mode 100644 index 0000000..dd01c82 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/RuleTocItem.Indent.md @@ -0,0 +1,57 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers](Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers').[RuleTocItem](RuleTocItem.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocItem') + +## RuleTocItem\.Indent Method + +| Overloads | | +| :--- | :--- | +| [Indent\(int\)](RuleTocItem.Indent.md#Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.RuleTocItem.Indent(int) 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocItem\.Indent\(int\)') | Увеличение отступа строкового представления элемента содержания в файле YAML\. | +| [Indent\(string\)](RuleTocItem.Indent.md#Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.RuleTocItem.Indent(string) 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocItem\.Indent\(string\)') | Увеличение отступа строки\. | + + + +## RuleTocItem\.Indent\(int\) Method + +Увеличение отступа строкового представления элемента содержания в файле YAML\. + +```csharp +public string Indent(int amount=1); +``` +#### Parameters + + + +`amount` [System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') + +Количество отступов\. + +#### Returns +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') +Строковое представление элемента содержания с отступом\. + +### See Also +- [Tab](RuleTocItem.Tab.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocItem\.Tab') + + + +## RuleTocItem\.Indent\(string\) Method + +Увеличение отступа строки\. + +```csharp +public static string Indent(string str); +``` +#### Parameters + + + +`str` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +Входная строка\. + +#### Returns +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') +Строка с отступом\. + +### See Also +- [Tab](RuleTocItem.Tab.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocItem\.Tab') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/RuleTocItem.IsHandled.md b/Documentation/Pf2eDataScrapper/RuleTocItem.IsHandled.md new file mode 100644 index 0000000..5bf9c3a --- /dev/null +++ b/Documentation/Pf2eDataScrapper/RuleTocItem.IsHandled.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers](Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers').[RuleTocItem](RuleTocItem.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocItem') + +## RuleTocItem\.IsHandled Property + +Указывает, что элемент обрабатывается\. + +```csharp +public bool IsHandled { get; set; } +``` + +#### Property Value +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/RuleTocItem.LastChildId.md b/Documentation/Pf2eDataScrapper/RuleTocItem.LastChildId.md new file mode 100644 index 0000000..d71f9d0 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/RuleTocItem.LastChildId.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers](Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers').[RuleTocItem](RuleTocItem.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocItem') + +## RuleTocItem\.LastChildId Property + +Идентификатор последнего дочернего элемента\. + +```csharp +public string? LastChildId { get; set; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/RuleTocItem.Name.md b/Documentation/Pf2eDataScrapper/RuleTocItem.Name.md new file mode 100644 index 0000000..2d7c176 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/RuleTocItem.Name.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers](Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers').[RuleTocItem](RuleTocItem.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocItem') + +## RuleTocItem\.Name Property + +Имя элемента\. + +```csharp +public string Name { get; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/RuleTocItem.NextId.md b/Documentation/Pf2eDataScrapper/RuleTocItem.NextId.md new file mode 100644 index 0000000..3b03818 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/RuleTocItem.NextId.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers](Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers').[RuleTocItem](RuleTocItem.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocItem') + +## RuleTocItem\.NextId Property + +Следующий идентификатор\. + +```csharp +public string? NextId { get; set; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/RuleTocItem.Parent.md b/Documentation/Pf2eDataScrapper/RuleTocItem.Parent.md new file mode 100644 index 0000000..c755c3f --- /dev/null +++ b/Documentation/Pf2eDataScrapper/RuleTocItem.Parent.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers](Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers').[RuleTocItem](RuleTocItem.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocItem') + +## RuleTocItem\.Parent Property + +Родительский элемент дерева\. + +```csharp +public Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.RuleTocItem? Parent { get; } +``` + +#### Property Value +[RuleTocItem](RuleTocItem.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocItem') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/RuleTocItem.PreviousId.md b/Documentation/Pf2eDataScrapper/RuleTocItem.PreviousId.md new file mode 100644 index 0000000..32e66a6 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/RuleTocItem.PreviousId.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers](Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers').[RuleTocItem](RuleTocItem.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocItem') + +## RuleTocItem\.PreviousId Property + +Предыдущий идентификатор\. + +```csharp +public string? PreviousId { get; set; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/RuleTocItem.RuleId.md b/Documentation/Pf2eDataScrapper/RuleTocItem.RuleId.md new file mode 100644 index 0000000..899f711 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/RuleTocItem.RuleId.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers](Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers').[RuleTocItem](RuleTocItem.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocItem') + +## RuleTocItem\.RuleId Property + +Идентификатор правила\. + +```csharp +public System.Nullable RuleId { get; set; } +``` + +#### Property Value +[System\.Nullable<](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System\.Nullable\`1')[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System\.Nullable\`1') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/RuleTocItem.RuleTocItem(string,RuleTocItem).md b/Documentation/Pf2eDataScrapper/RuleTocItem.RuleTocItem(string,RuleTocItem).md new file mode 100644 index 0000000..ae898ed --- /dev/null +++ b/Documentation/Pf2eDataScrapper/RuleTocItem.RuleTocItem(string,RuleTocItem).md @@ -0,0 +1,19 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers](Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers').[RuleTocItem](RuleTocItem.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocItem') + +## RuleTocItem\(string, RuleTocItem\) Constructor + +Класс представляет собой элемент дерева правил\. + +```csharp +public RuleTocItem(string name, Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.RuleTocItem? parent); +``` +#### Parameters + + + +`name` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + + + +`parent` [RuleTocItem](RuleTocItem.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocItem') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/RuleTocItem.Tab.md b/Documentation/Pf2eDataScrapper/RuleTocItem.Tab.md new file mode 100644 index 0000000..1d42273 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/RuleTocItem.Tab.md @@ -0,0 +1,17 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers](Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers').[RuleTocItem](RuleTocItem.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocItem') + +## RuleTocItem\.Tab Field + +Строка отступа строки\. + +```csharp +public const string Tab = " "; +``` + +#### Field Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +### See Also +- [Indent\(int\)](RuleTocItem.Indent.md#Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.RuleTocItem.Indent(int) 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocItem\.Indent\(int\)') +- [Indent\(string\)](RuleTocItem.Indent.md#Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.RuleTocItem.Indent(string) 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocItem\.Indent\(string\)') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/RuleTocItem.ToString().md b/Documentation/Pf2eDataScrapper/RuleTocItem.ToString().md new file mode 100644 index 0000000..1bbdc53 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/RuleTocItem.ToString().md @@ -0,0 +1,14 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers](Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers').[RuleTocItem](RuleTocItem.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocItem') + +## RuleTocItem\.ToString\(\) Method + +Возвращает строковое представление элемента содержания в файле YAML\. + +```csharp +public override string ToString(); +``` + +#### Returns +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') +Строковое представление элемента содержания\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/RuleTocItem.md b/Documentation/Pf2eDataScrapper/RuleTocItem.md new file mode 100644 index 0000000..ae3d60d --- /dev/null +++ b/Documentation/Pf2eDataScrapper/RuleTocItem.md @@ -0,0 +1,39 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers](Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers') + +## RuleTocItem Class + +Класс представляет собой элемент дерева правил\. + +```csharp +internal class RuleTocItem +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 RuleTocItem + +| Constructors | | +| :--- | :--- | +| [RuleTocItem\(string, RuleTocItem\)](RuleTocItem.RuleTocItem(string,RuleTocItem).md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocItem\.RuleTocItem\(string, Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocItem\)') | Класс представляет собой элемент дерева правил\. | + +| Fields | | +| :--- | :--- | +| [Tab](RuleTocItem.Tab.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocItem\.Tab') | Строка отступа строки\. | + +| Properties | | +| :--- | :--- | +| [Children](RuleTocItem.Children.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocItem\.Children') | Коллекция дочерних элементов\. | +| [ChildrenOrder](RuleTocItem.ChildrenOrder.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocItem\.ChildrenOrder') | Порядок дочерних элементов\. | +| [FirstChildId](RuleTocItem.FirstChildId.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocItem\.FirstChildId') | Идентификатор первого дочернего элемента\. | +| [IsHandled](RuleTocItem.IsHandled.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocItem\.IsHandled') | Указывает, что элемент обрабатывается\. | +| [LastChildId](RuleTocItem.LastChildId.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocItem\.LastChildId') | Идентификатор последнего дочернего элемента\. | +| [Name](RuleTocItem.Name.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocItem\.Name') | Имя элемента\. | +| [NextId](RuleTocItem.NextId.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocItem\.NextId') | Следующий идентификатор\. | +| [Parent](RuleTocItem.Parent.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocItem\.Parent') | Родительский элемент дерева\. | +| [PreviousId](RuleTocItem.PreviousId.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocItem\.PreviousId') | Предыдущий идентификатор\. | +| [RuleId](RuleTocItem.RuleId.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocItem\.RuleId') | Идентификатор правила\. | + +| Methods | | +| :--- | :--- | +| [Indent\(int\)](RuleTocItem.Indent.md#Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.RuleTocItem.Indent(int) 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocItem\.Indent\(int\)') | Увеличение отступа строкового представления элемента содержания в файле YAML\. | +| [Indent\(string\)](RuleTocItem.Indent.md#Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.RuleTocItem.Indent(string) 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocItem\.Indent\(string\)') | Увеличение отступа строки\. | +| [ToString\(\)](RuleTocItem.ToString().md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocItem\.ToString\(\)') | Возвращает строковое представление элемента содержания в файле YAML\. | diff --git a/Documentation/Pf2eDataScrapper/RulesOrderProcessor.AddOrderItem(int,int,Nullable_int_).md b/Documentation/Pf2eDataScrapper/RulesOrderProcessor.AddOrderItem(int,int,Nullable_int_).md new file mode 100644 index 0000000..7c4c9ee --- /dev/null +++ b/Documentation/Pf2eDataScrapper/RulesOrderProcessor.AddOrderItem(int,int,Nullable_int_).md @@ -0,0 +1,29 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.Rules.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules').[RulesOrderProcessor](RulesOrderProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules\.RulesOrderProcessor') + +## RulesOrderProcessor\.AddOrderItem\(int, int, Nullable\\) Method + +Добавление элемента содержания\. + +```csharp +private void AddOrderItem(int id, int order, System.Nullable parentId); +``` +#### Parameters + + + +`id` [System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') + +Идентификатор правила\. + + + +`order` [System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') + +Порядок правила\. + + + +`parentId` [System\.Nullable<](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System\.Nullable\`1')[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System\.Nullable\`1') + +Идентификатор главы, в которой находится глава\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/RulesOrderProcessor.BuildIdOrderDictionary.md b/Documentation/Pf2eDataScrapper/RulesOrderProcessor.BuildIdOrderDictionary.md new file mode 100644 index 0000000..780b85f --- /dev/null +++ b/Documentation/Pf2eDataScrapper/RulesOrderProcessor.BuildIdOrderDictionary.md @@ -0,0 +1,43 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.Rules.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules').[RulesOrderProcessor](RulesOrderProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules\.RulesOrderProcessor') + +## RulesOrderProcessor\.BuildIdOrderDictionary Method + +| Overloads | | +| :--- | :--- | +| [BuildIdOrderDictionary\(RuleTocItem\)](RulesOrderProcessor.BuildIdOrderDictionary.md#Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.Rules.RulesOrderProcessor.BuildIdOrderDictionary(Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.RuleTocItem) 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules\.RulesOrderProcessor\.BuildIdOrderDictionary\(Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocItem\)') | Построение списка записей о порядке правил из дочерних элементов содержания\. | +| [BuildIdOrderDictionary\(List<RuleTocItem>\)](RulesOrderProcessor.BuildIdOrderDictionary.md#Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.Rules.RulesOrderProcessor.BuildIdOrderDictionary(System.Collections.Generic.List_Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.RuleTocItem_) 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules\.RulesOrderProcessor\.BuildIdOrderDictionary\(System\.Collections\.Generic\.List\\)') | Построение списка записей о порядке правил из списка элементов содержания\. | + + + +## RulesOrderProcessor\.BuildIdOrderDictionary\(RuleTocItem\) Method + +Построение списка записей о порядке правил из дочерних элементов содержания\. + +```csharp +private void BuildIdOrderDictionary(Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.RuleTocItem item); +``` +#### Parameters + + + +`item` [RuleTocItem](RuleTocItem.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocItem') + +Элемент содержания, дочерние элементы которого необходимо обработать\. + + + +## RulesOrderProcessor\.BuildIdOrderDictionary\(List\\) Method + +Построение списка записей о порядке правил из списка элементов содержания\. + +```csharp +private void BuildIdOrderDictionary(System.Collections.Generic.List items); +``` +#### Parameters + + + +`items` [System\.Collections\.Generic\.List<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.List-1 'System\.Collections\.Generic\.List\`1')[RuleTocItem](RuleTocItem.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocItem')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.List-1 'System\.Collections\.Generic\.List\`1') + +Список элементов содержания для обработки\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/RulesOrderProcessor.OrderItem.Id.md b/Documentation/Pf2eDataScrapper/RulesOrderProcessor.OrderItem.Id.md new file mode 100644 index 0000000..79da1f6 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/RulesOrderProcessor.OrderItem.Id.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.Rules.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules').[RulesOrderProcessor](RulesOrderProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules\.RulesOrderProcessor').[OrderItem](RulesOrderProcessor.OrderItem.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules\.RulesOrderProcessor\.OrderItem') + +## RulesOrderProcessor\.OrderItem\.Id Property + +Идентификатор правила\. + +```csharp +public int Id { get; init; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/RulesOrderProcessor.OrderItem.Order.md b/Documentation/Pf2eDataScrapper/RulesOrderProcessor.OrderItem.Order.md new file mode 100644 index 0000000..1456b57 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/RulesOrderProcessor.OrderItem.Order.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.Rules.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules').[RulesOrderProcessor](RulesOrderProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules\.RulesOrderProcessor').[OrderItem](RulesOrderProcessor.OrderItem.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules\.RulesOrderProcessor\.OrderItem') + +## RulesOrderProcessor\.OrderItem\.Order Property + +Порядок правила\. + +```csharp +public int Order { get; init; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/RulesOrderProcessor.OrderItem.ParentId.md b/Documentation/Pf2eDataScrapper/RulesOrderProcessor.OrderItem.ParentId.md new file mode 100644 index 0000000..b25d3b9 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/RulesOrderProcessor.OrderItem.ParentId.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.Rules.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules').[RulesOrderProcessor](RulesOrderProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules\.RulesOrderProcessor').[OrderItem](RulesOrderProcessor.OrderItem.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules\.RulesOrderProcessor\.OrderItem') + +## RulesOrderProcessor\.OrderItem\.ParentId Property + +Идентификатор главы, в которой находится глава\. + +```csharp +public System.Nullable ParentId { get; init; } +``` + +#### Property Value +[System\.Nullable<](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System\.Nullable\`1')[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System\.Nullable\`1') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/RulesOrderProcessor.OrderItem.md b/Documentation/Pf2eDataScrapper/RulesOrderProcessor.OrderItem.md new file mode 100644 index 0000000..9de940f --- /dev/null +++ b/Documentation/Pf2eDataScrapper/RulesOrderProcessor.OrderItem.md @@ -0,0 +1,20 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.Rules.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules').[RulesOrderProcessor](RulesOrderProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules\.RulesOrderProcessor') + +## RulesOrderProcessor\.OrderItem Class + +Запись, указывающая порядок правила в своей главе\. + +```csharp +private record RulesOrderProcessor.OrderItem : System.IEquatable +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 OrderItem + +Implements [System\.IEquatable<](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System\.IEquatable\`1')[OrderItem](RulesOrderProcessor.OrderItem.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules\.RulesOrderProcessor\.OrderItem')[>](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System\.IEquatable\`1') + +| Properties | | +| :--- | :--- | +| [Id](RulesOrderProcessor.OrderItem.Id.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules\.RulesOrderProcessor\.OrderItem\.Id') | Идентификатор правила\. | +| [Order](RulesOrderProcessor.OrderItem.Order.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules\.RulesOrderProcessor\.OrderItem\.Order') | Порядок правила\. | +| [ParentId](RulesOrderProcessor.OrderItem.ParentId.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules\.RulesOrderProcessor\.OrderItem\.ParentId') | Идентификатор главы, в которой находится глава\. | diff --git a/Documentation/Pf2eDataScrapper/RulesOrderProcessor.Process.md b/Documentation/Pf2eDataScrapper/RulesOrderProcessor.Process.md new file mode 100644 index 0000000..0f02a69 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/RulesOrderProcessor.Process.md @@ -0,0 +1,36 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.Rules.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules').[RulesOrderProcessor](RulesOrderProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules\.RulesOrderProcessor') + +## RulesOrderProcessor\.Process Method + +| Overloads | | +| :--- | :--- | +| [Process\(\)](RulesOrderProcessor.Process.md#Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.Rules.RulesOrderProcessor.Process() 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules\.RulesOrderProcessor\.Process\(\)') | Основной метод обработки данных\. | +| [Process\(Rule\)](RulesOrderProcessor.Process.md#Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.Rules.RulesOrderProcessor.Process(Pf2eModel.Model.Structure.Rule) 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules\.RulesOrderProcessor\.Process\(Pf2eModel\.Model\.Structure\.Rule\)') | Обработка конкретного правила\. | + + + +## RulesOrderProcessor\.Process\(\) Method + +Основной метод обработки данных\. + +```csharp +public void Process(); +``` + +Implements [Process\(\)](IProcessor.Process().md 'Pf2eDataScrapper\.Processors\.Definitions\.IProcessor\.Process\(\)') + + + +## RulesOrderProcessor\.Process\(Rule\) Method + +Обработка конкретного правила\. + +```csharp +private void Process(Pf2eModel.Model.Structure.Rule rule); +``` +#### Parameters + + + +`rule` [Pf2eModel\.Model\.Structure\.Rule](https://docs.microsoft.com/en-us/dotnet/api/Pf2eModel.Model.Structure.Rule 'Pf2eModel\.Model\.Structure\.Rule') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/RulesOrderProcessor.Save().md b/Documentation/Pf2eDataScrapper/RulesOrderProcessor.Save().md new file mode 100644 index 0000000..b76664a --- /dev/null +++ b/Documentation/Pf2eDataScrapper/RulesOrderProcessor.Save().md @@ -0,0 +1,12 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.Rules.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules').[RulesOrderProcessor](RulesOrderProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules\.RulesOrderProcessor') + +## RulesOrderProcessor\.Save\(\) Method + +Метод для сохранения изменений в базе данных\. + +```csharp +public void Save(); +``` + +Implements [Save\(\)](IProcessor.Save().md 'Pf2eDataScrapper\.Processors\.Definitions\.IProcessor\.Save\(\)') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/RulesOrderProcessor.Toc.md b/Documentation/Pf2eDataScrapper/RulesOrderProcessor.Toc.md new file mode 100644 index 0000000..0d8c951 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/RulesOrderProcessor.Toc.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.Rules.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules').[RulesOrderProcessor](RulesOrderProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules\.RulesOrderProcessor') + +## RulesOrderProcessor\.Toc Field + +Структура генерации содержания правил\. + +```csharp +public readonly RuleTocCollection Toc; +``` + +#### Field Value +[RuleTocCollection](RuleTocCollection.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocCollection') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/RulesOrderProcessor._orderItems.md b/Documentation/Pf2eDataScrapper/RulesOrderProcessor._orderItems.md new file mode 100644 index 0000000..f79c6a8 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/RulesOrderProcessor._orderItems.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.Rules.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules').[RulesOrderProcessor](RulesOrderProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules\.RulesOrderProcessor') + +## RulesOrderProcessor\.\_orderItems Field + +Список записей о порядке правил в своих главах\. + +```csharp +private readonly List _orderItems; +``` + +#### Field Value +[System\.Collections\.Generic\.List<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.List-1 'System\.Collections\.Generic\.List\`1')[OrderItem](RulesOrderProcessor.OrderItem.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules\.RulesOrderProcessor\.OrderItem')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.List-1 'System\.Collections\.Generic\.List\`1') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/RulesOrderProcessor.md b/Documentation/Pf2eDataScrapper/RulesOrderProcessor.md new file mode 100644 index 0000000..0b54781 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/RulesOrderProcessor.md @@ -0,0 +1,26 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.Rules.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules') + +## RulesOrderProcessor Class + +```csharp +internal class RulesOrderProcessor : Pf2eDataScrapper.Processors.Definitions.IProcessor +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 RulesOrderProcessor + +Implements [IProcessor](IProcessor.md 'Pf2eDataScrapper\.Processors\.Definitions\.IProcessor') + +| Fields | | +| :--- | :--- | +| [\_orderItems](RulesOrderProcessor._orderItems.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules\.RulesOrderProcessor\.\_orderItems') | Список записей о порядке правил в своих главах\. | +| [Toc](RulesOrderProcessor.Toc.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules\.RulesOrderProcessor\.Toc') | Структура генерации содержания правил\. | + +| Methods | | +| :--- | :--- | +| [AddOrderItem\(int, int, Nullable<int>\)](RulesOrderProcessor.AddOrderItem(int,int,Nullable_int_).md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules\.RulesOrderProcessor\.AddOrderItem\(int, int, System\.Nullable\\)') | Добавление элемента содержания\. | +| [BuildIdOrderDictionary\(RuleTocItem\)](RulesOrderProcessor.BuildIdOrderDictionary.md#Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.Rules.RulesOrderProcessor.BuildIdOrderDictionary(Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.RuleTocItem) 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules\.RulesOrderProcessor\.BuildIdOrderDictionary\(Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocItem\)') | Построение списка записей о порядке правил из дочерних элементов содержания\. | +| [BuildIdOrderDictionary\(List<RuleTocItem>\)](RulesOrderProcessor.BuildIdOrderDictionary.md#Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.Rules.RulesOrderProcessor.BuildIdOrderDictionary(System.Collections.Generic.List_Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.RuleTocItem_) 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules\.RulesOrderProcessor\.BuildIdOrderDictionary\(System\.Collections\.Generic\.List\\)') | Построение списка записей о порядке правил из списка элементов содержания\. | +| [Process\(\)](RulesOrderProcessor.Process.md#Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.Rules.RulesOrderProcessor.Process() 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules\.RulesOrderProcessor\.Process\(\)') | Основной метод обработки данных\. | +| [Process\(Rule\)](RulesOrderProcessor.Process.md#Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.Rules.RulesOrderProcessor.Process(Pf2eModel.Model.Structure.Rule) 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules\.RulesOrderProcessor\.Process\(Pf2eModel\.Model\.Structure\.Rule\)') | Обработка конкретного правила\. | +| [Save\(\)](RulesOrderProcessor.Save().md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules\.RulesOrderProcessor\.Save\(\)') | Метод для сохранения изменений в базе данных\. | diff --git a/Documentation/Pf2eDataScrapper/RulesTocProcessor.DownloadPage().md b/Documentation/Pf2eDataScrapper/RulesTocProcessor.DownloadPage().md new file mode 100644 index 0000000..e1da707 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/RulesTocProcessor.DownloadPage().md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.Rules.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules').[RulesTocProcessor](RulesTocProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules\.RulesTocProcessor') + +## RulesTocProcessor\.DownloadPage\(\) Method + +Скачивание страницы, указанной в [Url](RulesTocProcessor.Url.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules\.RulesTocProcessor\.Url'), и получение очищенного элемента, указанного в [Selector](RulesTocProcessor.Selector.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules\.RulesTocProcessor\.Selector')\. + +```csharp +private AngleSharp.Dom.IDocument DownloadPage(); +``` + +#### Returns +[AngleSharp\.Dom\.IDocument](https://docs.microsoft.com/en-us/dotnet/api/AngleSharp.Dom.IDocument 'AngleSharp\.Dom\.IDocument') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/RulesTocProcessor.LinkRegex().md b/Documentation/Pf2eDataScrapper/RulesTocProcessor.LinkRegex().md new file mode 100644 index 0000000..20416da --- /dev/null +++ b/Documentation/Pf2eDataScrapper/RulesTocProcessor.LinkRegex().md @@ -0,0 +1,29 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.Rules.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules').[RulesTocProcessor](RulesTocProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules\.RulesTocProcessor') + +## RulesTocProcessor\.LinkRegex\(\) Method + +```csharp +public static System.Text.RegularExpressions.Regex LinkRegex(); +``` + +#### Returns +[System\.Text\.RegularExpressions\.Regex](https://docs.microsoft.com/en-us/dotnet/api/System.Text.RegularExpressions.Regex 'System\.Text\.RegularExpressions\.Regex') + +### Remarks +Pattern:
+ +```csharp +(.*?) +```
+Explanation:
+ +```csharp +○ Match the string " +○ 1st capture group.
+ ○ Match a Unicode digit atomically at least once.
+○ Match the string "\">".
+○ 2nd capture group.
+ ○ Match a character other than '\n' lazily any number of times.
+○ Match the string "".
+``` \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/RulesTocProcessor.ParseLink(string,RuleTocItem).md b/Documentation/Pf2eDataScrapper/RulesTocProcessor.ParseLink(string,RuleTocItem).md new file mode 100644 index 0000000..0aa5b32 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/RulesTocProcessor.ParseLink(string,RuleTocItem).md @@ -0,0 +1,27 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.Rules.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules').[RulesTocProcessor](RulesTocProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules\.RulesTocProcessor') + +## RulesTocProcessor\.ParseLink\(string, RuleTocItem\) Method + +Обработка ссылки в содержании для создания нового элемента содержания\.\. + +```csharp +private Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.RuleTocItem ParseLink(string value, Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.RuleTocItem? parent=null); +``` +#### Parameters + + + +`value` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +Строка с ссылкой\. + + + +`parent` [RuleTocItem](RuleTocItem.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocItem') + +Родительсий элемент, к которому будет относиться новый элемент содержания\. + +#### Returns +[RuleTocItem](RuleTocItem.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocItem') +Новый элемент содержания\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/RulesTocProcessor.Process().md b/Documentation/Pf2eDataScrapper/RulesTocProcessor.Process().md new file mode 100644 index 0000000..5cd3bed --- /dev/null +++ b/Documentation/Pf2eDataScrapper/RulesTocProcessor.Process().md @@ -0,0 +1,12 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.Rules.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules').[RulesTocProcessor](RulesTocProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules\.RulesTocProcessor') + +## RulesTocProcessor\.Process\(\) Method + +Основной метод обработки данных\. + +```csharp +public void Process(); +``` + +Implements [Process\(\)](IProcessor.Process().md 'Pf2eDataScrapper\.Processors\.Definitions\.IProcessor\.Process\(\)') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/RulesTocProcessor.Save().md b/Documentation/Pf2eDataScrapper/RulesTocProcessor.Save().md new file mode 100644 index 0000000..0e4cede --- /dev/null +++ b/Documentation/Pf2eDataScrapper/RulesTocProcessor.Save().md @@ -0,0 +1,12 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.Rules.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules').[RulesTocProcessor](RulesTocProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules\.RulesTocProcessor') + +## RulesTocProcessor\.Save\(\) Method + +Метод для сохранения изменений в базе данных\. + +```csharp +public void Save(); +``` + +Implements [Save\(\)](IProcessor.Save().md 'Pf2eDataScrapper\.Processors\.Definitions\.IProcessor\.Save\(\)') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/RulesTocProcessor.Selector.md b/Documentation/Pf2eDataScrapper/RulesTocProcessor.Selector.md new file mode 100644 index 0000000..dd4416b --- /dev/null +++ b/Documentation/Pf2eDataScrapper/RulesTocProcessor.Selector.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.Rules.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules').[RulesTocProcessor](RulesTocProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules\.RulesTocProcessor') + +## RulesTocProcessor\.Selector Field + +Селектор HTML\-элемента, в котором находится содержание\. + +```csharp +private const string Selector = "#ctl00_RadDrawer1_Content_MainContent_DetailedOutput"; +``` + +#### Field Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/RulesTocProcessor.Toc.md b/Documentation/Pf2eDataScrapper/RulesTocProcessor.Toc.md new file mode 100644 index 0000000..aad40e0 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/RulesTocProcessor.Toc.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.Rules.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules').[RulesTocProcessor](RulesTocProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules\.RulesTocProcessor') + +## RulesTocProcessor\.Toc Field + +Структура генерации содержания правил\. + +```csharp +public readonly RuleTocCollection Toc; +``` + +#### Field Value +[RuleTocCollection](RuleTocCollection.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocCollection') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/RulesTocProcessor.Url.md b/Documentation/Pf2eDataScrapper/RulesTocProcessor.Url.md new file mode 100644 index 0000000..245663c --- /dev/null +++ b/Documentation/Pf2eDataScrapper/RulesTocProcessor.Url.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.Rules.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules').[RulesTocProcessor](RulesTocProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules\.RulesTocProcessor') + +## RulesTocProcessor\.Url Field + +Ссылка на страницу с содержанием\. + +```csharp +private const string Url = "https://2e.aonprd.com/Rules.aspx"; +``` + +#### Field Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/RulesTocProcessor.md b/Documentation/Pf2eDataScrapper/RulesTocProcessor.md new file mode 100644 index 0000000..410a506 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/RulesTocProcessor.md @@ -0,0 +1,26 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.Rules.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules') + +## RulesTocProcessor Class + +```csharp +internal class RulesTocProcessor : Pf2eDataScrapper.Processors.Definitions.IProcessor +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 RulesTocProcessor + +Implements [IProcessor](IProcessor.md 'Pf2eDataScrapper\.Processors\.Definitions\.IProcessor') + +| Fields | | +| :--- | :--- | +| [Selector](RulesTocProcessor.Selector.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules\.RulesTocProcessor\.Selector') | Селектор HTML\-элемента, в котором находится содержание\. | +| [Toc](RulesTocProcessor.Toc.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules\.RulesTocProcessor\.Toc') | Структура генерации содержания правил\. | +| [Url](RulesTocProcessor.Url.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules\.RulesTocProcessor\.Url') | Ссылка на страницу с содержанием\. | + +| Methods | | +| :--- | :--- | +| [DownloadPage\(\)](RulesTocProcessor.DownloadPage().md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules\.RulesTocProcessor\.DownloadPage\(\)') | Скачивание страницы, указанной в [Url](RulesTocProcessor.Url.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules\.RulesTocProcessor\.Url'), и получение очищенного элемента, указанного в [Selector](RulesTocProcessor.Selector.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules\.RulesTocProcessor\.Selector')\. | +| [LinkRegex\(\)](RulesTocProcessor.LinkRegex().md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules\.RulesTocProcessor\.LinkRegex\(\)') | | +| [ParseLink\(string, RuleTocItem\)](RulesTocProcessor.ParseLink(string,RuleTocItem).md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules\.RulesTocProcessor\.ParseLink\(string, Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.RuleTocItem\)') | Обработка ссылки в содержании для создания нового элемента содержания\.\. | +| [Process\(\)](RulesTocProcessor.Process().md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules\.RulesTocProcessor\.Process\(\)') | Основной метод обработки данных\. | +| [Save\(\)](RulesTocProcessor.Save().md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules\.RulesTocProcessor\.Save\(\)') | Метод для сохранения изменений в базе данных\. | diff --git a/Documentation/Pf2eDataScrapper/SchemaBuildProcessor.Compendium.md b/Documentation/Pf2eDataScrapper/SchemaBuildProcessor.Compendium.md new file mode 100644 index 0000000..1fa233f --- /dev/null +++ b/Documentation/Pf2eDataScrapper/SchemaBuildProcessor.Compendium.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Preparation](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Preparation.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Preparation').[SchemaBuildProcessor](SchemaBuildProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Preparation\.SchemaBuildProcessor') + +## SchemaBuildProcessor\.Compendium Property + +Класс хранения данных компендиума\. + +```csharp +protected virtual Pf2eDataScrapper.Importers.Implementations.Aonprd.Compendium.AonprdCompendium Compendium { protected get; } +``` + +#### Property Value +[AonprdCompendium](AonprdCompendium.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Compendium\.AonprdCompendium') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/SchemaBuildProcessor.GetSchemaNodes(string).md b/Documentation/Pf2eDataScrapper/SchemaBuildProcessor.GetSchemaNodes(string).md new file mode 100644 index 0000000..ede027e --- /dev/null +++ b/Documentation/Pf2eDataScrapper/SchemaBuildProcessor.GetSchemaNodes(string).md @@ -0,0 +1,21 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Processors\.Preparation](Pf2eDataScrapper.Importers.Implementations.FoundryEn.Processors.Preparation.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Processors\.Preparation').[SchemaBuildProcessor](SchemaBuildProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Processors\.Preparation\.SchemaBuildProcessor') + +## SchemaBuildProcessor\.GetSchemaNodes\(string\) Method + +Выбор целевых элементом схемы данных для типа элемента\. + +```csharp +private System.Collections.Generic.List GetSchemaNodes(string type); +``` +#### Parameters + + + +`type` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +Тип входного элемента\. + +#### Returns +[System\.Collections\.Generic\.List<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.List-1 'System\.Collections\.Generic\.List\`1')[SchemaNode](SchemaNode.md 'Pf2eDataScrapper\.SchemaBuilder\.SchemaNode')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.List-1 'System\.Collections\.Generic\.List\`1') +Список целевых элементов схемы данных\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/SchemaBuildProcessor.Importer.md b/Documentation/Pf2eDataScrapper/SchemaBuildProcessor.Importer.md new file mode 100644 index 0000000..60c6acf --- /dev/null +++ b/Documentation/Pf2eDataScrapper/SchemaBuildProcessor.Importer.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Preparation](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Preparation.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Preparation').[SchemaBuildProcessor](SchemaBuildProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Preparation\.SchemaBuildProcessor') + +## SchemaBuildProcessor\.Importer Property + +Класс обработки данных с сайта Архивов Нефеса\. + +```csharp +protected Pf2eDataScrapper.Importers.Implementations.Aonprd.AonprdImporter Importer { protected get; } +``` + +#### Property Value +[AonprdImporter](AonprdImporter.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.AonprdImporter') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/SchemaBuildProcessor.Repository.md b/Documentation/Pf2eDataScrapper/SchemaBuildProcessor.Repository.md new file mode 100644 index 0000000..b7e79a9 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/SchemaBuildProcessor.Repository.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Processors\.Preparation](Pf2eDataScrapper.Importers.Implementations.FoundryEn.Processors.Preparation.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Processors\.Preparation').[SchemaBuildProcessor](SchemaBuildProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Processors\.Preparation\.SchemaBuildProcessor') + +## SchemaBuildProcessor\.Repository Property + +Git\-репозиторий данных FoundryVTT\-модуля "pf2e"\. + +```csharp +protected Pf2eDataScrapper.Importers.Implementations.FoundryEn.FoundryEnRepository Repository { protected get; } +``` + +#### Property Value +[FoundryEnRepository](FoundryEnRepository.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.FoundryEnRepository') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/SchemaBuildProcessor.Resolver.md b/Documentation/Pf2eDataScrapper/SchemaBuildProcessor.Resolver.md new file mode 100644 index 0000000..60a1be4 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/SchemaBuildProcessor.Resolver.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Preparation](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Preparation.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Preparation').[SchemaBuildProcessor](SchemaBuildProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Preparation\.SchemaBuildProcessor') + +## SchemaBuildProcessor\.Resolver Property + +Определитель типов данных\. + +```csharp +protected virtual Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Preparation.AonprdTypeResolver Resolver { protected get; } +``` + +#### Property Value +[AonprdTypeResolver](AonprdTypeResolver.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Preparation\.AonprdTypeResolver') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/SchemaBuildProcessor.SavePath.md b/Documentation/Pf2eDataScrapper/SchemaBuildProcessor.SavePath.md new file mode 100644 index 0000000..9b9623a --- /dev/null +++ b/Documentation/Pf2eDataScrapper/SchemaBuildProcessor.SavePath.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Preparation](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Preparation.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Preparation').[SchemaBuildProcessor](SchemaBuildProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Preparation\.SchemaBuildProcessor') + +## SchemaBuildProcessor\.SavePath Property + +Путь к каталогу для сохранения вывода\. + +```csharp +protected override string SavePath { protected get; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/SchemaBuildProcessor.Settings.md b/Documentation/Pf2eDataScrapper/SchemaBuildProcessor.Settings.md new file mode 100644 index 0000000..84382a8 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/SchemaBuildProcessor.Settings.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Preparation](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Preparation.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Preparation').[SchemaBuildProcessor](SchemaBuildProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Preparation\.SchemaBuildProcessor') + +## SchemaBuildProcessor\.Settings Property + +Настройки программы\. + +```csharp +protected Pf2eDataScrapper.ApplicationSettings Settings { protected get; } +``` + +#### Property Value +[ApplicationSettings](ApplicationSettings.md 'Pf2eDataScrapper\.ApplicationSettings') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/SchemaBuildProcessor._equipmentTypes.md b/Documentation/Pf2eDataScrapper/SchemaBuildProcessor._equipmentTypes.md new file mode 100644 index 0000000..7aff4bf --- /dev/null +++ b/Documentation/Pf2eDataScrapper/SchemaBuildProcessor._equipmentTypes.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Processors\.Preparation](Pf2eDataScrapper.Importers.Implementations.FoundryEn.Processors.Preparation.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Processors\.Preparation').[SchemaBuildProcessor](SchemaBuildProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Processors\.Preparation\.SchemaBuildProcessor') + +## SchemaBuildProcessor\.\_equipmentTypes Field + +Список типов, являющихся экипировкой\. + +```csharp +private readonly string[] _equipmentTypes; +``` + +#### Field Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String')[\[\]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System\.Array') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/SchemaBuildProcessor._subclassSchemaTypes.md b/Documentation/Pf2eDataScrapper/SchemaBuildProcessor._subclassSchemaTypes.md new file mode 100644 index 0000000..933d700 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/SchemaBuildProcessor._subclassSchemaTypes.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Preparation](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Preparation.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Preparation').[SchemaBuildProcessor](SchemaBuildProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Preparation\.SchemaBuildProcessor') + +## SchemaBuildProcessor\.\_subclassSchemaTypes Field + +Список типов, являющихся подклассами\. + +```csharp +private readonly string[] _subclassSchemaTypes; +``` + +#### Field Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String')[\[\]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System\.Array') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/SchemaBuildProcessor.md b/Documentation/Pf2eDataScrapper/SchemaBuildProcessor.md new file mode 100644 index 0000000..d02a1f7 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/SchemaBuildProcessor.md @@ -0,0 +1,22 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Preparation](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Preparation.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Preparation') + +## SchemaBuildProcessor Class + +```csharp +internal class SchemaBuildProcessor : Pf2eDataScrapper.SchemaBuilder.AbstractSchemaBuildProcessor +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [AbstractSchemaBuildProcessor](AbstractSchemaBuildProcessor.md 'Pf2eDataScrapper\.SchemaBuilder\.AbstractSchemaBuildProcessor') 🡒 SchemaBuildProcessor + +| Fields | | +| :--- | :--- | +| [\_subclassSchemaTypes](SchemaBuildProcessor._subclassSchemaTypes.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Preparation\.SchemaBuildProcessor\.\_subclassSchemaTypes') | Список типов, являющихся подклассами\. | + +| Properties | | +| :--- | :--- | +| [Compendium](SchemaBuildProcessor.Compendium.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Preparation\.SchemaBuildProcessor\.Compendium') | Класс хранения данных компендиума\. | +| [Importer](SchemaBuildProcessor.Importer.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Preparation\.SchemaBuildProcessor\.Importer') | Класс обработки данных с сайта Архивов Нефеса\. | +| [Resolver](SchemaBuildProcessor.Resolver.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Preparation\.SchemaBuildProcessor\.Resolver') | Определитель типов данных\. | +| [SavePath](SchemaBuildProcessor.SavePath.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Preparation\.SchemaBuildProcessor\.SavePath') | Путь к каталогу для сохранения вывода\. | +| [Settings](SchemaBuildProcessor.Settings.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Preparation\.SchemaBuildProcessor\.Settings') | Настройки программы\. | diff --git a/Documentation/Pf2eDataScrapper/SchemaNode.AddValue(JToken).md b/Documentation/Pf2eDataScrapper/SchemaNode.AddValue(JToken).md new file mode 100644 index 0000000..6cbedf2 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/SchemaNode.AddValue(JToken).md @@ -0,0 +1,17 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder](Pf2eDataScrapper.SchemaBuilder.md 'Pf2eDataScrapper\.SchemaBuilder').[SchemaNode](SchemaNode.md 'Pf2eDataScrapper\.SchemaBuilder\.SchemaNode') + +## SchemaNode\.AddValue\(JToken\) Method + +Добавление нового возможного значения\. + +```csharp +public void AddValue(Newtonsoft.Json.Linq.JToken? value); +``` +#### Parameters + + + +`value` [Newtonsoft\.Json\.Linq\.JToken](https://docs.microsoft.com/en-us/dotnet/api/Newtonsoft.Json.Linq.JToken 'Newtonsoft\.Json\.Linq\.JToken') + +Добавляемое значение \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/SchemaNode.Beautify().md b/Documentation/Pf2eDataScrapper/SchemaNode.Beautify().md new file mode 100644 index 0000000..b1e456c --- /dev/null +++ b/Documentation/Pf2eDataScrapper/SchemaNode.Beautify().md @@ -0,0 +1,10 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder](Pf2eDataScrapper.SchemaBuilder.md 'Pf2eDataScrapper\.SchemaBuilder').[SchemaNode](SchemaNode.md 'Pf2eDataScrapper\.SchemaBuilder\.SchemaNode') + +## SchemaNode\.Beautify\(\) Method + +Подготовка элемента к красивому представлению\. + +```csharp +public void Beautify(); +``` \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/SchemaNode.ElementLimit.md b/Documentation/Pf2eDataScrapper/SchemaNode.ElementLimit.md new file mode 100644 index 0000000..9ef844b --- /dev/null +++ b/Documentation/Pf2eDataScrapper/SchemaNode.ElementLimit.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder](Pf2eDataScrapper.SchemaBuilder.md 'Pf2eDataScrapper\.SchemaBuilder').[SchemaNode](SchemaNode.md 'Pf2eDataScrapper\.SchemaBuilder\.SchemaNode') + +## SchemaNode\.ElementLimit Field + +Предел количество отображаемых элементов\. + +```csharp +public const int ElementLimit = 20; +``` + +#### Field Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/SchemaNode.FormatYaml(List_Dictionary_string,string__).md b/Documentation/Pf2eDataScrapper/SchemaNode.FormatYaml(List_Dictionary_string,string__).md new file mode 100644 index 0000000..2699906 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/SchemaNode.FormatYaml(List_Dictionary_string,string__).md @@ -0,0 +1,21 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder](Pf2eDataScrapper.SchemaBuilder.md 'Pf2eDataScrapper\.SchemaBuilder').[SchemaNode](SchemaNode.md 'Pf2eDataScrapper\.SchemaBuilder\.SchemaNode') + +## SchemaNode\.FormatYaml\(List\\>\) Method + +Форматирование данных в YAML\. + +```csharp +public static string FormatYaml(System.Collections.Generic.List> input); +``` +#### Parameters + + + +`input` [System\.Collections\.Generic\.List<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.List-1 'System\.Collections\.Generic\.List\`1')[System\.Collections\.Generic\.Dictionary<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.Dictionary-2 'System\.Collections\.Generic\.Dictionary\`2')[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.Dictionary-2 'System\.Collections\.Generic\.Dictionary\`2')[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.Dictionary-2 'System\.Collections\.Generic\.Dictionary\`2')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.List-1 'System\.Collections\.Generic\.List\`1') + +Словарь данных\. + +#### Returns +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') +Строка форматированных данных \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/SchemaNode.GetTypeName().md b/Documentation/Pf2eDataScrapper/SchemaNode.GetTypeName().md new file mode 100644 index 0000000..7f9c84f --- /dev/null +++ b/Documentation/Pf2eDataScrapper/SchemaNode.GetTypeName().md @@ -0,0 +1,14 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder](Pf2eDataScrapper.SchemaBuilder.md 'Pf2eDataScrapper\.SchemaBuilder').[SchemaNode](SchemaNode.md 'Pf2eDataScrapper\.SchemaBuilder\.SchemaNode') + +## SchemaNode\.GetTypeName\(\) Method + +Получение строкового представоения типа элемента\. + +```csharp +public string GetTypeName(); +``` + +#### Returns +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') +Строковое представоение типа элемента \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/SchemaNode.Indent(string).md b/Documentation/Pf2eDataScrapper/SchemaNode.Indent(string).md new file mode 100644 index 0000000..076d1d0 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/SchemaNode.Indent(string).md @@ -0,0 +1,21 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder](Pf2eDataScrapper.SchemaBuilder.md 'Pf2eDataScrapper\.SchemaBuilder').[SchemaNode](SchemaNode.md 'Pf2eDataScrapper\.SchemaBuilder\.SchemaNode') + +## SchemaNode\.Indent\(string\) Method + +Увеличение отступа строки\. + +```csharp +public static string Indent(string text); +``` +#### Parameters + + + +`text` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +Изменяемая строка\. + +#### Returns +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') +Строка с добавленными отступами\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/SchemaNode.IsNullable.md b/Documentation/Pf2eDataScrapper/SchemaNode.IsNullable.md new file mode 100644 index 0000000..b1cefe2 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/SchemaNode.IsNullable.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder](Pf2eDataScrapper.SchemaBuilder.md 'Pf2eDataScrapper\.SchemaBuilder').[SchemaNode](SchemaNode.md 'Pf2eDataScrapper\.SchemaBuilder\.SchemaNode') + +## SchemaNode\.IsNullable Field + +Указание, может ли этот элемент отсутсвовать в структуре данных\. + +```csharp +public bool IsNullable; +``` + +#### Field Value +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/SchemaNode.IsSimple.md b/Documentation/Pf2eDataScrapper/SchemaNode.IsSimple.md new file mode 100644 index 0000000..342eed2 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/SchemaNode.IsSimple.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder](Pf2eDataScrapper.SchemaBuilder.md 'Pf2eDataScrapper\.SchemaBuilder').[SchemaNode](SchemaNode.md 'Pf2eDataScrapper\.SchemaBuilder\.SchemaNode') + +## SchemaNode\.IsSimple Property + +Указание, является ли тип элемента простым\. + +```csharp +public bool IsSimple { get; } +``` + +#### Property Value +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/SchemaNode.Name.md b/Documentation/Pf2eDataScrapper/SchemaNode.Name.md new file mode 100644 index 0000000..14a4ca0 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/SchemaNode.Name.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder](Pf2eDataScrapper.SchemaBuilder.md 'Pf2eDataScrapper\.SchemaBuilder').[SchemaNode](SchemaNode.md 'Pf2eDataScrapper\.SchemaBuilder\.SchemaNode') + +## SchemaNode\.Name Field + +Отображаемое имя элемента\. + +```csharp +public readonly string Name; +``` + +#### Field Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/SchemaNode.Parent.md b/Documentation/Pf2eDataScrapper/SchemaNode.Parent.md new file mode 100644 index 0000000..ca5a6df --- /dev/null +++ b/Documentation/Pf2eDataScrapper/SchemaNode.Parent.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder](Pf2eDataScrapper.SchemaBuilder.md 'Pf2eDataScrapper\.SchemaBuilder').[SchemaNode](SchemaNode.md 'Pf2eDataScrapper\.SchemaBuilder\.SchemaNode') + +## SchemaNode\.Parent Field + +Родительский элемент\. + +```csharp +public readonly SchemaNode? Parent; +``` + +#### Field Value +[SchemaNode](SchemaNode.md 'Pf2eDataScrapper\.SchemaBuilder\.SchemaNode') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/SchemaNode.Path.md b/Documentation/Pf2eDataScrapper/SchemaNode.Path.md new file mode 100644 index 0000000..93008f1 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/SchemaNode.Path.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder](Pf2eDataScrapper.SchemaBuilder.md 'Pf2eDataScrapper\.SchemaBuilder').[SchemaNode](SchemaNode.md 'Pf2eDataScrapper\.SchemaBuilder\.SchemaNode') + +## SchemaNode\.Path Field + +Путь к элементу\. + +```csharp +public string Path; +``` + +#### Field Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/SchemaNode.Resolver.md b/Documentation/Pf2eDataScrapper/SchemaNode.Resolver.md new file mode 100644 index 0000000..50c46b4 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/SchemaNode.Resolver.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder](Pf2eDataScrapper.SchemaBuilder.md 'Pf2eDataScrapper\.SchemaBuilder').[SchemaNode](SchemaNode.md 'Pf2eDataScrapper\.SchemaBuilder\.SchemaNode') + +## SchemaNode\.Resolver Field + +Объект для определения типа поля в схеме данных\. + +```csharp +public TypeResolver Resolver; +``` + +#### Field Value +[TypeResolver](TypeResolver.md 'Pf2eDataScrapper\.SchemaBuilder\.TypeResolver') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/SchemaNode.Root.md b/Documentation/Pf2eDataScrapper/SchemaNode.Root.md new file mode 100644 index 0000000..1fcf7b1 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/SchemaNode.Root.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder](Pf2eDataScrapper.SchemaBuilder.md 'Pf2eDataScrapper\.SchemaBuilder').[SchemaNode](SchemaNode.md 'Pf2eDataScrapper\.SchemaBuilder\.SchemaNode') + +## SchemaNode\.Root Field + +Указание, является ли элемент корневым\. + +```csharp +public readonly bool Root; +``` + +#### Field Value +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/SchemaNode.RootNode.md b/Documentation/Pf2eDataScrapper/SchemaNode.RootNode.md new file mode 100644 index 0000000..04bc91b --- /dev/null +++ b/Documentation/Pf2eDataScrapper/SchemaNode.RootNode.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder](Pf2eDataScrapper.SchemaBuilder.md 'Pf2eDataScrapper\.SchemaBuilder').[SchemaNode](SchemaNode.md 'Pf2eDataScrapper\.SchemaBuilder\.SchemaNode') + +## SchemaNode\.RootNode Property + +Корневой элемент схемы данных\. + +```csharp +public Pf2eDataScrapper.SchemaBuilder.SchemaNode RootNode { get; } +``` + +#### Property Value +[SchemaNode](SchemaNode.md 'Pf2eDataScrapper\.SchemaBuilder\.SchemaNode') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/SchemaNode.SchemaNode.md b/Documentation/Pf2eDataScrapper/SchemaNode.SchemaNode.md new file mode 100644 index 0000000..e091f0c --- /dev/null +++ b/Documentation/Pf2eDataScrapper/SchemaNode.SchemaNode.md @@ -0,0 +1,42 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder](Pf2eDataScrapper.SchemaBuilder.md 'Pf2eDataScrapper\.SchemaBuilder').[SchemaNode](SchemaNode.md 'Pf2eDataScrapper\.SchemaBuilder\.SchemaNode') + +## SchemaNode Constructors + +| Overloads | | +| :--- | :--- | +| [SchemaNode\(\)](SchemaNode.SchemaNode.md#Pf2eDataScrapper.SchemaBuilder.SchemaNode.SchemaNode() 'Pf2eDataScrapper\.SchemaBuilder\.SchemaNode\.SchemaNode\(\)') | Конструктор корневого элемента\. | +| [SchemaNode\(SchemaNode, string\)](SchemaNode.SchemaNode.md#Pf2eDataScrapper.SchemaBuilder.SchemaNode.SchemaNode(Pf2eDataScrapper.SchemaBuilder.SchemaNode,string) 'Pf2eDataScrapper\.SchemaBuilder\.SchemaNode\.SchemaNode\(Pf2eDataScrapper\.SchemaBuilder\.SchemaNode, string\)') | Конструктор элемента схемы данных\. | + + + +## SchemaNode\(\) Constructor + +Конструктор корневого элемента\. + +```csharp +public SchemaNode(); +``` + + + +## SchemaNode\(SchemaNode, string\) Constructor + +Конструктор элемента схемы данных\. + +```csharp +public SchemaNode(Pf2eDataScrapper.SchemaBuilder.SchemaNode parent, string name); +``` +#### Parameters + + + +`parent` [SchemaNode](SchemaNode.md 'Pf2eDataScrapper\.SchemaBuilder\.SchemaNode') + +Родительский элемент\. + + + +`name` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +Имя элемента\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/SchemaNode.Tab.md b/Documentation/Pf2eDataScrapper/SchemaNode.Tab.md new file mode 100644 index 0000000..714f8e5 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/SchemaNode.Tab.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder](Pf2eDataScrapper.SchemaBuilder.md 'Pf2eDataScrapper\.SchemaBuilder').[SchemaNode](SchemaNode.md 'Pf2eDataScrapper\.SchemaBuilder\.SchemaNode') + +## SchemaNode\.Tab Field + +Отступ для строкового представления\. + +```csharp +public const string Tab = " "; +``` + +#### Field Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/SchemaNode.ToString().md b/Documentation/Pf2eDataScrapper/SchemaNode.ToString().md new file mode 100644 index 0000000..c69ddf9 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/SchemaNode.ToString().md @@ -0,0 +1,14 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder](Pf2eDataScrapper.SchemaBuilder.md 'Pf2eDataScrapper\.SchemaBuilder').[SchemaNode](SchemaNode.md 'Pf2eDataScrapper\.SchemaBuilder\.SchemaNode') + +## SchemaNode\.ToString\(\) Method + +Полное строковое представление элемента\. + +```csharp +public override string ToString(); +``` + +#### Returns +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') +Строковое представление элемента\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/SchemaNode.Types.md b/Documentation/Pf2eDataScrapper/SchemaNode.Types.md new file mode 100644 index 0000000..33c1dcc --- /dev/null +++ b/Documentation/Pf2eDataScrapper/SchemaNode.Types.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder](Pf2eDataScrapper.SchemaBuilder.md 'Pf2eDataScrapper\.SchemaBuilder').[SchemaNode](SchemaNode.md 'Pf2eDataScrapper\.SchemaBuilder\.SchemaNode') + +## SchemaNode\.Types Field + +Типы данных, использующиеся в элементе\. + +```csharp +public readonly List Types; +``` + +#### Field Value +[System\.Collections\.Generic\.List<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.List-1 'System\.Collections\.Generic\.List\`1')[AbstractSchemaType](AbstractSchemaType.md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.AbstractSchemaType')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.List-1 'System\.Collections\.Generic\.List\`1') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/SchemaNode.Values.md b/Documentation/Pf2eDataScrapper/SchemaNode.Values.md new file mode 100644 index 0000000..cb1506e --- /dev/null +++ b/Documentation/Pf2eDataScrapper/SchemaNode.Values.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder](Pf2eDataScrapper.SchemaBuilder.md 'Pf2eDataScrapper\.SchemaBuilder').[SchemaNode](SchemaNode.md 'Pf2eDataScrapper\.SchemaBuilder\.SchemaNode') + +## SchemaNode\.Values Property + +Количество значений, добавленных в тип\. + +```csharp +public int Values { get; protected set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/SchemaNode.md b/Documentation/Pf2eDataScrapper/SchemaNode.md new file mode 100644 index 0000000..8ce9c64 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/SchemaNode.md @@ -0,0 +1,53 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder](Pf2eDataScrapper.SchemaBuilder.md 'Pf2eDataScrapper\.SchemaBuilder') + +## SchemaNode Class + +Элемент схемы данных\. + +```csharp +internal class SchemaNode +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 SchemaNode + +### Example +Пример использования: + +```csharp +SchemaNode schema = new (); // Создание схемы данных +data = JObject.Parse(reader.ReadToEnd()); // Загрузка данных +schema.AddValue(data); // Добавление данных +``` + +| Constructors | | +| :--- | :--- | +| [SchemaNode\(\)](SchemaNode.SchemaNode.md#Pf2eDataScrapper.SchemaBuilder.SchemaNode.SchemaNode() 'Pf2eDataScrapper\.SchemaBuilder\.SchemaNode\.SchemaNode\(\)') | Конструктор корневого элемента\. | +| [SchemaNode\(SchemaNode, string\)](SchemaNode.SchemaNode.md#Pf2eDataScrapper.SchemaBuilder.SchemaNode.SchemaNode(Pf2eDataScrapper.SchemaBuilder.SchemaNode,string) 'Pf2eDataScrapper\.SchemaBuilder\.SchemaNode\.SchemaNode\(Pf2eDataScrapper\.SchemaBuilder\.SchemaNode, string\)') | Конструктор элемента схемы данных\. | + +| Fields | | +| :--- | :--- | +| [ElementLimit](SchemaNode.ElementLimit.md 'Pf2eDataScrapper\.SchemaBuilder\.SchemaNode\.ElementLimit') | Предел количество отображаемых элементов\. | +| [IsNullable](SchemaNode.IsNullable.md 'Pf2eDataScrapper\.SchemaBuilder\.SchemaNode\.IsNullable') | Указание, может ли этот элемент отсутсвовать в структуре данных\. | +| [Name](SchemaNode.Name.md 'Pf2eDataScrapper\.SchemaBuilder\.SchemaNode\.Name') | Отображаемое имя элемента\. | +| [Parent](SchemaNode.Parent.md 'Pf2eDataScrapper\.SchemaBuilder\.SchemaNode\.Parent') | Родительский элемент\. | +| [Path](SchemaNode.Path.md 'Pf2eDataScrapper\.SchemaBuilder\.SchemaNode\.Path') | Путь к элементу\. | +| [Resolver](SchemaNode.Resolver.md 'Pf2eDataScrapper\.SchemaBuilder\.SchemaNode\.Resolver') | Объект для определения типа поля в схеме данных\. | +| [Root](SchemaNode.Root.md 'Pf2eDataScrapper\.SchemaBuilder\.SchemaNode\.Root') | Указание, является ли элемент корневым\. | +| [Tab](SchemaNode.Tab.md 'Pf2eDataScrapper\.SchemaBuilder\.SchemaNode\.Tab') | Отступ для строкового представления\. | +| [Types](SchemaNode.Types.md 'Pf2eDataScrapper\.SchemaBuilder\.SchemaNode\.Types') | Типы данных, использующиеся в элементе\. | + +| Properties | | +| :--- | :--- | +| [IsSimple](SchemaNode.IsSimple.md 'Pf2eDataScrapper\.SchemaBuilder\.SchemaNode\.IsSimple') | Указание, является ли тип элемента простым\. | +| [RootNode](SchemaNode.RootNode.md 'Pf2eDataScrapper\.SchemaBuilder\.SchemaNode\.RootNode') | Корневой элемент схемы данных\. | +| [Values](SchemaNode.Values.md 'Pf2eDataScrapper\.SchemaBuilder\.SchemaNode\.Values') | Количество значений, добавленных в тип\. | + +| Methods | | +| :--- | :--- | +| [AddValue\(JToken\)](SchemaNode.AddValue(JToken).md 'Pf2eDataScrapper\.SchemaBuilder\.SchemaNode\.AddValue\(Newtonsoft\.Json\.Linq\.JToken\)') | Добавление нового возможного значения\. | +| [Beautify\(\)](SchemaNode.Beautify().md 'Pf2eDataScrapper\.SchemaBuilder\.SchemaNode\.Beautify\(\)') | Подготовка элемента к красивому представлению\. | +| [FormatYaml\(List<Dictionary<string,string>>\)](SchemaNode.FormatYaml(List_Dictionary_string,string__).md 'Pf2eDataScrapper\.SchemaBuilder\.SchemaNode\.FormatYaml\(System\.Collections\.Generic\.List\\>\)') | Форматирование данных в YAML\. | +| [GetTypeName\(\)](SchemaNode.GetTypeName().md 'Pf2eDataScrapper\.SchemaBuilder\.SchemaNode\.GetTypeName\(\)') | Получение строкового представоения типа элемента\. | +| [Indent\(string\)](SchemaNode.Indent(string).md 'Pf2eDataScrapper\.SchemaBuilder\.SchemaNode\.Indent\(string\)') | Увеличение отступа строки\. | +| [ToString\(\)](SchemaNode.ToString().md 'Pf2eDataScrapper\.SchemaBuilder\.SchemaNode\.ToString\(\)') | Полное строковое представление элемента\. | diff --git a/Documentation/Pf2eDataScrapper/SchemaTypeResolver.CustomResolve(SchemaNode,JToken).md b/Documentation/Pf2eDataScrapper/SchemaTypeResolver.CustomResolve(SchemaNode,JToken).md new file mode 100644 index 0000000..689f42a --- /dev/null +++ b/Documentation/Pf2eDataScrapper/SchemaTypeResolver.CustomResolve(SchemaNode,JToken).md @@ -0,0 +1,27 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Processors\.Preparation](Pf2eDataScrapper.Importers.Implementations.FoundryEn.Processors.Preparation.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Processors\.Preparation').[SchemaTypeResolver](SchemaTypeResolver.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Processors\.Preparation\.SchemaTypeResolver') + +## SchemaTypeResolver\.CustomResolve\(SchemaNode, JToken\) Method + +Частное определение типа поля\. + +```csharp +protected override Pf2eDataScrapper.SchemaBuilder.Types.AbstractSchemaType? CustomResolve(Pf2eDataScrapper.SchemaBuilder.SchemaNode node, Newtonsoft.Json.Linq.JToken? value); +``` +#### Parameters + + + +`node` [SchemaNode](SchemaNode.md 'Pf2eDataScrapper\.SchemaBuilder\.SchemaNode') + +Поле схемы данных, для которого создаётся тип\. + + + +`value` [Newtonsoft\.Json\.Linq\.JToken](https://docs.microsoft.com/en-us/dotnet/api/Newtonsoft.Json.Linq.JToken 'Newtonsoft\.Json\.Linq\.JToken') + +Добавляемое значение\. + +#### Returns +[AbstractSchemaType](AbstractSchemaType.md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.AbstractSchemaType') +Новый тип для схемы данных\. \`null\`, что бы использовать значение по умолчанию \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/SchemaTypeResolver.md b/Documentation/Pf2eDataScrapper/SchemaTypeResolver.md new file mode 100644 index 0000000..97f02ac --- /dev/null +++ b/Documentation/Pf2eDataScrapper/SchemaTypeResolver.md @@ -0,0 +1,14 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Processors\.Preparation](Pf2eDataScrapper.Importers.Implementations.FoundryEn.Processors.Preparation.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Processors\.Preparation') + +## SchemaTypeResolver Class + +```csharp +internal class SchemaTypeResolver : Pf2eDataScrapper.SchemaBuilder.TypeResolver +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [TypeResolver](TypeResolver.md 'Pf2eDataScrapper\.SchemaBuilder\.TypeResolver') 🡒 SchemaTypeResolver + +| Methods | | +| :--- | :--- | +| [CustomResolve\(SchemaNode, JToken\)](SchemaTypeResolver.CustomResolve(SchemaNode,JToken).md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Processors\.Preparation\.SchemaTypeResolver\.CustomResolve\(Pf2eDataScrapper\.SchemaBuilder\.SchemaNode, Newtonsoft\.Json\.Linq\.JToken\)') | Частное определение типа поля\. | diff --git a/Documentation/Pf2eDataScrapper/SelectedEntityStore.SelectedEntity.md b/Documentation/Pf2eDataScrapper/SelectedEntityStore.SelectedEntity.md new file mode 100644 index 0000000..f1acc02 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/SelectedEntityStore.SelectedEntity.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.Stores](Pf2eDataScrapper.WPF.EntityViewer.Stores.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.Stores').[SelectedEntityStore](SelectedEntityStore.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.Stores\.SelectedEntityStore') + +## SelectedEntityStore\.SelectedEntity Property + +Сущность, выбранная в интерфейсе\. + +```csharp +public Pf2eModel.Model.Base.Entity? SelectedEntity { get; set; } +``` + +#### Property Value +[Pf2eModel\.Model\.Base\.Entity](https://docs.microsoft.com/en-us/dotnet/api/Pf2eModel.Model.Base.Entity 'Pf2eModel\.Model\.Base\.Entity') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/SelectedEntityStore.SelectedEntityChanged.md b/Documentation/Pf2eDataScrapper/SelectedEntityStore.SelectedEntityChanged.md new file mode 100644 index 0000000..a89a56a --- /dev/null +++ b/Documentation/Pf2eDataScrapper/SelectedEntityStore.SelectedEntityChanged.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.Stores](Pf2eDataScrapper.WPF.EntityViewer.Stores.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.Stores').[SelectedEntityStore](SelectedEntityStore.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.Stores\.SelectedEntityStore') + +## SelectedEntityStore\.SelectedEntityChanged Event + +Событие, вызываемое при изменении выбранной сущности\. + +```csharp +public event Action? SelectedEntityChanged; +``` + +#### Event Type +[System\.Action<](https://docs.microsoft.com/en-us/dotnet/api/System.Action-1 'System\.Action\`1')[Pf2eModel\.Model\.Base\.Entity](https://docs.microsoft.com/en-us/dotnet/api/Pf2eModel.Model.Base.Entity 'Pf2eModel\.Model\.Base\.Entity')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Action-1 'System\.Action\`1') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/SelectedEntityStore.md b/Documentation/Pf2eDataScrapper/SelectedEntityStore.md new file mode 100644 index 0000000..8760acc --- /dev/null +++ b/Documentation/Pf2eDataScrapper/SelectedEntityStore.md @@ -0,0 +1,20 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.Stores](Pf2eDataScrapper.WPF.EntityViewer.Stores.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.Stores') + +## SelectedEntityStore Class + +Хранилище выбранной сущности\. + +```csharp +public class SelectedEntityStore +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 SelectedEntityStore + +| Properties | | +| :--- | :--- | +| [SelectedEntity](SelectedEntityStore.SelectedEntity.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.Stores\.SelectedEntityStore\.SelectedEntity') | Сущность, выбранная в интерфейсе\. | + +| Events | | +| :--- | :--- | +| [SelectedEntityChanged](SelectedEntityStore.SelectedEntityChanged.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.Stores\.SelectedEntityStore\.SelectedEntityChanged') | Событие, вызываемое при изменении выбранной сущности\. | diff --git a/Documentation/Pf2eDataScrapper/SilentSkipItemException.md b/Documentation/Pf2eDataScrapper/SilentSkipItemException.md new file mode 100644 index 0000000..ead5ecd --- /dev/null +++ b/Documentation/Pf2eDataScrapper/SilentSkipItemException.md @@ -0,0 +1,12 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Processors](Pf2eDataScrapper.Processors.md 'Pf2eDataScrapper\.Processors') + +## SilentSkipItemException Class + +Исключение, показывающее, что обработка сущности пропускается без вывода сообщения\. + +```csharp +public class SilentSkipItemException : System.Exception +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [System\.Exception](https://docs.microsoft.com/en-us/dotnet/api/System.Exception 'System\.Exception') 🡒 SilentSkipItemException \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/SkillActionsProcessor.Add().md b/Documentation/Pf2eDataScrapper/SkillActionsProcessor.Add().md new file mode 100644 index 0000000..3a31fe9 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/SkillActionsProcessor.Add().md @@ -0,0 +1,10 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types').[SkillActionsProcessor](SkillActionsProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.SkillActionsProcessor') + +## SkillActionsProcessor\.Add\(\) Method + +Добавление основной сущности в контекст базы данных\. + +```csharp +protected override void Add(); +``` \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/SkillActionsProcessor.AddedDescriptionPaths().md b/Documentation/Pf2eDataScrapper/SkillActionsProcessor.AddedDescriptionPaths().md new file mode 100644 index 0000000..51be615 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/SkillActionsProcessor.AddedDescriptionPaths().md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types').[SkillActionsProcessor](SkillActionsProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.SkillActionsProcessor') + +## SkillActionsProcessor\.AddedDescriptionPaths\(\) Method + +Получение списка полей, которые должны быть добавлены в описание\. + +```csharp +protected virtual string[] AddedDescriptionPaths(); +``` + +#### Returns +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String')[\[\]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System\.Array') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/SkillActionsProcessor.Object.md b/Documentation/Pf2eDataScrapper/SkillActionsProcessor.Object.md new file mode 100644 index 0000000..0a807af --- /dev/null +++ b/Documentation/Pf2eDataScrapper/SkillActionsProcessor.Object.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types').[SkillActionsProcessor](SkillActionsProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.SkillActionsProcessor') + +## SkillActionsProcessor\.Object Property + +Основная сущность\. + +```csharp +public virtual Pf2eModel.Model.Structure.Action Object { get; } +``` + +#### Property Value +[Pf2eModel\.Model\.Structure\.Action](https://docs.microsoft.com/en-us/dotnet/api/Pf2eModel.Model.Structure.Action 'Pf2eModel\.Model\.Structure\.Action') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/SkillActionsProcessor.Process().md b/Documentation/Pf2eDataScrapper/SkillActionsProcessor.Process().md new file mode 100644 index 0000000..445d47a --- /dev/null +++ b/Documentation/Pf2eDataScrapper/SkillActionsProcessor.Process().md @@ -0,0 +1,12 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types').[SkillActionsProcessor](SkillActionsProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.SkillActionsProcessor') + +## SkillActionsProcessor\.Process\(\) Method + +Основной метод обработки данных\. + +```csharp +public override void Process(); +``` + +Implements [Process\(\)](IProcessor.Process().md 'Pf2eDataScrapper\.Processors\.Definitions\.IProcessor\.Process\(\)') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/SkillActionsProcessor.Type.md b/Documentation/Pf2eDataScrapper/SkillActionsProcessor.Type.md new file mode 100644 index 0000000..872209c --- /dev/null +++ b/Documentation/Pf2eDataScrapper/SkillActionsProcessor.Type.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types').[SkillActionsProcessor](SkillActionsProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.SkillActionsProcessor') + +## SkillActionsProcessor\.Type Property + +Тип сущности\. + +```csharp +public override Pf2eModel.Model.Enum.EntityType Type { get; } +``` + +#### Property Value +[Pf2eModel\.Model\.Enum\.EntityType](https://docs.microsoft.com/en-us/dotnet/api/Pf2eModel.Model.Enum.EntityType 'Pf2eModel\.Model\.Enum\.EntityType') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/SkillActionsProcessor.md b/Documentation/Pf2eDataScrapper/SkillActionsProcessor.md new file mode 100644 index 0000000..70cfdf3 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/SkillActionsProcessor.md @@ -0,0 +1,21 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types') + +## SkillActionsProcessor Class + +```csharp +internal class SkillActionsProcessor : Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.AbstractEntityProcessor +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [AbstractInputProcessor](AbstractInputProcessor.md 'Pf2eDataScrapper\.Processors\.Definitions\.AbstractInputProcessor') 🡒 [AbstractEntityProcessor](AbstractEntityProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.AbstractEntityProcessor') 🡒 SkillActionsProcessor + +| Properties | | +| :--- | :--- | +| [Object](SkillActionsProcessor.Object.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.SkillActionsProcessor\.Object') | Основная сущность\. | +| [Type](SkillActionsProcessor.Type.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.SkillActionsProcessor\.Type') | Тип сущности\. | + +| Methods | | +| :--- | :--- | +| [Add\(\)](SkillActionsProcessor.Add().md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.SkillActionsProcessor\.Add\(\)') | Добавление основной сущности в контекст базы данных\. | +| [AddedDescriptionPaths\(\)](SkillActionsProcessor.AddedDescriptionPaths().md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.SkillActionsProcessor\.AddedDescriptionPaths\(\)') | Получение списка полей, которые должны быть добавлены в описание\. | +| [Process\(\)](SkillActionsProcessor.Process().md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.SkillActionsProcessor\.Process\(\)') | Основной метод обработки данных\. | diff --git a/Documentation/Pf2eDataScrapper/SkillProcessor.Process().md b/Documentation/Pf2eDataScrapper/SkillProcessor.Process().md new file mode 100644 index 0000000..844fccd --- /dev/null +++ b/Documentation/Pf2eDataScrapper/SkillProcessor.Process().md @@ -0,0 +1,12 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Preparation](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Preparation.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Preparation').[SkillProcessor](SkillProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Preparation\.SkillProcessor') + +## SkillProcessor\.Process\(\) Method + +Основной метод обработки данных\. + +```csharp +public override void Process(); +``` + +Implements [Process\(\)](IProcessor.Process().md 'Pf2eDataScrapper\.Processors\.Definitions\.IProcessor\.Process\(\)') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/SkillProcessor.Save().md b/Documentation/Pf2eDataScrapper/SkillProcessor.Save().md new file mode 100644 index 0000000..b28d986 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/SkillProcessor.Save().md @@ -0,0 +1,12 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Preparation](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Preparation.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Preparation').[SkillProcessor](SkillProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Preparation\.SkillProcessor') + +## SkillProcessor\.Save\(\) Method + +Метод для сохранения изменений в базе данных\. + +```csharp +public override void Save(); +``` + +Implements [Save\(\)](IProcessor.Save().md 'Pf2eDataScrapper\.Processors\.Definitions\.IProcessor\.Save\(\)') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/SkillProcessor.Training.md b/Documentation/Pf2eDataScrapper/SkillProcessor.Training.md new file mode 100644 index 0000000..989f2ae --- /dev/null +++ b/Documentation/Pf2eDataScrapper/SkillProcessor.Training.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Preparation](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Preparation.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Preparation').[SkillProcessor](SkillProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Preparation\.SkillProcessor') + +## SkillProcessor\.Training Field + +Обучаемый объект\. + +```csharp +public Training Training; +``` + +#### Field Value +[Pf2eModel\.Model\.Common\.Training](https://docs.microsoft.com/en-us/dotnet/api/Pf2eModel.Model.Common.Training 'Pf2eModel\.Model\.Common\.Training') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/SkillProcessor.md b/Documentation/Pf2eDataScrapper/SkillProcessor.md new file mode 100644 index 0000000..ad138ad --- /dev/null +++ b/Documentation/Pf2eDataScrapper/SkillProcessor.md @@ -0,0 +1,19 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Preparation](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Preparation.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Preparation') + +## SkillProcessor Class + +```csharp +internal class SkillProcessor : Pf2eDataScrapper.Processors.Definitions.AbstractInputProcessor +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [AbstractInputProcessor](AbstractInputProcessor.md 'Pf2eDataScrapper\.Processors\.Definitions\.AbstractInputProcessor') 🡒 SkillProcessor + +| Fields | | +| :--- | :--- | +| [Training](SkillProcessor.Training.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Preparation\.SkillProcessor\.Training') | Обучаемый объект\. | + +| Methods | | +| :--- | :--- | +| [Process\(\)](SkillProcessor.Process().md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Preparation\.SkillProcessor\.Process\(\)') | Основной метод обработки данных\. | +| [Save\(\)](SkillProcessor.Save().md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Preparation\.SkillProcessor\.Save\(\)') | Метод для сохранения изменений в базе данных\. | diff --git a/Documentation/Pf2eDataScrapper/SkipItemException.SkipItemException(string,string).md b/Documentation/Pf2eDataScrapper/SkipItemException.SkipItemException(string,string).md new file mode 100644 index 0000000..2c7c24d --- /dev/null +++ b/Documentation/Pf2eDataScrapper/SkipItemException.SkipItemException(string,string).md @@ -0,0 +1,23 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Processors](Pf2eDataScrapper.Processors.md 'Pf2eDataScrapper\.Processors').[SkipItemException](SkipItemException.md 'Pf2eDataScrapper\.Processors\.SkipItemException') + +## SkipItemException\(string, string\) Constructor + +Исключение, показывающее, что обработка сущности пропускается\. + +```csharp +public SkipItemException(string name, string reason); +``` +#### Parameters + + + +`name` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +Название сущности\. + + + +`reason` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +Причина пропуска\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/SkipItemException.md b/Documentation/Pf2eDataScrapper/SkipItemException.md new file mode 100644 index 0000000..8e4328d --- /dev/null +++ b/Documentation/Pf2eDataScrapper/SkipItemException.md @@ -0,0 +1,19 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Processors](Pf2eDataScrapper.Processors.md 'Pf2eDataScrapper\.Processors') + +## SkipItemException Class + +Исключение, показывающее, что обработка сущности пропускается\. + +```csharp +public class SkipItemException : System.Exception +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [System\.Exception](https://docs.microsoft.com/en-us/dotnet/api/System.Exception 'System\.Exception') 🡒 SkipItemException + +Derived +↳ [LegacyItemException](LegacyItemException.md 'Pf2eDataScrapper\.Processors\.LegacyItemException') + +| Constructors | | +| :--- | :--- | +| [SkipItemException\(string, string\)](SkipItemException.SkipItemException(string,string).md 'Pf2eDataScrapper\.Processors\.SkipItemException\.SkipItemException\(string, string\)') | Исключение, показывающее, что обработка сущности пропускается\. | diff --git a/Documentation/Pf2eDataScrapper/SourceProcessor.Process().md b/Documentation/Pf2eDataScrapper/SourceProcessor.Process().md new file mode 100644 index 0000000..017a191 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/SourceProcessor.Process().md @@ -0,0 +1,12 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Preparation](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Preparation.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Preparation').[SourceProcessor](SourceProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Preparation\.SourceProcessor') + +## SourceProcessor\.Process\(\) Method + +Основной метод обработки данных\. + +```csharp +public override void Process(); +``` + +Implements [Process\(\)](IProcessor.Process().md 'Pf2eDataScrapper\.Processors\.Definitions\.IProcessor\.Process\(\)') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/SourceProcessor.Save().md b/Documentation/Pf2eDataScrapper/SourceProcessor.Save().md new file mode 100644 index 0000000..11d97bf --- /dev/null +++ b/Documentation/Pf2eDataScrapper/SourceProcessor.Save().md @@ -0,0 +1,12 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Preparation](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Preparation.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Preparation').[SourceProcessor](SourceProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Preparation\.SourceProcessor') + +## SourceProcessor\.Save\(\) Method + +Метод для сохранения изменений в базе данных\. + +```csharp +public override void Save(); +``` + +Implements [Save\(\)](IProcessor.Save().md 'Pf2eDataScrapper\.Processors\.Definitions\.IProcessor\.Save\(\)') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/SourceProcessor.Source.md b/Documentation/Pf2eDataScrapper/SourceProcessor.Source.md new file mode 100644 index 0000000..4af2d8f --- /dev/null +++ b/Documentation/Pf2eDataScrapper/SourceProcessor.Source.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Preparation](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Preparation.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Preparation').[SourceProcessor](SourceProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Preparation\.SourceProcessor') + +## SourceProcessor\.Source Field + +Источник сущности\. + +```csharp +protected Source Source; +``` + +#### Field Value +[Pf2eModel\.Model\.Base\.Source\.Source](https://docs.microsoft.com/en-us/dotnet/api/Pf2eModel.Model.Base.Source.Source 'Pf2eModel\.Model\.Base\.Source\.Source') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/SourceProcessor.md b/Documentation/Pf2eDataScrapper/SourceProcessor.md new file mode 100644 index 0000000..e8429b7 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/SourceProcessor.md @@ -0,0 +1,19 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Preparation](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Preparation.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Preparation') + +## SourceProcessor Class + +```csharp +internal class SourceProcessor : Pf2eDataScrapper.Processors.Definitions.AbstractInputProcessor +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [AbstractInputProcessor](AbstractInputProcessor.md 'Pf2eDataScrapper\.Processors\.Definitions\.AbstractInputProcessor') 🡒 SourceProcessor + +| Fields | | +| :--- | :--- | +| [Source](SourceProcessor.Source.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Preparation\.SourceProcessor\.Source') | Источник сущности\. | + +| Methods | | +| :--- | :--- | +| [Process\(\)](SourceProcessor.Process().md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Preparation\.SourceProcessor\.Process\(\)') | Основной метод обработки данных\. | +| [Save\(\)](SourceProcessor.Save().md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Preparation\.SourceProcessor\.Save\(\)') | Метод для сохранения изменений в базе данных\. | diff --git a/Documentation/Pf2eDataScrapper/SpellProcessor.Add().md b/Documentation/Pf2eDataScrapper/SpellProcessor.Add().md new file mode 100644 index 0000000..01a8184 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/SpellProcessor.Add().md @@ -0,0 +1,10 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types').[SpellProcessor](SpellProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.SpellProcessor') + +## SpellProcessor\.Add\(\) Method + +Добавление основной сущности в контекст базы данных\. + +```csharp +protected override void Add(); +``` \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/SpellProcessor.AddedDescriptionPaths().md b/Documentation/Pf2eDataScrapper/SpellProcessor.AddedDescriptionPaths().md new file mode 100644 index 0000000..a18743e --- /dev/null +++ b/Documentation/Pf2eDataScrapper/SpellProcessor.AddedDescriptionPaths().md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types').[SpellProcessor](SpellProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.SpellProcessor') + +## SpellProcessor\.AddedDescriptionPaths\(\) Method + +Получение списка полей, которые должны быть добавлены в описание\. + +```csharp +protected virtual string[] AddedDescriptionPaths(); +``` + +#### Returns +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String')[\[\]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System\.Array') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/SpellProcessor.Object.md b/Documentation/Pf2eDataScrapper/SpellProcessor.Object.md new file mode 100644 index 0000000..c774f8b --- /dev/null +++ b/Documentation/Pf2eDataScrapper/SpellProcessor.Object.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types').[SpellProcessor](SpellProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.SpellProcessor') + +## SpellProcessor\.Object Property + +Основная сущность\. + +```csharp +public virtual Pf2eModel.Model.Structure.Spell Object { get; } +``` + +#### Property Value +[Pf2eModel\.Model\.Structure\.Spell](https://docs.microsoft.com/en-us/dotnet/api/Pf2eModel.Model.Structure.Spell 'Pf2eModel\.Model\.Structure\.Spell') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/SpellProcessor.Process().md b/Documentation/Pf2eDataScrapper/SpellProcessor.Process().md new file mode 100644 index 0000000..23394b0 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/SpellProcessor.Process().md @@ -0,0 +1,12 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types').[SpellProcessor](SpellProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.SpellProcessor') + +## SpellProcessor\.Process\(\) Method + +Основной метод обработки данных\. + +```csharp +public override void Process(); +``` + +Implements [Process\(\)](IProcessor.Process().md 'Pf2eDataScrapper\.Processors\.Definitions\.IProcessor\.Process\(\)') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/SpellProcessor.ProcessArea().md b/Documentation/Pf2eDataScrapper/SpellProcessor.ProcessArea().md new file mode 100644 index 0000000..1d859d2 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/SpellProcessor.ProcessArea().md @@ -0,0 +1,10 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types').[SpellProcessor](SpellProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.SpellProcessor') + +## SpellProcessor\.ProcessArea\(\) Method + +Обработка области применения заклинания\. + +```csharp +private void ProcessArea(); +``` \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/SpellProcessor.Type.md b/Documentation/Pf2eDataScrapper/SpellProcessor.Type.md new file mode 100644 index 0000000..e4bb28a --- /dev/null +++ b/Documentation/Pf2eDataScrapper/SpellProcessor.Type.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types').[SpellProcessor](SpellProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.SpellProcessor') + +## SpellProcessor\.Type Property + +Тип сущности\. + +```csharp +public override Pf2eModel.Model.Enum.EntityType Type { get; } +``` + +#### Property Value +[Pf2eModel\.Model\.Enum\.EntityType](https://docs.microsoft.com/en-us/dotnet/api/Pf2eModel.Model.Enum.EntityType 'Pf2eModel\.Model\.Enum\.EntityType') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/SpellProcessor.md b/Documentation/Pf2eDataScrapper/SpellProcessor.md new file mode 100644 index 0000000..7507354 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/SpellProcessor.md @@ -0,0 +1,22 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types') + +## SpellProcessor Class + +```csharp +internal class SpellProcessor : Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.AbstractEntityProcessor +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [AbstractInputProcessor](AbstractInputProcessor.md 'Pf2eDataScrapper\.Processors\.Definitions\.AbstractInputProcessor') 🡒 [AbstractEntityProcessor](AbstractEntityProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.AbstractEntityProcessor') 🡒 SpellProcessor + +| Properties | | +| :--- | :--- | +| [Object](SpellProcessor.Object.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.SpellProcessor\.Object') | Основная сущность\. | +| [Type](SpellProcessor.Type.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.SpellProcessor\.Type') | Тип сущности\. | + +| Methods | | +| :--- | :--- | +| [Add\(\)](SpellProcessor.Add().md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.SpellProcessor\.Add\(\)') | Добавление основной сущности в контекст базы данных\. | +| [AddedDescriptionPaths\(\)](SpellProcessor.AddedDescriptionPaths().md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.SpellProcessor\.AddedDescriptionPaths\(\)') | Получение списка полей, которые должны быть добавлены в описание\. | +| [Process\(\)](SpellProcessor.Process().md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.SpellProcessor\.Process\(\)') | Основной метод обработки данных\. | +| [ProcessArea\(\)](SpellProcessor.ProcessArea().md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.SpellProcessor\.ProcessArea\(\)') | Обработка области применения заклинания\. | diff --git a/Documentation/Pf2eDataScrapper/StartForm.InitializeComponent().md b/Documentation/Pf2eDataScrapper/StartForm.InitializeComponent().md new file mode 100644 index 0000000..92d1ba5 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StartForm.InitializeComponent().md @@ -0,0 +1,12 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.StartForm](Pf2eDataScrapper.WPF.StartForm.md 'Pf2eDataScrapper\.WPF\.StartForm').[StartForm](StartForm.md 'Pf2eDataScrapper\.WPF\.StartForm\.StartForm') + +## StartForm\.InitializeComponent\(\) Method + +InitializeComponent + +```csharp +public void InitializeComponent(); +``` + +Implements [InitializeComponent\(\)](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.Markup.IComponentConnector.InitializeComponent 'System\.Windows\.Markup\.IComponentConnector\.InitializeComponent') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StartForm.md b/Documentation/Pf2eDataScrapper/StartForm.md new file mode 100644 index 0000000..aa3094f --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StartForm.md @@ -0,0 +1,16 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.StartForm](Pf2eDataScrapper.WPF.StartForm.md 'Pf2eDataScrapper\.WPF\.StartForm') + +## StartForm Class + +```csharp +internal class StartForm : System.Windows.Window, System.Windows.Markup.IComponentConnector +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [System\.Windows\.Threading\.DispatcherObject](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.Threading.DispatcherObject 'System\.Windows\.Threading\.DispatcherObject') 🡒 [System\.Windows\.DependencyObject](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.DependencyObject 'System\.Windows\.DependencyObject') 🡒 [System\.Windows\.Media\.Visual](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.Media.Visual 'System\.Windows\.Media\.Visual') 🡒 [System\.Windows\.UIElement](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.UIElement 'System\.Windows\.UIElement') 🡒 [System\.Windows\.FrameworkElement](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.FrameworkElement 'System\.Windows\.FrameworkElement') 🡒 [System\.Windows\.Controls\.Control](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.Controls.Control 'System\.Windows\.Controls\.Control') 🡒 [System\.Windows\.Controls\.ContentControl](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.Controls.ContentControl 'System\.Windows\.Controls\.ContentControl') 🡒 [System\.Windows\.Window](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.Window 'System\.Windows\.Window') 🡒 StartForm + +Implements [System\.Windows\.Markup\.IComponentConnector](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.Markup.IComponentConnector 'System\.Windows\.Markup\.IComponentConnector') + +| Methods | | +| :--- | :--- | +| [InitializeComponent\(\)](StartForm.InitializeComponent().md 'Pf2eDataScrapper\.WPF\.StartForm\.StartForm\.InitializeComponent\(\)') | InitializeComponent | diff --git a/Documentation/Pf2eDataScrapper/StaticSchemaType.AddValue(JToken).md b/Documentation/Pf2eDataScrapper/StaticSchemaType.AddValue(JToken).md new file mode 100644 index 0000000..83cdcef --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StaticSchemaType.AddValue(JToken).md @@ -0,0 +1,17 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder\.Types](Pf2eDataScrapper.SchemaBuilder.Types.md 'Pf2eDataScrapper\.SchemaBuilder\.Types').[StaticSchemaType](StaticSchemaType.md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.StaticSchemaType') + +## StaticSchemaType\.AddValue\(JToken\) Method + +Добавление нового значения\. + +```csharp +public override void AddValue(Newtonsoft.Json.Linq.JToken value); +``` +#### Parameters + + + +`value` [Newtonsoft\.Json\.Linq\.JToken](https://docs.microsoft.com/en-us/dotnet/api/Newtonsoft.Json.Linq.JToken 'Newtonsoft\.Json\.Linq\.JToken') + +Новое значение\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StaticSchemaType.Beautify().md b/Documentation/Pf2eDataScrapper/StaticSchemaType.Beautify().md new file mode 100644 index 0000000..7c5a90a --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StaticSchemaType.Beautify().md @@ -0,0 +1,10 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder\.Types](Pf2eDataScrapper.SchemaBuilder.Types.md 'Pf2eDataScrapper\.SchemaBuilder\.Types').[StaticSchemaType](StaticSchemaType.md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.StaticSchemaType') + +## StaticSchemaType\.Beautify\(\) Method + +Подготовка типа к красивому представлению\. + +```csharp +public override void Beautify(); +``` \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StaticSchemaType.GetTypeName().md b/Documentation/Pf2eDataScrapper/StaticSchemaType.GetTypeName().md new file mode 100644 index 0000000..c731262 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StaticSchemaType.GetTypeName().md @@ -0,0 +1,14 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder\.Types](Pf2eDataScrapper.SchemaBuilder.Types.md 'Pf2eDataScrapper\.SchemaBuilder\.Types').[StaticSchemaType](StaticSchemaType.md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.StaticSchemaType') + +## StaticSchemaType\.GetTypeName\(\) Method + +Получение строкового представоения типа элемента\. + +```csharp +public override string GetTypeName(); +``` + +#### Returns +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') +Строковое представоение типа элемента \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StaticSchemaType.GetYamlData().md b/Documentation/Pf2eDataScrapper/StaticSchemaType.GetYamlData().md new file mode 100644 index 0000000..19eacef --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StaticSchemaType.GetYamlData().md @@ -0,0 +1,14 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder\.Types](Pf2eDataScrapper.SchemaBuilder.Types.md 'Pf2eDataScrapper\.SchemaBuilder\.Types').[StaticSchemaType](StaticSchemaType.md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.StaticSchemaType') + +## StaticSchemaType\.GetYamlData\(\) Method + +Получение данных для форматирования в YAML\. + +```csharp +public override System.Collections.Generic.Dictionary GetYamlData(); +``` + +#### Returns +[System\.Collections\.Generic\.Dictionary<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.Dictionary-2 'System\.Collections\.Generic\.Dictionary\`2')[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.Dictionary-2 'System\.Collections\.Generic\.Dictionary\`2')[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.Dictionary-2 'System\.Collections\.Generic\.Dictionary\`2') +Словарь данных \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StaticSchemaType.IsCompatibleValue(JToken).md b/Documentation/Pf2eDataScrapper/StaticSchemaType.IsCompatibleValue(JToken).md new file mode 100644 index 0000000..be88e95 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StaticSchemaType.IsCompatibleValue(JToken).md @@ -0,0 +1,21 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder\.Types](Pf2eDataScrapper.SchemaBuilder.Types.md 'Pf2eDataScrapper\.SchemaBuilder\.Types').[StaticSchemaType](StaticSchemaType.md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.StaticSchemaType') + +## StaticSchemaType\.IsCompatibleValue\(JToken\) Method + +Проверка, что значение совместимо с текущим типом\. + +```csharp +public override bool IsCompatibleValue(Newtonsoft.Json.Linq.JToken value); +``` +#### Parameters + + + +`value` [Newtonsoft\.Json\.Linq\.JToken](https://docs.microsoft.com/en-us/dotnet/api/Newtonsoft.Json.Linq.JToken 'Newtonsoft\.Json\.Linq\.JToken') + +Проверяемое значение\. + +#### Returns +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') +\`true\`, если значение совместимо с текущим типом\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StaticSchemaType.StaticSchemaType(SchemaNode,JTokenType).md b/Documentation/Pf2eDataScrapper/StaticSchemaType.StaticSchemaType(SchemaNode,JTokenType).md new file mode 100644 index 0000000..ecdd653 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StaticSchemaType.StaticSchemaType(SchemaNode,JTokenType).md @@ -0,0 +1,23 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder\.Types](Pf2eDataScrapper.SchemaBuilder.Types.md 'Pf2eDataScrapper\.SchemaBuilder\.Types').[StaticSchemaType](StaticSchemaType.md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.StaticSchemaType') + +## StaticSchemaType\(SchemaNode, JTokenType\) Constructor + +Тип представоления простых значений в схеме\. + +```csharp +public StaticSchemaType(Pf2eDataScrapper.SchemaBuilder.SchemaNode parent, Newtonsoft.Json.Linq.JTokenType type); +``` +#### Parameters + + + +`parent` [SchemaNode](SchemaNode.md 'Pf2eDataScrapper\.SchemaBuilder\.SchemaNode') + +Элемент, к которому добавляется тип\. + + + +`type` [Newtonsoft\.Json\.Linq\.JTokenType](https://docs.microsoft.com/en-us/dotnet/api/Newtonsoft.Json.Linq.JTokenType 'Newtonsoft\.Json\.Linq\.JTokenType') + +Тип значения\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StaticSchemaType.Type.md b/Documentation/Pf2eDataScrapper/StaticSchemaType.Type.md new file mode 100644 index 0000000..44c55f3 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StaticSchemaType.Type.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder\.Types](Pf2eDataScrapper.SchemaBuilder.Types.md 'Pf2eDataScrapper\.SchemaBuilder\.Types').[StaticSchemaType](StaticSchemaType.md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.StaticSchemaType') + +## StaticSchemaType\.Type Field + +Тип значения\. + +```csharp +protected readonly JTokenType Type; +``` + +#### Field Value +[Newtonsoft\.Json\.Linq\.JTokenType](https://docs.microsoft.com/en-us/dotnet/api/Newtonsoft.Json.Linq.JTokenType 'Newtonsoft\.Json\.Linq\.JTokenType') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StaticSchemaType.Values.md b/Documentation/Pf2eDataScrapper/StaticSchemaType.Values.md new file mode 100644 index 0000000..08f06a6 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StaticSchemaType.Values.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder\.Types](Pf2eDataScrapper.SchemaBuilder.Types.md 'Pf2eDataScrapper\.SchemaBuilder\.Types').[StaticSchemaType](StaticSchemaType.md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.StaticSchemaType') + +## StaticSchemaType\.Values Field + +Набор возможных значений и их количества\. + +```csharp +protected Dictionary Values; +``` + +#### Field Value +[System\.Collections\.Generic\.Dictionary<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.Dictionary-2 'System\.Collections\.Generic\.Dictionary\`2')[Newtonsoft\.Json\.Linq\.JToken](https://docs.microsoft.com/en-us/dotnet/api/Newtonsoft.Json.Linq.JToken 'Newtonsoft\.Json\.Linq\.JToken')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.Dictionary-2 'System\.Collections\.Generic\.Dictionary\`2')[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.Dictionary-2 'System\.Collections\.Generic\.Dictionary\`2') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StaticSchemaType.md b/Documentation/Pf2eDataScrapper/StaticSchemaType.md new file mode 100644 index 0000000..7de6f5a --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StaticSchemaType.md @@ -0,0 +1,29 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder\.Types](Pf2eDataScrapper.SchemaBuilder.Types.md 'Pf2eDataScrapper\.SchemaBuilder\.Types') + +## StaticSchemaType Class + +Тип представоления простых значений в схеме\. + +```csharp +internal class StaticSchemaType : Pf2eDataScrapper.SchemaBuilder.Types.AbstractSchemaType +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [AbstractSchemaType](AbstractSchemaType.md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.AbstractSchemaType') 🡒 StaticSchemaType + +| Constructors | | +| :--- | :--- | +| [StaticSchemaType\(SchemaNode, JTokenType\)](StaticSchemaType.StaticSchemaType(SchemaNode,JTokenType).md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.StaticSchemaType\.StaticSchemaType\(Pf2eDataScrapper\.SchemaBuilder\.SchemaNode, Newtonsoft\.Json\.Linq\.JTokenType\)') | Тип представоления простых значений в схеме\. | + +| Fields | | +| :--- | :--- | +| [Type](StaticSchemaType.Type.md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.StaticSchemaType\.Type') | Тип значения\. | +| [Values](StaticSchemaType.Values.md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.StaticSchemaType\.Values') | Набор возможных значений и их количества\. | + +| Methods | | +| :--- | :--- | +| [AddValue\(JToken\)](StaticSchemaType.AddValue(JToken).md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.StaticSchemaType\.AddValue\(Newtonsoft\.Json\.Linq\.JToken\)') | Добавление нового значения\. | +| [Beautify\(\)](StaticSchemaType.Beautify().md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.StaticSchemaType\.Beautify\(\)') | Подготовка типа к красивому представлению\. | +| [GetTypeName\(\)](StaticSchemaType.GetTypeName().md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.StaticSchemaType\.GetTypeName\(\)') | Получение строкового представоения типа элемента\. | +| [GetYamlData\(\)](StaticSchemaType.GetYamlData().md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.StaticSchemaType\.GetYamlData\(\)') | Получение данных для форматирования в YAML\. | +| [IsCompatibleValue\(JToken\)](StaticSchemaType.IsCompatibleValue(JToken).md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.StaticSchemaType\.IsCompatibleValue\(Newtonsoft\.Json\.Linq\.JToken\)') | Проверка, что значение совместимо с текущим типом\. | diff --git a/Documentation/Pf2eDataScrapper/StringHelper.LinkRegex().md b/Documentation/Pf2eDataScrapper/StringHelper.LinkRegex().md new file mode 100644 index 0000000..e641e48 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StringHelper.LinkRegex().md @@ -0,0 +1,31 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers](Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers').[StringHelper](StringHelper.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.StringHelper') + +## StringHelper\.LinkRegex\(\) Method + +```csharp +public static System.Text.RegularExpressions.Regex LinkRegex(); +``` + +#### Returns +[System\.Text\.RegularExpressions\.Regex](https://docs.microsoft.com/en-us/dotnet/api/System.Text.RegularExpressions.Regex 'System\.Text\.RegularExpressions\.Regex') + +### Remarks +Pattern:
+ +```csharp +(.*?)\\[(.*?)\\]\\((.*?)\\) +```
+Explanation:
+ +```csharp +○ 1st capture group.
+ ○ Match a character other than '\n' lazily any number of times.
+○ Match '['.
+○ 2nd capture group.
+ ○ Match a character other than '\n' lazily any number of times.
+○ Match the string "](".
+○ 3rd capture group.
+ ○ Match a character other than '\n' lazily any number of times.
+○ Match ')'.
+``` \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StringHelper.ParseMarkdownLinks(string).md b/Documentation/Pf2eDataScrapper/StringHelper.ParseMarkdownLinks(string).md new file mode 100644 index 0000000..9020b7b --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StringHelper.ParseMarkdownLinks(string).md @@ -0,0 +1,21 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers](Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers').[StringHelper](StringHelper.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.StringHelper') + +## StringHelper\.ParseMarkdownLinks\(string\) Method + +Разбор списка ссылок в исходной строке\. + +```csharp +public Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.MarkdownLinkSplit ParseMarkdownLinks(string input); +``` +#### Parameters + + + +`input` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +Исходная строка\. + +#### Returns +[MarkdownLinkSplit](MarkdownLinkSplit.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.MarkdownLinkSplit') +Структура, содеражащая информацию разбиении строки по ссылкам\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StringHelper.ResolveSourceSuffix(string).md b/Documentation/Pf2eDataScrapper/StringHelper.ResolveSourceSuffix(string).md new file mode 100644 index 0000000..fe341b5 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StringHelper.ResolveSourceSuffix(string).md @@ -0,0 +1,21 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers](Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers').[StringHelper](StringHelper.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.StringHelper') + +## StringHelper\.ResolveSourceSuffix\(string\) Method + +Извлечение суффикса из описания источника\. + +```csharp +public string ResolveSourceSuffix(string input); +``` +#### Parameters + + + +`input` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +Исходная строка\. + +#### Returns +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') +Суффикс\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StringHelper.RowSplit(string).md b/Documentation/Pf2eDataScrapper/StringHelper.RowSplit(string).md new file mode 100644 index 0000000..d97b71a --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StringHelper.RowSplit(string).md @@ -0,0 +1,21 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers](Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers').[StringHelper](StringHelper.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.StringHelper') + +## StringHelper\.RowSplit\(string\) Method + +Разбиение строки по нестабильным строковым разделителям \(например, `", "`, `" or "` и т\.д\.\)\. + +```csharp +public System.Collections.Generic.List RowSplit(string value); +``` +#### Parameters + + + +`value` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +Исходная строка\. + +#### Returns +[System\.Collections\.Generic\.List<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.List-1 'System\.Collections\.Generic\.List\`1')[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.List-1 'System\.Collections\.Generic\.List\`1') +Коллекция строк\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StringHelper.SourceSuffixRegex().md b/Documentation/Pf2eDataScrapper/StringHelper.SourceSuffixRegex().md new file mode 100644 index 0000000..cd63fa6 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StringHelper.SourceSuffixRegex().md @@ -0,0 +1,32 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers](Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers').[StringHelper](StringHelper.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.StringHelper') + +## StringHelper\.SourceSuffixRegex\(\) Method + +```csharp +public static System.Text.RegularExpressions.Regex SourceSuffixRegex(); +``` + +#### Returns +[System\.Text\.RegularExpressions\.Regex](https://docs.microsoft.com/en-us/dotnet/api/System.Text.RegularExpressions.Regex 'System\.Text\.RegularExpressions\.Regex') + +### Remarks +Pattern:
+ +```csharp +^\\[.*?\\]\\(.*?\\)\\s+(.*)$ +```
+Explanation:
+ +```csharp +○ Match if at the beginning of the string.
+○ Match '['.
+○ Match a character other than '\n' lazily any number of times.
+○ Match the string "](".
+○ Match a character other than '\n' lazily any number of times.
+○ Match ')'.
+○ Match a whitespace character greedily at least once.
+○ 1st capture group.
+ ○ Match a character other than '\n' greedily any number of times.
+○ Match if at the end of the string or if before an ending newline.
+``` \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StringHelper.StringHelper().md b/Documentation/Pf2eDataScrapper/StringHelper.StringHelper().md new file mode 100644 index 0000000..d16e1d8 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StringHelper.StringHelper().md @@ -0,0 +1,10 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers](Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers').[StringHelper](StringHelper.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.StringHelper') + +## StringHelper\(\) Constructor + +Конструктор класса [StringHelper](StringHelper.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.StringHelper') + +```csharp +public StringHelper(); +``` \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StringHelper.md b/Documentation/Pf2eDataScrapper/StringHelper.md new file mode 100644 index 0000000..752b9ac --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StringHelper.md @@ -0,0 +1,25 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers](Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers') + +## StringHelper Class + +Класс\-помощник, для обработки строкового ввода с Архивов Нефиса\. +Реализует шаблон `Singleton`\. + +```csharp +internal class StringHelper +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 StringHelper + +| Constructors | | +| :--- | :--- | +| [StringHelper\(\)](StringHelper.StringHelper().md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.StringHelper\.StringHelper\(\)') | Конструктор класса [StringHelper](StringHelper.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.StringHelper') | + +| Methods | | +| :--- | :--- | +| [LinkRegex\(\)](StringHelper.LinkRegex().md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.StringHelper\.LinkRegex\(\)') | | +| [ParseMarkdownLinks\(string\)](StringHelper.ParseMarkdownLinks(string).md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.StringHelper\.ParseMarkdownLinks\(string\)') | Разбор списка ссылок в исходной строке\. | +| [ResolveSourceSuffix\(string\)](StringHelper.ResolveSourceSuffix(string).md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.StringHelper\.ResolveSourceSuffix\(string\)') | Извлечение суффикса из описания источника\. | +| [RowSplit\(string\)](StringHelper.RowSplit(string).md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.StringHelper\.RowSplit\(string\)') | Разбиение строки по нестабильным строковым разделителям \(например, `", "`, `" or "` и т\.д\.\)\. | +| [SourceSuffixRegex\(\)](StringHelper.SourceSuffixRegex().md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers\.StringHelper\.SourceSuffixRegex\(\)') | | diff --git a/Documentation/Pf2eDataScrapper/StructureBuilder.CompleteProcessed(object,StructureFieldComplex).md b/Documentation/Pf2eDataScrapper/StructureBuilder.CompleteProcessed(object,StructureFieldComplex).md new file mode 100644 index 0000000..e1978c7 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureBuilder.CompleteProcessed(object,StructureFieldComplex).md @@ -0,0 +1,23 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[StructureBuilder](StructureBuilder.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureBuilder') + +## StructureBuilder\.CompleteProcessed\(object, StructureFieldComplex\) Method + +Дополнить обработанный объект\. + +```csharp +public void CompleteProcessed(object value, Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.StructureFieldComplex field); +``` +#### Parameters + + + +`value` [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') + +Значение\. + + + +`field` [StructureFieldComplex](StructureFieldComplex.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldComplex') + +Поле объекта\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StructureBuilder.Create(string,object,int).md b/Documentation/Pf2eDataScrapper/StructureBuilder.Create(string,object,int).md new file mode 100644 index 0000000..eed7c31 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureBuilder.Create(string,object,int).md @@ -0,0 +1,33 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[StructureBuilder](StructureBuilder.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureBuilder') + +## StructureBuilder\.Create\(string, object, int\) Method + +Создание поля структуры\. + +```csharp +public Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.StructureFieldComplex Create(string name, object value, int depth=0); +``` +#### Parameters + + + +`name` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +Название поля\. + + + +`value` [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') + +Значение поля\. + + + +`depth` [System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') + +Глубина, на котором поле отображается\. + +#### Returns +[StructureFieldComplex](StructureFieldComplex.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldComplex') +Поле структуры\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StructureBuilder.GetFieldType(object).md b/Documentation/Pf2eDataScrapper/StructureBuilder.GetFieldType(object).md new file mode 100644 index 0000000..cace7a3 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureBuilder.GetFieldType(object).md @@ -0,0 +1,21 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[StructureBuilder](StructureBuilder.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureBuilder') + +## StructureBuilder\.GetFieldType\(object\) Method + +Получить тип поля структуры по значению\. + +```csharp +public static Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.StructureFieldType GetFieldType(object? value); +``` +#### Parameters + + + +`value` [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') + +Значение поля\. + +#### Returns +[StructureFieldType](StructureFieldType.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldType') +Тип поля структуры\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StructureBuilder.RegisterProcessed(object).md b/Documentation/Pf2eDataScrapper/StructureBuilder.RegisterProcessed(object).md new file mode 100644 index 0000000..328bde4 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureBuilder.RegisterProcessed(object).md @@ -0,0 +1,21 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[StructureBuilder](StructureBuilder.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureBuilder') + +## StructureBuilder\.RegisterProcessed\(object\) Method + +Регистрация обработанного объекта\. + +```csharp +public bool RegisterProcessed(object value); +``` +#### Parameters + + + +`value` [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') + +Регистрируемый объект\. + +#### Returns +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') +\`true\`, если объект был добавлен; \`false\`, если объект был добавлен ранее\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StructureBuilder.Resolve(string,object,int).md b/Documentation/Pf2eDataScrapper/StructureBuilder.Resolve(string,object,int).md new file mode 100644 index 0000000..c041890 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureBuilder.Resolve(string,object,int).md @@ -0,0 +1,32 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[StructureBuilder](StructureBuilder.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureBuilder') + +## StructureBuilder\.Resolve\(string, object, int\) Method + +Выбор поля структуры по значению\. + +```csharp +public Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.StructureField Resolve(string name, object? value, int depth); +``` +#### Parameters + + + +`name` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +Название поля\. + + + +`value` [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') + +Значение поля\. + + + +`depth` [System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') + +Глубина, на котором поле отображается\. + +#### Returns +[StructureField](StructureField.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureField') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StructureBuilder._processedObjects.md b/Documentation/Pf2eDataScrapper/StructureBuilder._processedObjects.md new file mode 100644 index 0000000..10fa8ae --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureBuilder._processedObjects.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[StructureBuilder](StructureBuilder.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureBuilder') + +## StructureBuilder\.\_processedObjects Field + +Список обработанных объектов\. + +```csharp +private readonly List _processedObjects; +``` + +#### Field Value +[System\.Collections\.Generic\.List<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.List-1 'System\.Collections\.Generic\.List\`1')[StructureProcessedObject](StructureProcessedObject.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureProcessedObject')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.List-1 'System\.Collections\.Generic\.List\`1') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StructureBuilder.md b/Documentation/Pf2eDataScrapper/StructureBuilder.md new file mode 100644 index 0000000..d25c162 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureBuilder.md @@ -0,0 +1,24 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure') + +## StructureBuilder Class + +Класс для построения структуры данных класса\. + +```csharp +internal class StructureBuilder +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 StructureBuilder + +| Fields | | +| :--- | :--- | +| [\_processedObjects](StructureBuilder._processedObjects.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureBuilder\.\_processedObjects') | Список обработанных объектов\. | + +| Methods | | +| :--- | :--- | +| [CompleteProcessed\(object, StructureFieldComplex\)](StructureBuilder.CompleteProcessed(object,StructureFieldComplex).md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureBuilder\.CompleteProcessed\(object, Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldComplex\)') | Дополнить обработанный объект\. | +| [Create\(string, object, int\)](StructureBuilder.Create(string,object,int).md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureBuilder\.Create\(string, object, int\)') | Создание поля структуры\. | +| [GetFieldType\(object\)](StructureBuilder.GetFieldType(object).md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureBuilder\.GetFieldType\(object\)') | Получить тип поля структуры по значению\. | +| [RegisterProcessed\(object\)](StructureBuilder.RegisterProcessed(object).md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureBuilder\.RegisterProcessed\(object\)') | Регистрация обработанного объекта\. | +| [Resolve\(string, object, int\)](StructureBuilder.Resolve(string,object,int).md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureBuilder\.Resolve\(string, object, int\)') | Выбор поля структуры по значению\. | diff --git a/Documentation/Pf2eDataScrapper/StructureField.Builder.md b/Documentation/Pf2eDataScrapper/StructureField.Builder.md new file mode 100644 index 0000000..bbceee4 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureField.Builder.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[StructureField](StructureField.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureField') + +## StructureField\.Builder Property + +Класс построения структуры данных\. + +```csharp +public Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.StructureBuilder Builder { get; } +``` + +#### Property Value +[StructureBuilder](StructureBuilder.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureBuilder') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StructureField.Depth.md b/Documentation/Pf2eDataScrapper/StructureField.Depth.md new file mode 100644 index 0000000..ce57787 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureField.Depth.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[StructureField](StructureField.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureField') + +## StructureField\.Depth Property + +Глубина поля структуры\. + +```csharp +public int Depth { get; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StructureField.FieldType.md b/Documentation/Pf2eDataScrapper/StructureField.FieldType.md new file mode 100644 index 0000000..c87b29b --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureField.FieldType.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[StructureField](StructureField.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureField') + +## StructureField\.FieldType Property + +Тип поля структуры\. + +```csharp +public abstract Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.StructureFieldType FieldType { get; } +``` + +#### Property Value +[StructureFieldType](StructureFieldType.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldType') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StructureField.GetRows_T_(Func_StructureField,T_).md b/Documentation/Pf2eDataScrapper/StructureField.GetRows_T_(Func_StructureField,T_).md new file mode 100644 index 0000000..dfe49ed --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureField.GetRows_T_(Func_StructureField,T_).md @@ -0,0 +1,28 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[StructureField](StructureField.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureField') + +## StructureField\.GetRows\\(Func\\) Method + +Получить набор строк, используя результат функция\. + +```csharp +public virtual System.Collections.Generic.ICollection GetRows(System.Func func); +``` +#### Type parameters + + + +`T` + +Тип результирующей строки\. +#### Parameters + + + +`func` [System\.Func<](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System\.Func\`2')[StructureField](StructureField.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureField')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System\.Func\`2')[T](StructureField.GetRows_T_(Func_StructureField,T_).md#Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.StructureField.GetRows_T_(System.Func_Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.StructureField,T_).T 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureField\.GetRows\\(System\.Func\\)\.T')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System\.Func\`2') + +Функция, оборажения поля в результирующую строку\. + +#### Returns +[System\.Collections\.Generic\.ICollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1')[T](StructureField.GetRows_T_(Func_StructureField,T_).md#Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.StructureField.GetRows_T_(System.Func_Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.StructureField,T_).T 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureField\.GetRows\\(System\.Func\\)\.T')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1') +Коллекция, содержащая набор строк\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StructureField.GetTypeString().md b/Documentation/Pf2eDataScrapper/StructureField.GetTypeString().md new file mode 100644 index 0000000..18a7e1f --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureField.GetTypeString().md @@ -0,0 +1,14 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[StructureField](StructureField.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureField') + +## StructureField\.GetTypeString\(\) Method + +Получить строку, представляющую тип поля\. + +```csharp +public abstract string GetTypeString(); +``` + +#### Returns +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') +Строка, представляющая тип поля\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StructureField.GetValueString().md b/Documentation/Pf2eDataScrapper/StructureField.GetValueString().md new file mode 100644 index 0000000..a5d47a0 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureField.GetValueString().md @@ -0,0 +1,14 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[StructureField](StructureField.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureField') + +## StructureField\.GetValueString\(\) Method + +Получить строку, представляющую значение поля\. + +```csharp +public abstract string GetValueString(); +``` + +#### Returns +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') +Строка, представляющая значение поля\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StructureField.Name.md b/Documentation/Pf2eDataScrapper/StructureField.Name.md new file mode 100644 index 0000000..529e710 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureField.Name.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[StructureField](StructureField.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureField') + +## StructureField\.Name Property + +Название поля\. + +```csharp +public string Name { get; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StructureField.OnPropertyChanged(string).md b/Documentation/Pf2eDataScrapper/StructureField.OnPropertyChanged(string).md new file mode 100644 index 0000000..e386abd --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureField.OnPropertyChanged(string).md @@ -0,0 +1,17 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[StructureField](StructureField.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureField') + +## StructureField\.OnPropertyChanged\(string\) Method + +Запустить событие изменения поля\. + +```csharp +protected virtual void OnPropertyChanged(string? propertyName=null); +``` +#### Parameters + + + +`propertyName` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +Название поля\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StructureField.PropertyChanged.md b/Documentation/Pf2eDataScrapper/StructureField.PropertyChanged.md new file mode 100644 index 0000000..6798e49 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureField.PropertyChanged.md @@ -0,0 +1,15 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[StructureField](StructureField.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureField') + +## StructureField\.PropertyChanged Event + +Событие изменения поля\. + +```csharp +public event PropertyChangedEventHandler? PropertyChanged; +``` + +Implements [PropertyChanged](https://docs.microsoft.com/en-us/dotnet/api/System.ComponentModel.INotifyPropertyChanged.PropertyChanged 'System\.ComponentModel\.INotifyPropertyChanged\.PropertyChanged') + +#### Event Type +[System\.ComponentModel\.PropertyChangedEventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.ComponentModel.PropertyChangedEventHandler 'System\.ComponentModel\.PropertyChangedEventHandler') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StructureField.StructureField(StructureBuilder,string,int).md b/Documentation/Pf2eDataScrapper/StructureField.StructureField(StructureBuilder,string,int).md new file mode 100644 index 0000000..c415fa3 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureField.StructureField(StructureBuilder,string,int).md @@ -0,0 +1,29 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[StructureField](StructureField.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureField') + +## StructureField\(StructureBuilder, string, int\) Constructor + +Базовый класс для полей структуры\. + +```csharp +protected StructureField(Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.StructureBuilder builder, string name, int depth); +``` +#### Parameters + + + +`builder` [StructureBuilder](StructureBuilder.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureBuilder') + +Класс построения структуры данных\. + + + +`name` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +Название поля\. + + + +`depth` [System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') + +Глубина поля\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StructureField.Visible.md b/Documentation/Pf2eDataScrapper/StructureField.Visible.md new file mode 100644 index 0000000..92460a6 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureField.Visible.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[StructureField](StructureField.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureField') + +## StructureField\.Visible Property + +Флаг, указывающий, отображается ли поле\. + +```csharp +public virtual bool Visible { get; set; } +``` + +#### Property Value +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StructureField.md b/Documentation/Pf2eDataScrapper/StructureField.md new file mode 100644 index 0000000..10cf0ad --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureField.md @@ -0,0 +1,45 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure') + +## StructureField Class + +Базовый класс для полей структуры\. + +```csharp +internal abstract class StructureField : System.ComponentModel.INotifyPropertyChanged +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 StructureField + +Derived +↳ [StructureFieldComplex](StructureFieldComplex.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldComplex') +↳ [StructureFieldEnum](StructureFieldEnum.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldEnum') +↳ [StructureFieldIgnored](StructureFieldIgnored.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldIgnored') +↳ [StructureFieldNull](StructureFieldNull.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldNull') +↳ [StructureFieldPrimitive](StructureFieldPrimitive.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldPrimitive') +↳ [StructureFieldReference](StructureFieldReference.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldReference') + +Implements [System\.ComponentModel\.INotifyPropertyChanged](https://docs.microsoft.com/en-us/dotnet/api/System.ComponentModel.INotifyPropertyChanged 'System\.ComponentModel\.INotifyPropertyChanged') + +| Constructors | | +| :--- | :--- | +| [StructureField\(StructureBuilder, string, int\)](StructureField.StructureField(StructureBuilder,string,int).md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureField\.StructureField\(Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureBuilder, string, int\)') | Базовый класс для полей структуры\. | + +| Properties | | +| :--- | :--- | +| [Builder](StructureField.Builder.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureField\.Builder') | Класс построения структуры данных\. | +| [Depth](StructureField.Depth.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureField\.Depth') | Глубина поля структуры\. | +| [FieldType](StructureField.FieldType.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureField\.FieldType') | Тип поля структуры\. | +| [Name](StructureField.Name.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureField\.Name') | Название поля\. | +| [Visible](StructureField.Visible.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureField\.Visible') | Флаг, указывающий, отображается ли поле\. | + +| Methods | | +| :--- | :--- | +| [GetRows<T>\(Func<StructureField,T>\)](StructureField.GetRows_T_(Func_StructureField,T_).md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureField\.GetRows\\(System\.Func\\)') | Получить набор строк, используя результат функция\. | +| [GetTypeString\(\)](StructureField.GetTypeString().md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureField\.GetTypeString\(\)') | Получить строку, представляющую тип поля\. | +| [GetValueString\(\)](StructureField.GetValueString().md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureField\.GetValueString\(\)') | Получить строку, представляющую значение поля\. | +| [OnPropertyChanged\(string\)](StructureField.OnPropertyChanged(string).md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureField\.OnPropertyChanged\(string\)') | Запустить событие изменения поля\. | + +| Events | | +| :--- | :--- | +| [PropertyChanged](StructureField.PropertyChanged.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureField\.PropertyChanged') | Событие изменения поля\. | diff --git a/Documentation/Pf2eDataScrapper/StructureFieldComplex.Collapsable.md b/Documentation/Pf2eDataScrapper/StructureFieldComplex.Collapsable.md new file mode 100644 index 0000000..5cff8bf --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureFieldComplex.Collapsable.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[StructureFieldComplex](StructureFieldComplex.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldComplex') + +## StructureFieldComplex\.Collapsable Property + +Флаг, указывающий, что у этот элемент можно свернуть\. + +```csharp +public bool Collapsable { get; } +``` + +#### Property Value +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StructureFieldComplex.Collapsed.md b/Documentation/Pf2eDataScrapper/StructureFieldComplex.Collapsed.md new file mode 100644 index 0000000..52a31fa --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureFieldComplex.Collapsed.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[StructureFieldComplex](StructureFieldComplex.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldComplex') + +## StructureFieldComplex\.Collapsed Property + +Флаг, указывающий, отображается ли поля объекта\. + +```csharp +public bool Collapsed { get; set; } +``` + +#### Property Value +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StructureFieldComplex.FieldRecord.Allowed.md b/Documentation/Pf2eDataScrapper/StructureFieldComplex.FieldRecord.Allowed.md new file mode 100644 index 0000000..937fb5b --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureFieldComplex.FieldRecord.Allowed.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[StructureFieldComplex](StructureFieldComplex.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldComplex').[FieldRecord](StructureFieldComplex.FieldRecord.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldComplex\.FieldRecord') + +## StructureFieldComplex\.FieldRecord\.Allowed Field + +Флаг, указывающий, использовать ли поле\. + +```csharp +public bool Allowed; +``` + +#### Field Value +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StructureFieldComplex.FieldRecord.FieldRecord(string,object).md b/Documentation/Pf2eDataScrapper/StructureFieldComplex.FieldRecord.FieldRecord(string,object).md new file mode 100644 index 0000000..f51ee6d --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureFieldComplex.FieldRecord.FieldRecord(string,object).md @@ -0,0 +1,23 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[StructureFieldComplex](StructureFieldComplex.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldComplex').[FieldRecord](StructureFieldComplex.FieldRecord.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldComplex\.FieldRecord') + +## FieldRecord\(string, object\) Constructor + +Запись поля структуры\. + +```csharp +public FieldRecord(string name, object? value); +``` +#### Parameters + + + +`name` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +Название поля\. + + + +`value` [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') + +Значение поля\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StructureFieldComplex.FieldRecord.FieldType.md b/Documentation/Pf2eDataScrapper/StructureFieldComplex.FieldRecord.FieldType.md new file mode 100644 index 0000000..c20ea8b --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureFieldComplex.FieldRecord.FieldType.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[StructureFieldComplex](StructureFieldComplex.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldComplex').[FieldRecord](StructureFieldComplex.FieldRecord.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldComplex\.FieldRecord') + +## StructureFieldComplex\.FieldRecord\.FieldType Property + +Тип поля структуры\. + +```csharp +public Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.StructureFieldType FieldType { get; } +``` + +#### Property Value +[StructureFieldType](StructureFieldType.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldType') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StructureFieldComplex.FieldRecord.Name.md b/Documentation/Pf2eDataScrapper/StructureFieldComplex.FieldRecord.Name.md new file mode 100644 index 0000000..17344ce --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureFieldComplex.FieldRecord.Name.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[StructureFieldComplex](StructureFieldComplex.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldComplex').[FieldRecord](StructureFieldComplex.FieldRecord.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldComplex\.FieldRecord') + +## StructureFieldComplex\.FieldRecord\.Name Field + +Название поля\. + +```csharp +public readonly string Name; +``` + +#### Field Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StructureFieldComplex.FieldRecord.Value.md b/Documentation/Pf2eDataScrapper/StructureFieldComplex.FieldRecord.Value.md new file mode 100644 index 0000000..ee47fcb --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureFieldComplex.FieldRecord.Value.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[StructureFieldComplex](StructureFieldComplex.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldComplex').[FieldRecord](StructureFieldComplex.FieldRecord.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldComplex\.FieldRecord') + +## StructureFieldComplex\.FieldRecord\.Value Field + +Значение поля\. + +```csharp +public readonly object? Value; +``` + +#### Field Value +[System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StructureFieldComplex.FieldRecord.md b/Documentation/Pf2eDataScrapper/StructureFieldComplex.FieldRecord.md new file mode 100644 index 0000000..963580f --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureFieldComplex.FieldRecord.md @@ -0,0 +1,26 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[StructureFieldComplex](StructureFieldComplex.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldComplex') + +## StructureFieldComplex\.FieldRecord Class + +Запись поля структуры\. + +```csharp +private class StructureFieldComplex.FieldRecord +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 FieldRecord + +| Constructors | | +| :--- | :--- | +| [FieldRecord\(string, object\)](StructureFieldComplex.FieldRecord.FieldRecord(string,object).md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldComplex\.FieldRecord\.FieldRecord\(string, object\)') | Запись поля структуры\. | + +| Fields | | +| :--- | :--- | +| [Allowed](StructureFieldComplex.FieldRecord.Allowed.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldComplex\.FieldRecord\.Allowed') | Флаг, указывающий, использовать ли поле\. | +| [Name](StructureFieldComplex.FieldRecord.Name.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldComplex\.FieldRecord\.Name') | Название поля\. | +| [Value](StructureFieldComplex.FieldRecord.Value.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldComplex\.FieldRecord\.Value') | Значение поля\. | + +| Properties | | +| :--- | :--- | +| [FieldType](StructureFieldComplex.FieldRecord.FieldType.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldComplex\.FieldRecord\.FieldType') | Тип поля структуры\. | diff --git a/Documentation/Pf2eDataScrapper/StructureFieldComplex.FieldType.md b/Documentation/Pf2eDataScrapper/StructureFieldComplex.FieldType.md new file mode 100644 index 0000000..50112a4 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureFieldComplex.FieldType.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[StructureFieldComplex](StructureFieldComplex.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldComplex') + +## StructureFieldComplex\.FieldType Property + +Тип поля структуры\. + +```csharp +public override Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.StructureFieldType FieldType { get; } +``` + +#### Property Value +[StructureFieldType](StructureFieldType.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldType') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StructureFieldComplex.Fields.md b/Documentation/Pf2eDataScrapper/StructureFieldComplex.Fields.md new file mode 100644 index 0000000..99243b6 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureFieldComplex.Fields.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[StructureFieldComplex](StructureFieldComplex.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldComplex') + +## StructureFieldComplex\.Fields Field + +Набор полей объекта\. + +```csharp +public readonly List Fields; +``` + +#### Field Value +[System\.Collections\.Generic\.List<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.List-1 'System\.Collections\.Generic\.List\`1')[StructureField](StructureField.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureField')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.List-1 'System\.Collections\.Generic\.List\`1') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StructureFieldComplex.GetRows_T_(Func_StructureField,T_).md b/Documentation/Pf2eDataScrapper/StructureFieldComplex.GetRows_T_(Func_StructureField,T_).md new file mode 100644 index 0000000..7dfe072 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureFieldComplex.GetRows_T_(Func_StructureField,T_).md @@ -0,0 +1,28 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[StructureFieldComplex](StructureFieldComplex.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldComplex') + +## StructureFieldComplex\.GetRows\\(Func\\) Method + +Получить набор строк, используя результат функция\. + +```csharp +public override System.Collections.Generic.ICollection GetRows(System.Func func); +``` +#### Type parameters + + + +`T` + +Тип результирующей строки\. +#### Parameters + + + +`func` [System\.Func<](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System\.Func\`2')[StructureField](StructureField.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureField')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System\.Func\`2')[T](StructureFieldComplex.GetRows_T_(Func_StructureField,T_).md#Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.StructureFieldComplex.GetRows_T_(System.Func_Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.StructureField,T_).T 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldComplex\.GetRows\\(System\.Func\\)\.T')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System\.Func\`2') + +Функция, оборажения поля в результирующую строку\. + +#### Returns +[System\.Collections\.Generic\.ICollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1')[T](StructureFieldComplex.GetRows_T_(Func_StructureField,T_).md#Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.StructureFieldComplex.GetRows_T_(System.Func_Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.StructureField,T_).T 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldComplex\.GetRows\\(System\.Func\\)\.T')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1') +Коллекция, содержащая набор строк\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StructureFieldComplex.GetTypeString().md b/Documentation/Pf2eDataScrapper/StructureFieldComplex.GetTypeString().md new file mode 100644 index 0000000..7302130 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureFieldComplex.GetTypeString().md @@ -0,0 +1,14 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[StructureFieldComplex](StructureFieldComplex.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldComplex') + +## StructureFieldComplex\.GetTypeString\(\) Method + +Получить строку, представляющую тип поля\. + +```csharp +public override string GetTypeString(); +``` + +#### Returns +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') +Строка, представляющая тип поля\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StructureFieldComplex.GetValueString().md b/Documentation/Pf2eDataScrapper/StructureFieldComplex.GetValueString().md new file mode 100644 index 0000000..d40f71b --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureFieldComplex.GetValueString().md @@ -0,0 +1,14 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[StructureFieldComplex](StructureFieldComplex.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldComplex') + +## StructureFieldComplex\.GetValueString\(\) Method + +Получить строку, представляющую значение поля\. + +```csharp +public override string GetValueString(); +``` + +#### Returns +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') +Строка, представляющая значение поля\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StructureFieldComplex.IdValue.md b/Documentation/Pf2eDataScrapper/StructureFieldComplex.IdValue.md new file mode 100644 index 0000000..1d81ed9 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureFieldComplex.IdValue.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[StructureFieldComplex](StructureFieldComplex.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldComplex') + +## StructureFieldComplex\.IdValue Property + +Значение поля идентификатора элемента\. + +```csharp +public string? IdValue { get; private set; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StructureFieldComplex.SetFields.md b/Documentation/Pf2eDataScrapper/StructureFieldComplex.SetFields.md new file mode 100644 index 0000000..bc378c6 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureFieldComplex.SetFields.md @@ -0,0 +1,61 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[StructureFieldComplex](StructureFieldComplex.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldComplex') + +## StructureFieldComplex\.SetFields Method + +| Overloads | | +| :--- | :--- | +| [SetFields\(object\)](StructureFieldComplex.SetFields.md#Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.StructureFieldComplex.SetFields(object) 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldComplex\.SetFields\(object\)') | Установить поля структуры общего объекта\. | +| [SetFields\(LocaleString\)](StructureFieldComplex.SetFields.md#Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.StructureFieldComplex.SetFields(Pf2eModel.Model.Common.I18n.LocaleString) 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldComplex\.SetFields\(Pf2eModel\.Model\.Common\.I18n\.LocaleString\)') | Установить поля структуры \`LocaleString\`\. | +| [SetFields\(IEnumerable\)](StructureFieldComplex.SetFields.md#Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.StructureFieldComplex.SetFields(System.Collections.IEnumerable) 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldComplex\.SetFields\(System\.Collections\.IEnumerable\)') | Установить поля структуры \`IEnumerable\`\. | + + + +## StructureFieldComplex\.SetFields\(object\) Method + +Установить поля структуры общего объекта\. + +```csharp +private void SetFields(object value); +``` +#### Parameters + + + +`value` [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') + +Объект\. + + + +## StructureFieldComplex\.SetFields\(LocaleString\) Method + +Установить поля структуры \`LocaleString\`\. + +```csharp +private void SetFields(Pf2eModel.Model.Common.I18n.LocaleString localeString); +``` +#### Parameters + + + +`localeString` [Pf2eModel\.Model\.Common\.I18n\.LocaleString](https://docs.microsoft.com/en-us/dotnet/api/Pf2eModel.Model.Common.I18n.LocaleString 'Pf2eModel\.Model\.Common\.I18n\.LocaleString') + +Объект строки локализации\. + + + +## StructureFieldComplex\.SetFields\(IEnumerable\) Method + +Установить поля структуры \`IEnumerable\`\. + +```csharp +private void SetFields(System.Collections.IEnumerable enumerable); +``` +#### Parameters + + + +`enumerable` [System\.Collections\.IEnumerable](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IEnumerable 'System\.Collections\.IEnumerable') + +Объект\-перечисление\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StructureFieldComplex.SetFieldsFromRecords(List_FieldRecord_).md b/Documentation/Pf2eDataScrapper/StructureFieldComplex.SetFieldsFromRecords(List_FieldRecord_).md new file mode 100644 index 0000000..c825d7a --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureFieldComplex.SetFieldsFromRecords(List_FieldRecord_).md @@ -0,0 +1,15 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[StructureFieldComplex](StructureFieldComplex.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldComplex') + +## StructureFieldComplex\.SetFieldsFromRecords\(List\\) Method + +Установить поля структуры из списка записей\. + +```csharp +private void SetFieldsFromRecords(System.Collections.Generic.List records); +``` +#### Parameters + + + +`records` [System\.Collections\.Generic\.List<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.List-1 'System\.Collections\.Generic\.List\`1')[FieldRecord](StructureFieldComplex.FieldRecord.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldComplex\.FieldRecord')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.List-1 'System\.Collections\.Generic\.List\`1') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StructureFieldComplex.StructureFieldComplex(StructureBuilder,object,string,int).md b/Documentation/Pf2eDataScrapper/StructureFieldComplex.StructureFieldComplex(StructureBuilder,object,string,int).md new file mode 100644 index 0000000..b66931e --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureFieldComplex.StructureFieldComplex(StructureBuilder,object,string,int).md @@ -0,0 +1,35 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[StructureFieldComplex](StructureFieldComplex.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldComplex') + +## StructureFieldComplex\(StructureBuilder, object, string, int\) Constructor + +Конструктор класса поля структуры с объектом\. + +```csharp +public StructureFieldComplex(Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.StructureBuilder builder, object value, string name, int depth); +``` +#### Parameters + + + +`builder` [StructureBuilder](StructureBuilder.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureBuilder') + +Класс построения структуры данных\. + + + +`value` [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') + +Значение поля\. + + + +`name` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +Название поля\. + + + +`depth` [System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') + +Глубина поля\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StructureFieldComplex.Type.md b/Documentation/Pf2eDataScrapper/StructureFieldComplex.Type.md new file mode 100644 index 0000000..f3d4fbd --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureFieldComplex.Type.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[StructureFieldComplex](StructureFieldComplex.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldComplex') + +## StructureFieldComplex\.Type Field + +Тип значения поля\. + +```csharp +public readonly Type Type; +``` + +#### Field Value +[System\.Type](https://docs.microsoft.com/en-us/dotnet/api/System.Type 'System\.Type') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StructureFieldComplex.UpdateFieldVisibility().md b/Documentation/Pf2eDataScrapper/StructureFieldComplex.UpdateFieldVisibility().md new file mode 100644 index 0000000..c56557f --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureFieldComplex.UpdateFieldVisibility().md @@ -0,0 +1,10 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[StructureFieldComplex](StructureFieldComplex.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldComplex') + +## StructureFieldComplex\.UpdateFieldVisibility\(\) Method + +Обновить видимость полей структуры\. + +```csharp +private void UpdateFieldVisibility(); +``` \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StructureFieldComplex.Visible.md b/Documentation/Pf2eDataScrapper/StructureFieldComplex.Visible.md new file mode 100644 index 0000000..fc257fe --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureFieldComplex.Visible.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[StructureFieldComplex](StructureFieldComplex.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldComplex') + +## StructureFieldComplex\.Visible Property + +Флаг, указывающий, отображается ли поле\. + +```csharp +public override bool Visible { get; set; } +``` + +#### Property Value +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StructureFieldComplex.md b/Documentation/Pf2eDataScrapper/StructureFieldComplex.md new file mode 100644 index 0000000..0d2a0d7 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureFieldComplex.md @@ -0,0 +1,40 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure') + +## StructureFieldComplex Class + +Поле стркутуры с объектом\. + +```csharp +internal class StructureFieldComplex : Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.StructureField +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [StructureField](StructureField.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureField') 🡒 StructureFieldComplex + +| Constructors | | +| :--- | :--- | +| [StructureFieldComplex\(StructureBuilder, object, string, int\)](StructureFieldComplex.StructureFieldComplex(StructureBuilder,object,string,int).md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldComplex\.StructureFieldComplex\(Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureBuilder, object, string, int\)') | Конструктор класса поля структуры с объектом\. | + +| Fields | | +| :--- | :--- | +| [Fields](StructureFieldComplex.Fields.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldComplex\.Fields') | Набор полей объекта\. | +| [Type](StructureFieldComplex.Type.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldComplex\.Type') | Тип значения поля\. | + +| Properties | | +| :--- | :--- | +| [Collapsable](StructureFieldComplex.Collapsable.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldComplex\.Collapsable') | Флаг, указывающий, что у этот элемент можно свернуть\. | +| [Collapsed](StructureFieldComplex.Collapsed.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldComplex\.Collapsed') | Флаг, указывающий, отображается ли поля объекта\. | +| [FieldType](StructureFieldComplex.FieldType.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldComplex\.FieldType') | Тип поля структуры\. | +| [IdValue](StructureFieldComplex.IdValue.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldComplex\.IdValue') | Значение поля идентификатора элемента\. | +| [Visible](StructureFieldComplex.Visible.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldComplex\.Visible') | Флаг, указывающий, отображается ли поле\. | + +| Methods | | +| :--- | :--- | +| [GetRows<T>\(Func<StructureField,T>\)](StructureFieldComplex.GetRows_T_(Func_StructureField,T_).md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldComplex\.GetRows\\(System\.Func\\)') | Получить набор строк, используя результат функция\. | +| [GetTypeString\(\)](StructureFieldComplex.GetTypeString().md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldComplex\.GetTypeString\(\)') | Получить строку, представляющую тип поля\. | +| [GetValueString\(\)](StructureFieldComplex.GetValueString().md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldComplex\.GetValueString\(\)') | Получить строку, представляющую значение поля\. | +| [SetFields\(object\)](StructureFieldComplex.SetFields.md#Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.StructureFieldComplex.SetFields(object) 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldComplex\.SetFields\(object\)') | Установить поля структуры общего объекта\. | +| [SetFields\(LocaleString\)](StructureFieldComplex.SetFields.md#Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.StructureFieldComplex.SetFields(Pf2eModel.Model.Common.I18n.LocaleString) 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldComplex\.SetFields\(Pf2eModel\.Model\.Common\.I18n\.LocaleString\)') | Установить поля структуры \`LocaleString\`\. | +| [SetFields\(IEnumerable\)](StructureFieldComplex.SetFields.md#Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.StructureFieldComplex.SetFields(System.Collections.IEnumerable) 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldComplex\.SetFields\(System\.Collections\.IEnumerable\)') | Установить поля структуры \`IEnumerable\`\. | +| [SetFieldsFromRecords\(List<FieldRecord>\)](StructureFieldComplex.SetFieldsFromRecords(List_FieldRecord_).md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldComplex\.SetFieldsFromRecords\(System\.Collections\.Generic\.List\\)') | Установить поля структуры из списка записей\. | +| [UpdateFieldVisibility\(\)](StructureFieldComplex.UpdateFieldVisibility().md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldComplex\.UpdateFieldVisibility\(\)') | Обновить видимость полей структуры\. | diff --git a/Documentation/Pf2eDataScrapper/StructureFieldEnum.FieldType.md b/Documentation/Pf2eDataScrapper/StructureFieldEnum.FieldType.md new file mode 100644 index 0000000..e55b125 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureFieldEnum.FieldType.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[StructureFieldEnum](StructureFieldEnum.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldEnum') + +## StructureFieldEnum\.FieldType Property + +Тип поля структуры\. + +```csharp +public override Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.StructureFieldType FieldType { get; } +``` + +#### Property Value +[StructureFieldType](StructureFieldType.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldType') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StructureFieldEnum.GetTypeString().md b/Documentation/Pf2eDataScrapper/StructureFieldEnum.GetTypeString().md new file mode 100644 index 0000000..07c7562 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureFieldEnum.GetTypeString().md @@ -0,0 +1,14 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[StructureFieldEnum](StructureFieldEnum.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldEnum') + +## StructureFieldEnum\.GetTypeString\(\) Method + +Получить строку, представляющую тип поля\. + +```csharp +public override string GetTypeString(); +``` + +#### Returns +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') +Строка, представляющая тип поля\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StructureFieldEnum.GetValueString().md b/Documentation/Pf2eDataScrapper/StructureFieldEnum.GetValueString().md new file mode 100644 index 0000000..acaa0d1 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureFieldEnum.GetValueString().md @@ -0,0 +1,14 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[StructureFieldEnum](StructureFieldEnum.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldEnum') + +## StructureFieldEnum\.GetValueString\(\) Method + +Получить строку, представляющую значение поля\. + +```csharp +public override string GetValueString(); +``` + +#### Returns +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') +Строка, представляющая значение поля\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StructureFieldEnum.StructureFieldEnum(StructureBuilder,object,string,int).md b/Documentation/Pf2eDataScrapper/StructureFieldEnum.StructureFieldEnum(StructureBuilder,object,string,int).md new file mode 100644 index 0000000..0147924 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureFieldEnum.StructureFieldEnum(StructureBuilder,object,string,int).md @@ -0,0 +1,35 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[StructureFieldEnum](StructureFieldEnum.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldEnum') + +## StructureFieldEnum\(StructureBuilder, object, string, int\) Constructor + +Поле структуры с перечислением\. + +```csharp +public StructureFieldEnum(Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.StructureBuilder builder, object value, string name, int depth); +``` +#### Parameters + + + +`builder` [StructureBuilder](StructureBuilder.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureBuilder') + +Класс построения структуры данных\. + + + +`value` [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') + +Значение поля\. + + + +`name` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +Название поля\. + + + +`depth` [System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') + +Глубина поля\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StructureFieldEnum.Type.md b/Documentation/Pf2eDataScrapper/StructureFieldEnum.Type.md new file mode 100644 index 0000000..fd6bde1 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureFieldEnum.Type.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[StructureFieldEnum](StructureFieldEnum.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldEnum') + +## StructureFieldEnum\.Type Field + +Тип значения поля\. + +```csharp +public readonly Type Type; +``` + +#### Field Value +[System\.Type](https://docs.microsoft.com/en-us/dotnet/api/System.Type 'System\.Type') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StructureFieldEnum.Value.md b/Documentation/Pf2eDataScrapper/StructureFieldEnum.Value.md new file mode 100644 index 0000000..2234814 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureFieldEnum.Value.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[StructureFieldEnum](StructureFieldEnum.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldEnum') + +## StructureFieldEnum\.Value Field + +Значение поля\. + +```csharp +public readonly object Value; +``` + +#### Field Value +[System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StructureFieldEnum.md b/Documentation/Pf2eDataScrapper/StructureFieldEnum.md new file mode 100644 index 0000000..c85ce06 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureFieldEnum.md @@ -0,0 +1,30 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure') + +## StructureFieldEnum Class + +Поле структуры с перечислением\. + +```csharp +internal class StructureFieldEnum : Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.StructureField +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [StructureField](StructureField.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureField') 🡒 StructureFieldEnum + +| Constructors | | +| :--- | :--- | +| [StructureFieldEnum\(StructureBuilder, object, string, int\)](StructureFieldEnum.StructureFieldEnum(StructureBuilder,object,string,int).md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldEnum\.StructureFieldEnum\(Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureBuilder, object, string, int\)') | Поле структуры с перечислением\. | + +| Fields | | +| :--- | :--- | +| [Type](StructureFieldEnum.Type.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldEnum\.Type') | Тип значения поля\. | +| [Value](StructureFieldEnum.Value.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldEnum\.Value') | Значение поля\. | + +| Properties | | +| :--- | :--- | +| [FieldType](StructureFieldEnum.FieldType.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldEnum\.FieldType') | Тип поля структуры\. | + +| Methods | | +| :--- | :--- | +| [GetTypeString\(\)](StructureFieldEnum.GetTypeString().md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldEnum\.GetTypeString\(\)') | Получить строку, представляющую тип поля\. | +| [GetValueString\(\)](StructureFieldEnum.GetValueString().md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldEnum\.GetValueString\(\)') | Получить строку, представляющую значение поля\. | diff --git a/Documentation/Pf2eDataScrapper/StructureFieldIgnored.FieldType.md b/Documentation/Pf2eDataScrapper/StructureFieldIgnored.FieldType.md new file mode 100644 index 0000000..6f4a018 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureFieldIgnored.FieldType.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[StructureFieldIgnored](StructureFieldIgnored.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldIgnored') + +## StructureFieldIgnored\.FieldType Property + +Тип поля структуры\. + +```csharp +public override Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.StructureFieldType FieldType { get; } +``` + +#### Property Value +[StructureFieldType](StructureFieldType.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldType') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StructureFieldIgnored.GetTypeString().md b/Documentation/Pf2eDataScrapper/StructureFieldIgnored.GetTypeString().md new file mode 100644 index 0000000..2637ae9 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureFieldIgnored.GetTypeString().md @@ -0,0 +1,14 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[StructureFieldIgnored](StructureFieldIgnored.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldIgnored') + +## StructureFieldIgnored\.GetTypeString\(\) Method + +Получить строку, представляющую тип поля\. + +```csharp +public override string GetTypeString(); +``` + +#### Returns +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') +Строка, представляющая тип поля\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StructureFieldIgnored.GetValueString().md b/Documentation/Pf2eDataScrapper/StructureFieldIgnored.GetValueString().md new file mode 100644 index 0000000..376d851 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureFieldIgnored.GetValueString().md @@ -0,0 +1,14 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[StructureFieldIgnored](StructureFieldIgnored.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldIgnored') + +## StructureFieldIgnored\.GetValueString\(\) Method + +Получить строку, представляющую значение поля\. + +```csharp +public override string GetValueString(); +``` + +#### Returns +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') +Строка, представляющая значение поля\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StructureFieldIgnored.Reference.md b/Documentation/Pf2eDataScrapper/StructureFieldIgnored.Reference.md new file mode 100644 index 0000000..996b88c --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureFieldIgnored.Reference.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[StructureFieldIgnored](StructureFieldIgnored.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldIgnored') + +## StructureFieldIgnored\.Reference Field + +Ссылка на объект\. + +```csharp +public StructureFieldComplex? Reference; +``` + +#### Field Value +[StructureFieldComplex](StructureFieldComplex.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldComplex') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StructureFieldIgnored.StructureFieldIgnored(StructureBuilder,string,StructureFieldComplex,int).md b/Documentation/Pf2eDataScrapper/StructureFieldIgnored.StructureFieldIgnored(StructureBuilder,string,StructureFieldComplex,int).md new file mode 100644 index 0000000..a6ace18 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureFieldIgnored.StructureFieldIgnored(StructureBuilder,string,StructureFieldComplex,int).md @@ -0,0 +1,35 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[StructureFieldIgnored](StructureFieldIgnored.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldIgnored') + +## StructureFieldIgnored\(StructureBuilder, string, StructureFieldComplex, int\) Constructor + +Поле структуры пропускаемого объекта\. + +```csharp +public StructureFieldIgnored(Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.StructureBuilder builder, string name, Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.StructureFieldComplex? reference, int depth); +``` +#### Parameters + + + +`builder` [StructureBuilder](StructureBuilder.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureBuilder') + +Класс построения структуры данных\. + + + +`name` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +Название поля\. + + + +`reference` [StructureFieldComplex](StructureFieldComplex.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldComplex') + +Ссылка на объект\. + + + +`depth` [System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') + +Глубина поля\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StructureFieldIgnored.md b/Documentation/Pf2eDataScrapper/StructureFieldIgnored.md new file mode 100644 index 0000000..7424b91 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureFieldIgnored.md @@ -0,0 +1,29 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure') + +## StructureFieldIgnored Class + +Поле структуры пропускаемого объекта\. + +```csharp +internal class StructureFieldIgnored : Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.StructureField +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [StructureField](StructureField.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureField') 🡒 StructureFieldIgnored + +| Constructors | | +| :--- | :--- | +| [StructureFieldIgnored\(StructureBuilder, string, StructureFieldComplex, int\)](StructureFieldIgnored.StructureFieldIgnored(StructureBuilder,string,StructureFieldComplex,int).md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldIgnored\.StructureFieldIgnored\(Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureBuilder, string, Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldComplex, int\)') | Поле структуры пропускаемого объекта\. | + +| Fields | | +| :--- | :--- | +| [Reference](StructureFieldIgnored.Reference.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldIgnored\.Reference') | Ссылка на объект\. | + +| Properties | | +| :--- | :--- | +| [FieldType](StructureFieldIgnored.FieldType.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldIgnored\.FieldType') | Тип поля структуры\. | + +| Methods | | +| :--- | :--- | +| [GetTypeString\(\)](StructureFieldIgnored.GetTypeString().md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldIgnored\.GetTypeString\(\)') | Получить строку, представляющую тип поля\. | +| [GetValueString\(\)](StructureFieldIgnored.GetValueString().md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldIgnored\.GetValueString\(\)') | Получить строку, представляющую значение поля\. | diff --git a/Documentation/Pf2eDataScrapper/StructureFieldNull.FieldType.md b/Documentation/Pf2eDataScrapper/StructureFieldNull.FieldType.md new file mode 100644 index 0000000..168c2ba --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureFieldNull.FieldType.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[StructureFieldNull](StructureFieldNull.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldNull') + +## StructureFieldNull\.FieldType Property + +Тип поля структуры\. + +```csharp +public override Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.StructureFieldType FieldType { get; } +``` + +#### Property Value +[StructureFieldType](StructureFieldType.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldType') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StructureFieldNull.GetTypeString().md b/Documentation/Pf2eDataScrapper/StructureFieldNull.GetTypeString().md new file mode 100644 index 0000000..fb0062c --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureFieldNull.GetTypeString().md @@ -0,0 +1,14 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[StructureFieldNull](StructureFieldNull.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldNull') + +## StructureFieldNull\.GetTypeString\(\) Method + +Получить строку, представляющую тип поля\. + +```csharp +public override string GetTypeString(); +``` + +#### Returns +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') +Строка, представляющая тип поля\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StructureFieldNull.GetValueString().md b/Documentation/Pf2eDataScrapper/StructureFieldNull.GetValueString().md new file mode 100644 index 0000000..5a7bace --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureFieldNull.GetValueString().md @@ -0,0 +1,14 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[StructureFieldNull](StructureFieldNull.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldNull') + +## StructureFieldNull\.GetValueString\(\) Method + +Получить строку, представляющую значение поля\. + +```csharp +public override string GetValueString(); +``` + +#### Returns +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') +Строка, представляющая значение поля\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StructureFieldNull.StructureFieldNull(StructureBuilder,string,int).md b/Documentation/Pf2eDataScrapper/StructureFieldNull.StructureFieldNull(StructureBuilder,string,int).md new file mode 100644 index 0000000..99ccea4 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureFieldNull.StructureFieldNull(StructureBuilder,string,int).md @@ -0,0 +1,29 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[StructureFieldNull](StructureFieldNull.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldNull') + +## StructureFieldNull\(StructureBuilder, string, int\) Constructor + +Пустое поле структуры\. + +```csharp +public StructureFieldNull(Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.StructureBuilder builder, string name, int depth); +``` +#### Parameters + + + +`builder` [StructureBuilder](StructureBuilder.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureBuilder') + +Класс построения структуры данных\. + + + +`name` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +Название поля\. + + + +`depth` [System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') + +Глубина поля\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StructureFieldNull.md b/Documentation/Pf2eDataScrapper/StructureFieldNull.md new file mode 100644 index 0000000..1eaf845 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureFieldNull.md @@ -0,0 +1,25 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure') + +## StructureFieldNull Class + +Пустое поле структуры\. + +```csharp +internal class StructureFieldNull : Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.StructureField +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [StructureField](StructureField.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureField') 🡒 StructureFieldNull + +| Constructors | | +| :--- | :--- | +| [StructureFieldNull\(StructureBuilder, string, int\)](StructureFieldNull.StructureFieldNull(StructureBuilder,string,int).md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldNull\.StructureFieldNull\(Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureBuilder, string, int\)') | Пустое поле структуры\. | + +| Properties | | +| :--- | :--- | +| [FieldType](StructureFieldNull.FieldType.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldNull\.FieldType') | Тип поля структуры\. | + +| Methods | | +| :--- | :--- | +| [GetTypeString\(\)](StructureFieldNull.GetTypeString().md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldNull\.GetTypeString\(\)') | Получить строку, представляющую тип поля\. | +| [GetValueString\(\)](StructureFieldNull.GetValueString().md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldNull\.GetValueString\(\)') | Получить строку, представляющую значение поля\. | diff --git a/Documentation/Pf2eDataScrapper/StructureFieldPrimitive.FieldType.md b/Documentation/Pf2eDataScrapper/StructureFieldPrimitive.FieldType.md new file mode 100644 index 0000000..9c8fc74 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureFieldPrimitive.FieldType.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[StructureFieldPrimitive](StructureFieldPrimitive.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldPrimitive') + +## StructureFieldPrimitive\.FieldType Property + +Тип поля структуры\. + +```csharp +public override Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.StructureFieldType FieldType { get; } +``` + +#### Property Value +[StructureFieldType](StructureFieldType.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldType') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StructureFieldPrimitive.GetTypeString().md b/Documentation/Pf2eDataScrapper/StructureFieldPrimitive.GetTypeString().md new file mode 100644 index 0000000..8866e82 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureFieldPrimitive.GetTypeString().md @@ -0,0 +1,14 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[StructureFieldPrimitive](StructureFieldPrimitive.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldPrimitive') + +## StructureFieldPrimitive\.GetTypeString\(\) Method + +Получить строку, представляющую тип поля\. + +```csharp +public override string GetTypeString(); +``` + +#### Returns +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') +Строка, представляющая тип поля\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StructureFieldPrimitive.GetValueString().md b/Documentation/Pf2eDataScrapper/StructureFieldPrimitive.GetValueString().md new file mode 100644 index 0000000..6142367 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureFieldPrimitive.GetValueString().md @@ -0,0 +1,14 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[StructureFieldPrimitive](StructureFieldPrimitive.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldPrimitive') + +## StructureFieldPrimitive\.GetValueString\(\) Method + +Получить строку, представляющую значение поля\. + +```csharp +public override string GetValueString(); +``` + +#### Returns +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') +Строка, представляющая значение поля\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StructureFieldPrimitive.StructureFieldPrimitive(StructureBuilder,object,string,int).md b/Documentation/Pf2eDataScrapper/StructureFieldPrimitive.StructureFieldPrimitive(StructureBuilder,object,string,int).md new file mode 100644 index 0000000..c0d58a1 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureFieldPrimitive.StructureFieldPrimitive(StructureBuilder,object,string,int).md @@ -0,0 +1,35 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[StructureFieldPrimitive](StructureFieldPrimitive.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldPrimitive') + +## StructureFieldPrimitive\(StructureBuilder, object, string, int\) Constructor + +Простое поле структуры\. + +```csharp +public StructureFieldPrimitive(Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.StructureBuilder builder, object value, string name, int depth); +``` +#### Parameters + + + +`builder` [StructureBuilder](StructureBuilder.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureBuilder') + +Класс построения структуры данных\. + + + +`value` [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') + +Значение поля\. + + + +`name` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +Название поля\. + + + +`depth` [System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') + +Глубина поля\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StructureFieldPrimitive.Type.md b/Documentation/Pf2eDataScrapper/StructureFieldPrimitive.Type.md new file mode 100644 index 0000000..cc57b7a --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureFieldPrimitive.Type.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[StructureFieldPrimitive](StructureFieldPrimitive.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldPrimitive') + +## StructureFieldPrimitive\.Type Field + +Тип значения поля\. + +```csharp +public readonly Type Type; +``` + +#### Field Value +[System\.Type](https://docs.microsoft.com/en-us/dotnet/api/System.Type 'System\.Type') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StructureFieldPrimitive.Value.md b/Documentation/Pf2eDataScrapper/StructureFieldPrimitive.Value.md new file mode 100644 index 0000000..ce9ebbf --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureFieldPrimitive.Value.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[StructureFieldPrimitive](StructureFieldPrimitive.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldPrimitive') + +## StructureFieldPrimitive\.Value Field + +Значение поля\. + +```csharp +public readonly object Value; +``` + +#### Field Value +[System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StructureFieldPrimitive.md b/Documentation/Pf2eDataScrapper/StructureFieldPrimitive.md new file mode 100644 index 0000000..2ea0223 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureFieldPrimitive.md @@ -0,0 +1,30 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure') + +## StructureFieldPrimitive Class + +Простое поле структуры\. + +```csharp +internal class StructureFieldPrimitive : Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.StructureField +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [StructureField](StructureField.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureField') 🡒 StructureFieldPrimitive + +| Constructors | | +| :--- | :--- | +| [StructureFieldPrimitive\(StructureBuilder, object, string, int\)](StructureFieldPrimitive.StructureFieldPrimitive(StructureBuilder,object,string,int).md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldPrimitive\.StructureFieldPrimitive\(Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureBuilder, object, string, int\)') | Простое поле структуры\. | + +| Fields | | +| :--- | :--- | +| [Type](StructureFieldPrimitive.Type.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldPrimitive\.Type') | Тип значения поля\. | +| [Value](StructureFieldPrimitive.Value.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldPrimitive\.Value') | Значение поля\. | + +| Properties | | +| :--- | :--- | +| [FieldType](StructureFieldPrimitive.FieldType.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldPrimitive\.FieldType') | Тип поля структуры\. | + +| Methods | | +| :--- | :--- | +| [GetTypeString\(\)](StructureFieldPrimitive.GetTypeString().md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldPrimitive\.GetTypeString\(\)') | Получить строку, представляющую тип поля\. | +| [GetValueString\(\)](StructureFieldPrimitive.GetValueString().md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldPrimitive\.GetValueString\(\)') | Получить строку, представляющую значение поля\. | diff --git a/Documentation/Pf2eDataScrapper/StructureFieldReference.FieldType.md b/Documentation/Pf2eDataScrapper/StructureFieldReference.FieldType.md new file mode 100644 index 0000000..02c51fa --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureFieldReference.FieldType.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[StructureFieldReference](StructureFieldReference.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldReference') + +## StructureFieldReference\.FieldType Property + +Тип поля структуры\. + +```csharp +public override Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.StructureFieldType FieldType { get; } +``` + +#### Property Value +[StructureFieldType](StructureFieldType.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldType') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StructureFieldReference.GetTypeString().md b/Documentation/Pf2eDataScrapper/StructureFieldReference.GetTypeString().md new file mode 100644 index 0000000..b5a9b62 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureFieldReference.GetTypeString().md @@ -0,0 +1,14 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[StructureFieldReference](StructureFieldReference.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldReference') + +## StructureFieldReference\.GetTypeString\(\) Method + +Получить строку, представляющую тип поля\. + +```csharp +public override string GetTypeString(); +``` + +#### Returns +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') +Строка, представляющая тип поля\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StructureFieldReference.GetValueString().md b/Documentation/Pf2eDataScrapper/StructureFieldReference.GetValueString().md new file mode 100644 index 0000000..4563096 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureFieldReference.GetValueString().md @@ -0,0 +1,14 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[StructureFieldReference](StructureFieldReference.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldReference') + +## StructureFieldReference\.GetValueString\(\) Method + +Получить строку, представляющую значение поля\. + +```csharp +public override string GetValueString(); +``` + +#### Returns +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') +Строка, представляющая значение поля\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StructureFieldReference.Reference.md b/Documentation/Pf2eDataScrapper/StructureFieldReference.Reference.md new file mode 100644 index 0000000..265427b --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureFieldReference.Reference.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[StructureFieldReference](StructureFieldReference.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldReference') + +## StructureFieldReference\.Reference Field + +Ссылка на объект\. + +```csharp +public StructureFieldComplex? Reference; +``` + +#### Field Value +[StructureFieldComplex](StructureFieldComplex.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldComplex') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StructureFieldReference.StructureFieldReference(StructureBuilder,string,StructureFieldComplex,int).md b/Documentation/Pf2eDataScrapper/StructureFieldReference.StructureFieldReference(StructureBuilder,string,StructureFieldComplex,int).md new file mode 100644 index 0000000..9c19152 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureFieldReference.StructureFieldReference(StructureBuilder,string,StructureFieldComplex,int).md @@ -0,0 +1,35 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[StructureFieldReference](StructureFieldReference.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldReference') + +## StructureFieldReference\(StructureBuilder, string, StructureFieldComplex, int\) Constructor + +Поле структуры с ссылкой на объект\. + +```csharp +public StructureFieldReference(Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.StructureBuilder builder, string name, Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.StructureFieldComplex? reference, int depth); +``` +#### Parameters + + + +`builder` [StructureBuilder](StructureBuilder.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureBuilder') + +Класс построения структуры данных\. + + + +`name` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +Название поля\. + + + +`reference` [StructureFieldComplex](StructureFieldComplex.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldComplex') + +Ссылка на объект\. + + + +`depth` [System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') + +Глубина поля\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StructureFieldReference.md b/Documentation/Pf2eDataScrapper/StructureFieldReference.md new file mode 100644 index 0000000..58961d7 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureFieldReference.md @@ -0,0 +1,29 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure') + +## StructureFieldReference Class + +Поле структуры с ссылкой на объект\. + +```csharp +internal class StructureFieldReference : Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.StructureField +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [StructureField](StructureField.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureField') 🡒 StructureFieldReference + +| Constructors | | +| :--- | :--- | +| [StructureFieldReference\(StructureBuilder, string, StructureFieldComplex, int\)](StructureFieldReference.StructureFieldReference(StructureBuilder,string,StructureFieldComplex,int).md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldReference\.StructureFieldReference\(Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureBuilder, string, Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldComplex, int\)') | Поле структуры с ссылкой на объект\. | + +| Fields | | +| :--- | :--- | +| [Reference](StructureFieldReference.Reference.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldReference\.Reference') | Ссылка на объект\. | + +| Properties | | +| :--- | :--- | +| [FieldType](StructureFieldReference.FieldType.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldReference\.FieldType') | Тип поля структуры\. | + +| Methods | | +| :--- | :--- | +| [GetTypeString\(\)](StructureFieldReference.GetTypeString().md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldReference\.GetTypeString\(\)') | Получить строку, представляющую тип поля\. | +| [GetValueString\(\)](StructureFieldReference.GetValueString().md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureFieldReference\.GetValueString\(\)') | Получить строку, представляющую значение поля\. | diff --git a/Documentation/Pf2eDataScrapper/StructureFieldType.md b/Documentation/Pf2eDataScrapper/StructureFieldType.md new file mode 100644 index 0000000..165a9ed --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureFieldType.md @@ -0,0 +1,41 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure') + +## StructureFieldType Enum + +Тип поля структуры\. + +```csharp +internal enum StructureFieldType +``` +### Fields + + + +`Null` 0 + +Пустое поле\. + + + +`Primitive` 1 + +Простое поле\. + + + +`Enum` 2 + +Поле с перечислением\. + + + +`Complex` 3 + +Поле с объектом\. + + + +`Reference` 4 + +Поле с ссылкой на объект\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StructureProcessedObject.StructureProcessedObject(object).md b/Documentation/Pf2eDataScrapper/StructureProcessedObject.StructureProcessedObject(object).md new file mode 100644 index 0000000..1a03f8c --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureProcessedObject.StructureProcessedObject(object).md @@ -0,0 +1,17 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[StructureProcessedObject](StructureProcessedObject.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureProcessedObject') + +## StructureProcessedObject\(object\) Constructor + +Класс для хранения обработанного объекта\. + +```csharp +public StructureProcessedObject(object value); +``` +#### Parameters + + + +`value` [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') + +Объект\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StructureProcessedObject.md b/Documentation/Pf2eDataScrapper/StructureProcessedObject.md new file mode 100644 index 0000000..8cd561c --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureProcessedObject.md @@ -0,0 +1,16 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure') + +## StructureProcessedObject Class + +Класс для хранения обработанного объекта\. + +```csharp +internal class StructureProcessedObject +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 StructureProcessedObject + +| Constructors | | +| :--- | :--- | +| [StructureProcessedObject\(object\)](StructureProcessedObject.StructureProcessedObject(object).md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureProcessedObject\.StructureProcessedObject\(object\)') | Класс для хранения обработанного объекта\. | diff --git a/Documentation/Pf2eDataScrapper/StructureRow.AccentColor.md b/Documentation/Pf2eDataScrapper/StructureRow.AccentColor.md new file mode 100644 index 0000000..98b4f19 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureRow.AccentColor.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[StructureRow](StructureRow.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureRow') + +## StructureRow\.AccentColor Property + +Цвет значения + +```csharp +public System.Nullable AccentColor { get; } +``` + +#### Property Value +[System\.Nullable<](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System\.Nullable\`1')[System\.Windows\.Media\.Color](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.Media.Color 'System\.Windows\.Media\.Color')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System\.Nullable\`1') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StructureRow.ButtonIcon.md b/Documentation/Pf2eDataScrapper/StructureRow.ButtonIcon.md new file mode 100644 index 0000000..e88d45d --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureRow.ButtonIcon.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[StructureRow](StructureRow.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureRow') + +## StructureRow\.ButtonIcon Property + +Иконка кнопки\. + +```csharp +public string ButtonIcon { get; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StructureRow.ButtonVisibility.md b/Documentation/Pf2eDataScrapper/StructureRow.ButtonVisibility.md new file mode 100644 index 0000000..e6ed739 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureRow.ButtonVisibility.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[StructureRow](StructureRow.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureRow') + +## StructureRow\.ButtonVisibility Property + +Флаг, указывающий, отображается ли строка\. + +```csharp +public System.Windows.Visibility ButtonVisibility { get; } +``` + +#### Property Value +[System\.Windows\.Visibility](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.Visibility 'System\.Windows\.Visibility') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StructureRow.CollapseCommand.md b/Documentation/Pf2eDataScrapper/StructureRow.CollapseCommand.md new file mode 100644 index 0000000..1d3702a --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureRow.CollapseCommand.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[StructureRow](StructureRow.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureRow') + +## StructureRow\.CollapseCommand Property + +Команда переключения\. + +```csharp +public System.Windows.Input.ICommand CollapseCommand { get; } +``` + +#### Property Value +[System\.Windows\.Input\.ICommand](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.Input.ICommand 'System\.Windows\.Input\.ICommand') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StructureRow.Depth.md b/Documentation/Pf2eDataScrapper/StructureRow.Depth.md new file mode 100644 index 0000000..bb98e25 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureRow.Depth.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[StructureRow](StructureRow.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureRow') + +## StructureRow\.Depth Property + +Глубина отображения поля\. + +```csharp +public int Depth { get; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StructureRow.Field.md b/Documentation/Pf2eDataScrapper/StructureRow.Field.md new file mode 100644 index 0000000..fe109b5 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureRow.Field.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[StructureRow](StructureRow.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureRow') + +## StructureRow\.Field Property + +Отображаемая строка поля сущности\. + +```csharp +public Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.StructureField Field { get; } +``` + +#### Property Value +[StructureField](StructureField.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureField') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StructureRow.HasButton.md b/Documentation/Pf2eDataScrapper/StructureRow.HasButton.md new file mode 100644 index 0000000..465e762 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureRow.HasButton.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[StructureRow](StructureRow.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureRow') + +## StructureRow\.HasButton Property + +Флаг наличия кнопки\. + +```csharp +public bool HasButton { get; } +``` + +#### Property Value +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StructureRow.ItemVisibility.md b/Documentation/Pf2eDataScrapper/StructureRow.ItemVisibility.md new file mode 100644 index 0000000..64ddea8 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureRow.ItemVisibility.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[StructureRow](StructureRow.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureRow') + +## StructureRow\.ItemVisibility Property + +Флаг, указывающий, отображается ли строка\. + +```csharp +public System.Windows.Visibility ItemVisibility { get; } +``` + +#### Property Value +[System\.Windows\.Visibility](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.Visibility 'System\.Windows\.Visibility') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StructureRow.Ladder.md b/Documentation/Pf2eDataScrapper/StructureRow.Ladder.md new file mode 100644 index 0000000..f28abe6 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureRow.Ladder.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[StructureRow](StructureRow.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureRow') + +## StructureRow\.Ladder Property + +Список типов лестницы\. + +```csharp +public System.Collections.Generic.List Ladder { get; set; } +``` + +#### Property Value +[System\.Collections\.Generic\.List<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.List-1 'System\.Collections\.Generic\.List\`1')[LadderType](LadderType.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.LadderType')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.List-1 'System\.Collections\.Generic\.List\`1') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StructureRow.Name.md b/Documentation/Pf2eDataScrapper/StructureRow.Name.md new file mode 100644 index 0000000..e8b7526 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureRow.Name.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[StructureRow](StructureRow.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureRow') + +## StructureRow\.Name Property + +Строковое представление названия поля\. + +```csharp +public string Name { get; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StructureRow.OnChange.md b/Documentation/Pf2eDataScrapper/StructureRow.OnChange.md new file mode 100644 index 0000000..2d8f840 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureRow.OnChange.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[StructureRow](StructureRow.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureRow') + +## StructureRow\.OnChange Event + +Событие изменения поля\. + +```csharp +public event Action? OnChange; +``` + +#### Event Type +[System\.Action<](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System\.Action\`2')[StructureRow](StructureRow.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureRow')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System\.Action\`2')[StructureField](StructureField.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureField')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Action-2 'System\.Action\`2') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StructureRow.OnPropertyChanged(string).md b/Documentation/Pf2eDataScrapper/StructureRow.OnPropertyChanged(string).md new file mode 100644 index 0000000..8909d21 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureRow.OnPropertyChanged(string).md @@ -0,0 +1,17 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[StructureRow](StructureRow.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureRow') + +## StructureRow\.OnPropertyChanged\(string\) Method + +При изменении поля\. + +```csharp +protected void OnPropertyChanged(string? propertyName=null); +``` +#### Parameters + + + +`propertyName` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +Название поля\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StructureRow.PropertyChanged.md b/Documentation/Pf2eDataScrapper/StructureRow.PropertyChanged.md new file mode 100644 index 0000000..54719ec --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureRow.PropertyChanged.md @@ -0,0 +1,15 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[StructureRow](StructureRow.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureRow') + +## StructureRow\.PropertyChanged Event + +Изменение поля\. + +```csharp +public event PropertyChangedEventHandler? PropertyChanged; +``` + +Implements [PropertyChanged](https://docs.microsoft.com/en-us/dotnet/api/System.ComponentModel.INotifyPropertyChanged.PropertyChanged 'System\.ComponentModel\.INotifyPropertyChanged\.PropertyChanged') + +#### Event Type +[System\.ComponentModel\.PropertyChangedEventHandler](https://docs.microsoft.com/en-us/dotnet/api/System.ComponentModel.PropertyChangedEventHandler 'System\.ComponentModel\.PropertyChangedEventHandler') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StructureRow.StructureRow(StructureField).md b/Documentation/Pf2eDataScrapper/StructureRow.StructureRow(StructureField).md new file mode 100644 index 0000000..5e47f0f --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureRow.StructureRow(StructureField).md @@ -0,0 +1,17 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[StructureRow](StructureRow.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureRow') + +## StructureRow\(StructureField\) Constructor + +Кониструктор класса [StructureRow](StructureRow.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureRow')\. + +```csharp +public StructureRow(Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.StructureField field); +``` +#### Parameters + + + +`field` [StructureField](StructureField.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureField') + +Поле\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StructureRow.Type.md b/Documentation/Pf2eDataScrapper/StructureRow.Type.md new file mode 100644 index 0000000..891bf81 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureRow.Type.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[StructureRow](StructureRow.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureRow') + +## StructureRow\.Type Property + +Строковое представление типа поля\. + +```csharp +public string Type { get; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StructureRow.Value.md b/Documentation/Pf2eDataScrapper/StructureRow.Value.md new file mode 100644 index 0000000..30604f3 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureRow.Value.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[StructureRow](StructureRow.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureRow') + +## StructureRow\.Value Property + +Строковое представление значения поля\. + +```csharp +public string Value { get; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StructureRow.Visible.md b/Documentation/Pf2eDataScrapper/StructureRow.Visible.md new file mode 100644 index 0000000..9b072f6 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureRow.Visible.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure').[StructureRow](StructureRow.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureRow') + +## StructureRow\.Visible Property + +Флаг, указывающий, отображается ли строка\. + +```csharp +public bool Visible { get; } +``` + +#### Property Value +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/StructureRow.md b/Documentation/Pf2eDataScrapper/StructureRow.md new file mode 100644 index 0000000..f8daf47 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/StructureRow.md @@ -0,0 +1,43 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure') + +## StructureRow Class + +Строка структуры, представляющая поле сущности\. + +```csharp +internal class StructureRow : System.ComponentModel.INotifyPropertyChanged +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 StructureRow + +Implements [System\.ComponentModel\.INotifyPropertyChanged](https://docs.microsoft.com/en-us/dotnet/api/System.ComponentModel.INotifyPropertyChanged 'System\.ComponentModel\.INotifyPropertyChanged') + +| Constructors | | +| :--- | :--- | +| [StructureRow\(StructureField\)](StructureRow.StructureRow(StructureField).md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureRow\.StructureRow\(Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureField\)') | Кониструктор класса [StructureRow](StructureRow.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureRow')\. | + +| Properties | | +| :--- | :--- | +| [AccentColor](StructureRow.AccentColor.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureRow\.AccentColor') | Цвет значения | +| [ButtonIcon](StructureRow.ButtonIcon.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureRow\.ButtonIcon') | Иконка кнопки\. | +| [ButtonVisibility](StructureRow.ButtonVisibility.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureRow\.ButtonVisibility') | Флаг, указывающий, отображается ли строка\. | +| [CollapseCommand](StructureRow.CollapseCommand.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureRow\.CollapseCommand') | Команда переключения\. | +| [Depth](StructureRow.Depth.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureRow\.Depth') | Глубина отображения поля\. | +| [Field](StructureRow.Field.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureRow\.Field') | Отображаемая строка поля сущности\. | +| [HasButton](StructureRow.HasButton.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureRow\.HasButton') | Флаг наличия кнопки\. | +| [ItemVisibility](StructureRow.ItemVisibility.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureRow\.ItemVisibility') | Флаг, указывающий, отображается ли строка\. | +| [Ladder](StructureRow.Ladder.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureRow\.Ladder') | Список типов лестницы\. | +| [Name](StructureRow.Name.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureRow\.Name') | Строковое представление названия поля\. | +| [Type](StructureRow.Type.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureRow\.Type') | Строковое представление типа поля\. | +| [Value](StructureRow.Value.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureRow\.Value') | Строковое представление значения поля\. | +| [Visible](StructureRow.Visible.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureRow\.Visible') | Флаг, указывающий, отображается ли строка\. | + +| Methods | | +| :--- | :--- | +| [OnPropertyChanged\(string\)](StructureRow.OnPropertyChanged(string).md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureRow\.OnPropertyChanged\(string\)') | При изменении поля\. | + +| Events | | +| :--- | :--- | +| [OnChange](StructureRow.OnChange.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureRow\.OnChange') | Событие изменения поля\. | +| [PropertyChanged](StructureRow.PropertyChanged.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure\.StructureRow\.PropertyChanged') | Изменение поля\. | diff --git a/Documentation/Pf2eDataScrapper/TraitProcessor.Add().md b/Documentation/Pf2eDataScrapper/TraitProcessor.Add().md new file mode 100644 index 0000000..01bb35d --- /dev/null +++ b/Documentation/Pf2eDataScrapper/TraitProcessor.Add().md @@ -0,0 +1,10 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types').[TraitProcessor](TraitProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.TraitProcessor') + +## TraitProcessor\.Add\(\) Method + +Добавление основной сущности в контекст базы данных\. + +```csharp +protected override void Add(); +``` \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/TraitProcessor.AddTraits().md b/Documentation/Pf2eDataScrapper/TraitProcessor.AddTraits().md new file mode 100644 index 0000000..4ec2edf --- /dev/null +++ b/Documentation/Pf2eDataScrapper/TraitProcessor.AddTraits().md @@ -0,0 +1,10 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types').[TraitProcessor](TraitProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.TraitProcessor') + +## TraitProcessor\.AddTraits\(\) Method + +Генерация списка признаков сущности\. + +```csharp +protected override void AddTraits(); +``` \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/TraitProcessor.GetDescription().md b/Documentation/Pf2eDataScrapper/TraitProcessor.GetDescription().md new file mode 100644 index 0000000..3d36e2e --- /dev/null +++ b/Documentation/Pf2eDataScrapper/TraitProcessor.GetDescription().md @@ -0,0 +1,14 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types').[TraitProcessor](TraitProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.TraitProcessor') + +## TraitProcessor\.GetDescription\(\) Method + +Сгенерировать описание сущности\. + +```csharp +protected override string GetDescription(); +``` + +#### Returns +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') +Описание сущности \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/TraitProcessor.Object.md b/Documentation/Pf2eDataScrapper/TraitProcessor.Object.md new file mode 100644 index 0000000..c9c3b18 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/TraitProcessor.Object.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types').[TraitProcessor](TraitProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.TraitProcessor') + +## TraitProcessor\.Object Property + +Основная сущность\. + +```csharp +public virtual Pf2eModel.Model.Structure.Trait Object { get; } +``` + +#### Property Value +[Pf2eModel\.Model\.Structure\.Trait](https://docs.microsoft.com/en-us/dotnet/api/Pf2eModel.Model.Structure.Trait 'Pf2eModel\.Model\.Structure\.Trait') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/TraitProcessor.Process().md b/Documentation/Pf2eDataScrapper/TraitProcessor.Process().md new file mode 100644 index 0000000..7f698c4 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/TraitProcessor.Process().md @@ -0,0 +1,12 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types').[TraitProcessor](TraitProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.TraitProcessor') + +## TraitProcessor\.Process\(\) Method + +Основной метод обработки данных\. + +```csharp +public override void Process(); +``` + +Implements [Process\(\)](IProcessor.Process().md 'Pf2eDataScrapper\.Processors\.Definitions\.IProcessor\.Process\(\)') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/TraitProcessor.Type.md b/Documentation/Pf2eDataScrapper/TraitProcessor.Type.md new file mode 100644 index 0000000..7ea0506 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/TraitProcessor.Type.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types').[TraitProcessor](TraitProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.TraitProcessor') + +## TraitProcessor\.Type Property + +Тип сущности\. + +```csharp +public override Pf2eModel.Model.Enum.EntityType Type { get; } +``` + +#### Property Value +[Pf2eModel\.Model\.Enum\.EntityType](https://docs.microsoft.com/en-us/dotnet/api/Pf2eModel.Model.Enum.EntityType 'Pf2eModel\.Model\.Enum\.EntityType') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/TraitProcessor.md b/Documentation/Pf2eDataScrapper/TraitProcessor.md new file mode 100644 index 0000000..2d43620 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/TraitProcessor.md @@ -0,0 +1,22 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types') + +## TraitProcessor Class + +```csharp +internal class TraitProcessor : Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.AbstractEntityProcessor +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [AbstractInputProcessor](AbstractInputProcessor.md 'Pf2eDataScrapper\.Processors\.Definitions\.AbstractInputProcessor') 🡒 [AbstractEntityProcessor](AbstractEntityProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.AbstractEntityProcessor') 🡒 TraitProcessor + +| Properties | | +| :--- | :--- | +| [Object](TraitProcessor.Object.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.TraitProcessor\.Object') | Основная сущность\. | +| [Type](TraitProcessor.Type.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.TraitProcessor\.Type') | Тип сущности\. | + +| Methods | | +| :--- | :--- | +| [Add\(\)](TraitProcessor.Add().md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.TraitProcessor\.Add\(\)') | Добавление основной сущности в контекст базы данных\. | +| [AddTraits\(\)](TraitProcessor.AddTraits().md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.TraitProcessor\.AddTraits\(\)') | Генерация списка признаков сущности\. | +| [GetDescription\(\)](TraitProcessor.GetDescription().md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.TraitProcessor\.GetDescription\(\)') | Сгенерировать описание сущности\. | +| [Process\(\)](TraitProcessor.Process().md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.TraitProcessor\.Process\(\)') | Основной метод обработки данных\. | diff --git a/Documentation/Pf2eDataScrapper/TypeResolver.CheckPath.md b/Documentation/Pf2eDataScrapper/TypeResolver.CheckPath.md new file mode 100644 index 0000000..1334464 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/TypeResolver.CheckPath.md @@ -0,0 +1,63 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder](Pf2eDataScrapper.SchemaBuilder.md 'Pf2eDataScrapper\.SchemaBuilder').[TypeResolver](TypeResolver.md 'Pf2eDataScrapper\.SchemaBuilder\.TypeResolver') + +## TypeResolver\.CheckPath Method + +| Overloads | | +| :--- | :--- | +| [CheckPath\(SchemaNode, string\)](TypeResolver.CheckPath.md#Pf2eDataScrapper.SchemaBuilder.TypeResolver.CheckPath(Pf2eDataScrapper.SchemaBuilder.SchemaNode,string) 'Pf2eDataScrapper\.SchemaBuilder\.TypeResolver\.CheckPath\(Pf2eDataScrapper\.SchemaBuilder\.SchemaNode, string\)') | Проверка соответствия пути\. | +| [CheckPath\(SchemaNode, ICollection<string>\)](TypeResolver.CheckPath.md#Pf2eDataScrapper.SchemaBuilder.TypeResolver.CheckPath(Pf2eDataScrapper.SchemaBuilder.SchemaNode,System.Collections.Generic.ICollection_string_) 'Pf2eDataScrapper\.SchemaBuilder\.TypeResolver\.CheckPath\(Pf2eDataScrapper\.SchemaBuilder\.SchemaNode, System\.Collections\.Generic\.ICollection\\)') | Проверка соответствия пути\. | + + + +## TypeResolver\.CheckPath\(SchemaNode, string\) Method + +Проверка соответствия пути\. + +```csharp +public bool CheckPath(Pf2eDataScrapper.SchemaBuilder.SchemaNode node, string path); +``` +#### Parameters + + + +`node` [SchemaNode](SchemaNode.md 'Pf2eDataScrapper\.SchemaBuilder\.SchemaNode') + +Элемент, путь которого проверяется\. + + + +`path` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +Проверяемый путь\. Допускается использование \`\*\` в местах, где допускается любое значение\. + +#### Returns +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') +\`true\`, если \`node\.Path\` соответсвует указанному в \`path\` значению\. + + + +## TypeResolver\.CheckPath\(SchemaNode, ICollection\\) Method + +Проверка соответствия пути\. + +```csharp +public bool CheckPath(Pf2eDataScrapper.SchemaBuilder.SchemaNode node, System.Collections.Generic.ICollection paths); +``` +#### Parameters + + + +`node` [SchemaNode](SchemaNode.md 'Pf2eDataScrapper\.SchemaBuilder\.SchemaNode') + +Элемент, путь которого проверяется\. + + + +`paths` [System\.Collections\.Generic\.ICollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1')[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1') + +Проверяемые пути\. Допускается использование \`\*\` в местах, где допускается любое значение\. + +#### Returns +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') +\`true\`, если \`node\.Path\` соответсвует хотя бы одному указанному в \`paths\` значению\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/TypeResolver.CustomResolve(SchemaNode,JToken).md b/Documentation/Pf2eDataScrapper/TypeResolver.CustomResolve(SchemaNode,JToken).md new file mode 100644 index 0000000..44cf61d --- /dev/null +++ b/Documentation/Pf2eDataScrapper/TypeResolver.CustomResolve(SchemaNode,JToken).md @@ -0,0 +1,27 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder](Pf2eDataScrapper.SchemaBuilder.md 'Pf2eDataScrapper\.SchemaBuilder').[TypeResolver](TypeResolver.md 'Pf2eDataScrapper\.SchemaBuilder\.TypeResolver') + +## TypeResolver\.CustomResolve\(SchemaNode, JToken\) Method + +Частное определение типа поля\. + +```csharp +protected virtual Pf2eDataScrapper.SchemaBuilder.Types.AbstractSchemaType? CustomResolve(Pf2eDataScrapper.SchemaBuilder.SchemaNode node, Newtonsoft.Json.Linq.JToken? value); +``` +#### Parameters + + + +`node` [SchemaNode](SchemaNode.md 'Pf2eDataScrapper\.SchemaBuilder\.SchemaNode') + +Поле схемы данных, для которого создаётся тип\. + + + +`value` [Newtonsoft\.Json\.Linq\.JToken](https://docs.microsoft.com/en-us/dotnet/api/Newtonsoft.Json.Linq.JToken 'Newtonsoft\.Json\.Linq\.JToken') + +Добавляемое значение\. + +#### Returns +[AbstractSchemaType](AbstractSchemaType.md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.AbstractSchemaType') +Новый тип для схемы данных\. \`null\`, что бы использовать значение по умолчанию \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/TypeResolver.Resolve(SchemaNode,JToken,bool).md b/Documentation/Pf2eDataScrapper/TypeResolver.Resolve(SchemaNode,JToken,bool).md new file mode 100644 index 0000000..b373740 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/TypeResolver.Resolve(SchemaNode,JToken,bool).md @@ -0,0 +1,39 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder](Pf2eDataScrapper.SchemaBuilder.md 'Pf2eDataScrapper\.SchemaBuilder').[TypeResolver](TypeResolver.md 'Pf2eDataScrapper\.SchemaBuilder\.TypeResolver') + +## TypeResolver\.Resolve\(SchemaNode, JToken, bool\) Method + +Определение типа поля\. + +```csharp +public Pf2eDataScrapper.SchemaBuilder.Types.AbstractSchemaType Resolve(Pf2eDataScrapper.SchemaBuilder.SchemaNode node, Newtonsoft.Json.Linq.JToken? value, bool disableResolve=false); +``` +#### Parameters + + + +`node` [SchemaNode](SchemaNode.md 'Pf2eDataScrapper\.SchemaBuilder\.SchemaNode') + +Поле схемы данных, для которого создаётся тип\. + + + +`value` [Newtonsoft\.Json\.Linq\.JToken](https://docs.microsoft.com/en-us/dotnet/api/Newtonsoft.Json.Linq.JToken 'Newtonsoft\.Json\.Linq\.JToken') + +Добавляемое значение\. + + + +`disableResolve` [System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') + +Добавляемое значение\. + +#### Returns +[AbstractSchemaType](AbstractSchemaType.md 'Pf2eDataScrapper\.SchemaBuilder\.Types\.AbstractSchemaType') +Новый тип для схемы данных + +#### Exceptions + +[System\.ArgumentNullException](https://docs.microsoft.com/en-us/dotnet/api/System.ArgumentNullException 'System\.ArgumentNullException') +Возникает, если у \`value\` значение идентично \`null\` +\(такие значения должны обрабаотываться в \`SchemaNode\`\)\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/TypeResolver.TokenType(JToken).md b/Documentation/Pf2eDataScrapper/TypeResolver.TokenType(JToken).md new file mode 100644 index 0000000..afb1adb --- /dev/null +++ b/Documentation/Pf2eDataScrapper/TypeResolver.TokenType(JToken).md @@ -0,0 +1,21 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder](Pf2eDataScrapper.SchemaBuilder.md 'Pf2eDataScrapper\.SchemaBuilder').[TypeResolver](TypeResolver.md 'Pf2eDataScrapper\.SchemaBuilder\.TypeResolver') + +## TypeResolver\.TokenType\(JToken\) Method + +Получение типа значения\. + +```csharp +public Newtonsoft.Json.Linq.JTokenType TokenType(Newtonsoft.Json.Linq.JToken? value); +``` +#### Parameters + + + +`value` [Newtonsoft\.Json\.Linq\.JToken](https://docs.microsoft.com/en-us/dotnet/api/Newtonsoft.Json.Linq.JToken 'Newtonsoft\.Json\.Linq\.JToken') + +Значение\. + +#### Returns +[Newtonsoft\.Json\.Linq\.JTokenType](https://docs.microsoft.com/en-us/dotnet/api/Newtonsoft.Json.Linq.JTokenType 'Newtonsoft\.Json\.Linq\.JTokenType') +Типа значения\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/TypeResolver.md b/Documentation/Pf2eDataScrapper/TypeResolver.md new file mode 100644 index 0000000..23c1d27 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/TypeResolver.md @@ -0,0 +1,24 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.SchemaBuilder](Pf2eDataScrapper.SchemaBuilder.md 'Pf2eDataScrapper\.SchemaBuilder') + +## TypeResolver Class + +Класс для определения типа поля в схеме данных\. + +```csharp +internal class TypeResolver +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 TypeResolver + +Derived +↳ [AonprdTypeResolver](AonprdTypeResolver.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Preparation\.AonprdTypeResolver') +↳ [SchemaTypeResolver](SchemaTypeResolver.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Processors\.Preparation\.SchemaTypeResolver') + +| Methods | | +| :--- | :--- | +| [CheckPath\(SchemaNode, string\)](TypeResolver.CheckPath.md#Pf2eDataScrapper.SchemaBuilder.TypeResolver.CheckPath(Pf2eDataScrapper.SchemaBuilder.SchemaNode,string) 'Pf2eDataScrapper\.SchemaBuilder\.TypeResolver\.CheckPath\(Pf2eDataScrapper\.SchemaBuilder\.SchemaNode, string\)') | Проверка соответствия пути\. | +| [CheckPath\(SchemaNode, ICollection<string>\)](TypeResolver.CheckPath.md#Pf2eDataScrapper.SchemaBuilder.TypeResolver.CheckPath(Pf2eDataScrapper.SchemaBuilder.SchemaNode,System.Collections.Generic.ICollection_string_) 'Pf2eDataScrapper\.SchemaBuilder\.TypeResolver\.CheckPath\(Pf2eDataScrapper\.SchemaBuilder\.SchemaNode, System\.Collections\.Generic\.ICollection\\)') | Проверка соответствия пути\. | +| [CustomResolve\(SchemaNode, JToken\)](TypeResolver.CustomResolve(SchemaNode,JToken).md 'Pf2eDataScrapper\.SchemaBuilder\.TypeResolver\.CustomResolve\(Pf2eDataScrapper\.SchemaBuilder\.SchemaNode, Newtonsoft\.Json\.Linq\.JToken\)') | Частное определение типа поля\. | +| [Resolve\(SchemaNode, JToken, bool\)](TypeResolver.Resolve(SchemaNode,JToken,bool).md 'Pf2eDataScrapper\.SchemaBuilder\.TypeResolver\.Resolve\(Pf2eDataScrapper\.SchemaBuilder\.SchemaNode, Newtonsoft\.Json\.Linq\.JToken, bool\)') | Определение типа поля\. | +| [TokenType\(JToken\)](TypeResolver.TokenType(JToken).md 'Pf2eDataScrapper\.SchemaBuilder\.TypeResolver\.TokenType\(Newtonsoft\.Json\.Linq\.JToken\)') | Получение типа значения\. | diff --git a/Documentation/Pf2eDataScrapper/VersitileHeritageProcessor.Add().md b/Documentation/Pf2eDataScrapper/VersitileHeritageProcessor.Add().md new file mode 100644 index 0000000..b41be03 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/VersitileHeritageProcessor.Add().md @@ -0,0 +1,10 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types').[VersitileHeritageProcessor](VersitileHeritageProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.VersitileHeritageProcessor') + +## VersitileHeritageProcessor\.Add\(\) Method + +Добавление основной сущности в контекст базы данных\. + +```csharp +protected override void Add(); +``` \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/VersitileHeritageProcessor.Object.md b/Documentation/Pf2eDataScrapper/VersitileHeritageProcessor.Object.md new file mode 100644 index 0000000..5e9879f --- /dev/null +++ b/Documentation/Pf2eDataScrapper/VersitileHeritageProcessor.Object.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types').[VersitileHeritageProcessor](VersitileHeritageProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.VersitileHeritageProcessor') + +## VersitileHeritageProcessor\.Object Property + +Основная сущность\. + +```csharp +public virtual Pf2eModel.Model.Structure.Heritage Object { get; } +``` + +#### Property Value +[Pf2eModel\.Model\.Structure\.Heritage](https://docs.microsoft.com/en-us/dotnet/api/Pf2eModel.Model.Structure.Heritage 'Pf2eModel\.Model\.Structure\.Heritage') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/VersitileHeritageProcessor.Process().md b/Documentation/Pf2eDataScrapper/VersitileHeritageProcessor.Process().md new file mode 100644 index 0000000..f17c28e --- /dev/null +++ b/Documentation/Pf2eDataScrapper/VersitileHeritageProcessor.Process().md @@ -0,0 +1,12 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types').[VersitileHeritageProcessor](VersitileHeritageProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.VersitileHeritageProcessor') + +## VersitileHeritageProcessor\.Process\(\) Method + +Основной метод обработки данных\. + +```csharp +public override void Process(); +``` + +Implements [Process\(\)](IProcessor.Process().md 'Pf2eDataScrapper\.Processors\.Definitions\.IProcessor\.Process\(\)') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/VersitileHeritageProcessor.Type.md b/Documentation/Pf2eDataScrapper/VersitileHeritageProcessor.Type.md new file mode 100644 index 0000000..5abb156 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/VersitileHeritageProcessor.Type.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types').[VersitileHeritageProcessor](VersitileHeritageProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.VersitileHeritageProcessor') + +## VersitileHeritageProcessor\.Type Property + +Тип сущности\. + +```csharp +public override Pf2eModel.Model.Enum.EntityType Type { get; } +``` + +#### Property Value +[Pf2eModel\.Model\.Enum\.EntityType](https://docs.microsoft.com/en-us/dotnet/api/Pf2eModel.Model.Enum.EntityType 'Pf2eModel\.Model\.Enum\.EntityType') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/VersitileHeritageProcessor.md b/Documentation/Pf2eDataScrapper/VersitileHeritageProcessor.md new file mode 100644 index 0000000..44ebf07 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/VersitileHeritageProcessor.md @@ -0,0 +1,20 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types') + +## VersitileHeritageProcessor Class + +```csharp +internal class VersitileHeritageProcessor : Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.AbstractEntityProcessor +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [AbstractInputProcessor](AbstractInputProcessor.md 'Pf2eDataScrapper\.Processors\.Definitions\.AbstractInputProcessor') 🡒 [AbstractEntityProcessor](AbstractEntityProcessor.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.AbstractEntityProcessor') 🡒 VersitileHeritageProcessor + +| Properties | | +| :--- | :--- | +| [Object](VersitileHeritageProcessor.Object.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.VersitileHeritageProcessor\.Object') | Основная сущность\. | +| [Type](VersitileHeritageProcessor.Type.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.VersitileHeritageProcessor\.Type') | Тип сущности\. | + +| Methods | | +| :--- | :--- | +| [Add\(\)](VersitileHeritageProcessor.Add().md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.VersitileHeritageProcessor\.Add\(\)') | Добавление основной сущности в контекст базы данных\. | +| [Process\(\)](VersitileHeritageProcessor.Process().md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.VersitileHeritageProcessor\.Process\(\)') | Основной метод обработки данных\. | diff --git a/Documentation/Pf2eDataScrapper/ViewControl.ButtonSize.md b/Documentation/Pf2eDataScrapper/ViewControl.ButtonSize.md new file mode 100644 index 0000000..a2cd3a6 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ViewControl.ButtonSize.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.Component](Pf2eDataScrapper.WPF.EntityViewer.Component.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.Component').[ViewControl](ViewControl.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.Component\.ViewControl') + +## ViewControl\.ButtonSize Property + +Размер кнопки плюс/минус\. + +```csharp +public double ButtonSize { get; set; } +``` + +#### Property Value +[System\.Double](https://docs.microsoft.com/en-us/dotnet/api/System.Double 'System\.Double') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ViewControl.DepthSize.md b/Documentation/Pf2eDataScrapper/ViewControl.DepthSize.md new file mode 100644 index 0000000..9fba045 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ViewControl.DepthSize.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.Component](Pf2eDataScrapper.WPF.EntityViewer.Component.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.Component').[ViewControl](ViewControl.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.Component\.ViewControl') + +## ViewControl\.DepthSize Property + +Ширина отступа глубины\. + +```csharp +public double DepthSize { get; set; } +``` + +#### Property Value +[System\.Double](https://docs.microsoft.com/en-us/dotnet/api/System.Double 'System\.Double') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ViewControl.InitializeComponent().md b/Documentation/Pf2eDataScrapper/ViewControl.InitializeComponent().md new file mode 100644 index 0000000..7e6c3f7 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ViewControl.InitializeComponent().md @@ -0,0 +1,12 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.Component](Pf2eDataScrapper.WPF.EntityViewer.Component.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.Component').[ViewControl](ViewControl.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.Component\.ViewControl') + +## ViewControl\.InitializeComponent\(\) Method + +InitializeComponent + +```csharp +public void InitializeComponent(); +``` + +Implements [InitializeComponent\(\)](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.Markup.IComponentConnector.InitializeComponent 'System\.Windows\.Markup\.IComponentConnector\.InitializeComponent') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ViewControl.ItemHeight.md b/Documentation/Pf2eDataScrapper/ViewControl.ItemHeight.md new file mode 100644 index 0000000..9d773e3 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ViewControl.ItemHeight.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.Component](Pf2eDataScrapper.WPF.EntityViewer.Component.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.Component').[ViewControl](ViewControl.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.Component\.ViewControl') + +## ViewControl\.ItemHeight Property + +Высота строки поля структуры\. + +```csharp +public double ItemHeight { get; set; } +``` + +#### Property Value +[System\.Double](https://docs.microsoft.com/en-us/dotnet/api/System.Double 'System\.Double') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ViewControl.TypeFontSize.md b/Documentation/Pf2eDataScrapper/ViewControl.TypeFontSize.md new file mode 100644 index 0000000..4576e60 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ViewControl.TypeFontSize.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.Component](Pf2eDataScrapper.WPF.EntityViewer.Component.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.Component').[ViewControl](ViewControl.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.Component\.ViewControl') + +## ViewControl\.TypeFontSize Property + +Размер шрифта типа поля сущности\. + +```csharp +public double TypeFontSize { get; set; } +``` + +#### Property Value +[System\.Double](https://docs.microsoft.com/en-us/dotnet/api/System.Double 'System\.Double') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ViewControl.md b/Documentation/Pf2eDataScrapper/ViewControl.md new file mode 100644 index 0000000..e3bb707 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ViewControl.md @@ -0,0 +1,23 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.Component](Pf2eDataScrapper.WPF.EntityViewer.Component.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.Component') + +## ViewControl Class + +```csharp +internal class ViewControl : System.Windows.Controls.UserControl, System.Windows.Markup.IComponentConnector +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [System\.Windows\.Threading\.DispatcherObject](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.Threading.DispatcherObject 'System\.Windows\.Threading\.DispatcherObject') 🡒 [System\.Windows\.DependencyObject](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.DependencyObject 'System\.Windows\.DependencyObject') 🡒 [System\.Windows\.Media\.Visual](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.Media.Visual 'System\.Windows\.Media\.Visual') 🡒 [System\.Windows\.UIElement](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.UIElement 'System\.Windows\.UIElement') 🡒 [System\.Windows\.FrameworkElement](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.FrameworkElement 'System\.Windows\.FrameworkElement') 🡒 [System\.Windows\.Controls\.Control](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.Controls.Control 'System\.Windows\.Controls\.Control') 🡒 [System\.Windows\.Controls\.ContentControl](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.Controls.ContentControl 'System\.Windows\.Controls\.ContentControl') 🡒 [System\.Windows\.Controls\.UserControl](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.Controls.UserControl 'System\.Windows\.Controls\.UserControl') 🡒 ViewControl + +Implements [System\.Windows\.Markup\.IComponentConnector](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.Markup.IComponentConnector 'System\.Windows\.Markup\.IComponentConnector') + +| Properties | | +| :--- | :--- | +| [ButtonSize](ViewControl.ButtonSize.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.Component\.ViewControl\.ButtonSize') | Размер кнопки плюс/минус\. | +| [DepthSize](ViewControl.DepthSize.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.Component\.ViewControl\.DepthSize') | Ширина отступа глубины\. | +| [ItemHeight](ViewControl.ItemHeight.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.Component\.ViewControl\.ItemHeight') | Высота строки поля структуры\. | +| [TypeFontSize](ViewControl.TypeFontSize.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.Component\.ViewControl\.TypeFontSize') | Размер шрифта типа поля сущности\. | + +| Methods | | +| :--- | :--- | +| [InitializeComponent\(\)](ViewControl.InitializeComponent().md 'Pf2eDataScrapper\.WPF\.EntityViewer\.Component\.ViewControl\.InitializeComponent\(\)') | InitializeComponent | diff --git a/Documentation/Pf2eDataScrapper/ViewLadder.DepthSize.md b/Documentation/Pf2eDataScrapper/ViewLadder.DepthSize.md new file mode 100644 index 0000000..55579ac --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ViewLadder.DepthSize.md @@ -0,0 +1,13 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.Component](Pf2eDataScrapper.WPF.EntityViewer.Component.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.Component').[ViewLadder](ViewLadder.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.Component\.ViewLadder') + +## ViewLadder\.DepthSize Property + +Ширина отступа глубины\. + +```csharp +public double DepthSize { get; set; } +``` + +#### Property Value +[System\.Double](https://docs.microsoft.com/en-us/dotnet/api/System.Double 'System\.Double') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ViewLadder.InitializeComponent().md b/Documentation/Pf2eDataScrapper/ViewLadder.InitializeComponent().md new file mode 100644 index 0000000..90ea332 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ViewLadder.InitializeComponent().md @@ -0,0 +1,12 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.Component](Pf2eDataScrapper.WPF.EntityViewer.Component.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.Component').[ViewLadder](ViewLadder.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.Component\.ViewLadder') + +## ViewLadder\.InitializeComponent\(\) Method + +InitializeComponent + +```csharp +public void InitializeComponent(); +``` + +Implements [InitializeComponent\(\)](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.Markup.IComponentConnector.InitializeComponent 'System\.Windows\.Markup\.IComponentConnector\.InitializeComponent') \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ViewLadder.md b/Documentation/Pf2eDataScrapper/ViewLadder.md new file mode 100644 index 0000000..4295f6d --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ViewLadder.md @@ -0,0 +1,22 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.Component](Pf2eDataScrapper.WPF.EntityViewer.Component.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.Component') + +## ViewLadder Class + +Логика взаимодействия для ViewLadder\.xaml + +```csharp +internal class ViewLadder : System.Windows.Controls.UserControl, System.Windows.Markup.IComponentConnector +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [System\.Windows\.Threading\.DispatcherObject](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.Threading.DispatcherObject 'System\.Windows\.Threading\.DispatcherObject') 🡒 [System\.Windows\.DependencyObject](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.DependencyObject 'System\.Windows\.DependencyObject') 🡒 [System\.Windows\.Media\.Visual](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.Media.Visual 'System\.Windows\.Media\.Visual') 🡒 [System\.Windows\.UIElement](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.UIElement 'System\.Windows\.UIElement') 🡒 [System\.Windows\.FrameworkElement](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.FrameworkElement 'System\.Windows\.FrameworkElement') 🡒 [System\.Windows\.Controls\.Control](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.Controls.Control 'System\.Windows\.Controls\.Control') 🡒 [System\.Windows\.Controls\.ContentControl](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.Controls.ContentControl 'System\.Windows\.Controls\.ContentControl') 🡒 [System\.Windows\.Controls\.UserControl](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.Controls.UserControl 'System\.Windows\.Controls\.UserControl') 🡒 ViewLadder + +Implements [System\.Windows\.Markup\.IComponentConnector](https://docs.microsoft.com/en-us/dotnet/api/System.Windows.Markup.IComponentConnector 'System\.Windows\.Markup\.IComponentConnector') + +| Properties | | +| :--- | :--- | +| [DepthSize](ViewLadder.DepthSize.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.Component\.ViewLadder\.DepthSize') | Ширина отступа глубины\. | + +| Methods | | +| :--- | :--- | +| [InitializeComponent\(\)](ViewLadder.InitializeComponent().md 'Pf2eDataScrapper\.WPF\.EntityViewer\.Component\.ViewLadder\.InitializeComponent\(\)') | InitializeComponent | diff --git a/Documentation/Pf2eDataScrapper/ViewViewModel.BuildLadder().md b/Documentation/Pf2eDataScrapper/ViewViewModel.BuildLadder().md new file mode 100644 index 0000000..63d999f --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ViewViewModel.BuildLadder().md @@ -0,0 +1,10 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.ViewModel](Pf2eDataScrapper.WPF.EntityViewer.ViewModel.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.ViewModel').[ViewViewModel](ViewViewModel.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.ViewModel\.ViewViewModel') + +## ViewViewModel\.BuildLadder\(\) Method + +Построение лестницы для строк полей структуры\. + +```csharp +private void BuildLadder(); +``` \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/ViewViewModel.md b/Documentation/Pf2eDataScrapper/ViewViewModel.md new file mode 100644 index 0000000..3163abb --- /dev/null +++ b/Documentation/Pf2eDataScrapper/ViewViewModel.md @@ -0,0 +1,14 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF\.EntityViewer\.ViewModel](Pf2eDataScrapper.WPF.EntityViewer.ViewModel.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.ViewModel') + +## ViewViewModel Class + +```csharp +internal class ViewViewModel : Pf2eDataScrapper.WPF.ViewModelBase +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [Pf2eDataScrapper\.WPF\.ViewModelBase](https://docs.microsoft.com/en-us/dotnet/api/Pf2eDataScrapper.WPF.ViewModelBase 'Pf2eDataScrapper\.WPF\.ViewModelBase') 🡒 ViewViewModel + +| Methods | | +| :--- | :--- | +| [BuildLadder\(\)](ViewViewModel.BuildLadder().md 'Pf2eDataScrapper\.WPF\.EntityViewer\.ViewModel\.ViewViewModel\.BuildLadder\(\)') | Построение лестницы для строк полей структуры\. | diff --git a/Documentation/Pf2eDataScrapper/WpfServiceProviderExtension.RegisterWpfServices(thisIServiceCollection).md b/Documentation/Pf2eDataScrapper/WpfServiceProviderExtension.RegisterWpfServices(thisIServiceCollection).md new file mode 100644 index 0000000..6877996 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/WpfServiceProviderExtension.RegisterWpfServices(thisIServiceCollection).md @@ -0,0 +1,21 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF](Pf2eDataScrapper.WPF.md 'Pf2eDataScrapper\.WPF').[WpfServiceProviderExtension](WpfServiceProviderExtension.md 'Pf2eDataScrapper\.WPF\.WpfServiceProviderExtension') + +## WpfServiceProviderExtension\.RegisterWpfServices\(this IServiceCollection\) Method + +Регистрация сервисов WPF в IServiceCollection\. + +```csharp +public static Microsoft.Extensions.DependencyInjection.IServiceCollection RegisterWpfServices(this Microsoft.Extensions.DependencyInjection.IServiceCollection collection); +``` +#### Parameters + + + +`collection` [Microsoft\.Extensions\.DependencyInjection\.IServiceCollection](https://docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.DependencyInjection.IServiceCollection 'Microsoft\.Extensions\.DependencyInjection\.IServiceCollection') + +Коллекция сервисов\. + +#### Returns +[Microsoft\.Extensions\.DependencyInjection\.IServiceCollection](https://docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.DependencyInjection.IServiceCollection 'Microsoft\.Extensions\.DependencyInjection\.IServiceCollection') +Коллекция сервисов \([collection](WpfServiceProviderExtension.RegisterWpfServices(thisIServiceCollection).md#Pf2eDataScrapper.WPF.WpfServiceProviderExtension.RegisterWpfServices(thisMicrosoft.Extensions.DependencyInjection.IServiceCollection).collection 'Pf2eDataScrapper\.WPF\.WpfServiceProviderExtension\.RegisterWpfServices\(this Microsoft\.Extensions\.DependencyInjection\.IServiceCollection\)\.collection') для Fluent API\)\. \ No newline at end of file diff --git a/Documentation/Pf2eDataScrapper/WpfServiceProviderExtension.md b/Documentation/Pf2eDataScrapper/WpfServiceProviderExtension.md new file mode 100644 index 0000000..ee37d30 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/WpfServiceProviderExtension.md @@ -0,0 +1,16 @@ +#### [Pf2eDataScrapper](index.md 'index') +### [Pf2eDataScrapper\.WPF](Pf2eDataScrapper.WPF.md 'Pf2eDataScrapper\.WPF') + +## WpfServiceProviderExtension Class + +Расширение для IServiceCollection, позволяющее регистрировать сервисы WPF\. + +```csharp +public static class WpfServiceProviderExtension +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 WpfServiceProviderExtension + +| Methods | | +| :--- | :--- | +| [RegisterWpfServices\(this IServiceCollection\)](WpfServiceProviderExtension.RegisterWpfServices(thisIServiceCollection).md 'Pf2eDataScrapper\.WPF\.WpfServiceProviderExtension\.RegisterWpfServices\(this Microsoft\.Extensions\.DependencyInjection\.IServiceCollection\)') | Регистрация сервисов WPF в IServiceCollection\. | diff --git a/Documentation/Pf2eDataScrapper/XamlGeneratedNamespace.md b/Documentation/Pf2eDataScrapper/XamlGeneratedNamespace.md new file mode 100644 index 0000000..d6b8914 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/XamlGeneratedNamespace.md @@ -0,0 +1,7 @@ +#### [Pf2eDataScrapper](index.md 'index') + +## XamlGeneratedNamespace Namespace + +| Classes | | +| :--- | :--- | +| [GeneratedInternalTypeHelper](GeneratedInternalTypeHelper.md 'XamlGeneratedNamespace\.GeneratedInternalTypeHelper') | GeneratedInternalTypeHelper | diff --git a/Documentation/Pf2eDataScrapper/index.md b/Documentation/Pf2eDataScrapper/index.md new file mode 100644 index 0000000..70d5df4 --- /dev/null +++ b/Documentation/Pf2eDataScrapper/index.md @@ -0,0 +1,38 @@ +#### [Pf2eDataScrapper](index.md 'index') + +## Pf2eDataScrapper Assembly + +| Namespaces | | +| :--- | :--- | +| [Pf2eDataScrapper](Pf2eDataScrapper.md 'Pf2eDataScrapper') | Модель классов ORM EntityFramework\. | +| [Pf2eDataScrapper\.Helpers](Pf2eDataScrapper.Helpers.md 'Pf2eDataScrapper\.Helpers') | Классы\-помощники, используемые во всех частях проекта\. | +| [Pf2eDataScrapper\.Importers](Pf2eDataScrapper.Importers.md 'Pf2eDataScrapper\.Importers') | Описание импортёров, которые определяют наборы обработчиков данных и элементов, необходимых для их работы\. | +| [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd](Pf2eDataScrapper.Importers.Implementations.Aonprd.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd') | Импортёр данных из сайта [Archives of Nethys Pathfinder 2e](https://aonprd.com/ 'https://aonprd\.com/')\. | +| [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Compendium](Pf2eDataScrapper.Importers.Implementations.Aonprd.Compendium.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Compendium') | Компендиум данных из сайта [Archives of Nethys Pathfinder 2e](https://aonprd.com/ 'https://aonprd\.com/')\. | +| [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers](Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Helpers') | Класс\-помощники, которые используются в импортере данных из сайта [Archives of Nethys Pathfinder 2e](https://aonprd.com/ 'https://aonprd\.com/')\. | +| [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors') | Обработчики данных из сайта [Archives of Nethys Pathfinder 2e](https://aonprd.com/ 'https://aonprd\.com/')\. | +| [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Preparation](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Preparation.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Preparation') | Обработчики для подготовки данных [Archives of Nethys Pathfinder 2e](https://aonprd.com/ 'https://aonprd\.com/')\. | +| [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Subclasses](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Subclasses.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Subclasses') | Обработчики подклассов с сайта [Archives of Nethys Pathfinder 2e](https://aonprd.com/ 'https://aonprd\.com/')\. | +| [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types') | Обработчики основных сущностей с сайта [Archives of Nethys Pathfinder 2e](https://aonprd.com/ 'https://aonprd\.com/')\. | +| [Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules](Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.Rules.md 'Pf2eDataScrapper\.Importers\.Implementations\.Aonprd\.Processors\.Types\.Rules') | Обработчики правил с сайта [Archives of Nethys Pathfinder 2e](https://aonprd.com/ 'https://aonprd\.com/')\. | +| [Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn](Pf2eDataScrapper.Importers.Implementations.FoundryEn.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn') | Импортёр данных из модуля [pf2e](https://github.com/foundryvtt/pf2e 'https://github\.com/foundryvtt/pf2e') для FoundryVTT\. | +| [Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium](Pf2eDataScrapper.Importers.Implementations.FoundryEn.Compendium.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Compendium') | Компендиум данных из модуля [pf2e](https://github.com/foundryvtt/pf2e 'https://github\.com/foundryvtt/pf2e') для FoundryVTT\. | +| [Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Processors\.Preparation](Pf2eDataScrapper.Importers.Implementations.FoundryEn.Processors.Preparation.md 'Pf2eDataScrapper\.Importers\.Implementations\.FoundryEn\.Processors\.Preparation') | Обработчики для подготовки данных из модуля [pf2e](https://github.com/foundryvtt/pf2e 'https://github\.com/foundryvtt/pf2e') для FoundryVTT\. | +| [Pf2eDataScrapper\.Importers\.Repositories](Pf2eDataScrapper.Importers.Repositories.md 'Pf2eDataScrapper\.Importers\.Repositories') | Общее описание репозиториев для хранения данных, которые используются в импортёрах и процессорах\. | +| [Pf2eDataScrapper\.Processors](Pf2eDataScrapper.Processors.md 'Pf2eDataScrapper\.Processors') | Общее описание обработчиков данных\. | +| [Pf2eDataScrapper\.Processors\.Attributes](Pf2eDataScrapper.Processors.Attributes.md 'Pf2eDataScrapper\.Processors\.Attributes') | Классы\-аттрибуты, которые используются для описания обработчиков данных и их свойств\. | +| [Pf2eDataScrapper\.Processors\.Collection](Pf2eDataScrapper.Processors.Collection.md 'Pf2eDataScrapper\.Processors\.Collection') | Описание коллекции классов обработчиков данных\. | +| [Pf2eDataScrapper\.Processors\.Definitions](Pf2eDataScrapper.Processors.Definitions.md 'Pf2eDataScrapper\.Processors\.Definitions') | Общее описание классов и интерфейсов, которые используются в обработчиках данных\. | +| [Pf2eDataScrapper\.Processors\.Factory](Pf2eDataScrapper.Processors.Factory.md 'Pf2eDataScrapper\.Processors\.Factory') | Фабрики для создания экземпляров обработчиков данных на основе их атрибутов и конфигурации\. | +| [Pf2eDataScrapper\.SchemaBuilder](Pf2eDataScrapper.SchemaBuilder.md 'Pf2eDataScrapper\.SchemaBuilder') | Классы обработки вводимых JSON\-данных и создание схемы данных для использовании при формировании обработчиков данных\. | +| [Pf2eDataScrapper\.SchemaBuilder\.Types](Pf2eDataScrapper.SchemaBuilder.Types.md 'Pf2eDataScrapper\.SchemaBuilder\.Types') | Типы полей, которые используются в схемах данных для описания структуры вводимых JSON\-данных\. | +| [Pf2eDataScrapper\.WPF](Pf2eDataScrapper.WPF.md 'Pf2eDataScrapper\.WPF') | WPF\-приложение для запуска обработчиков и просмотра данных Pathfinder 2e\. | +| [Pf2eDataScrapper\.WPF\.EntityViewer](Pf2eDataScrapper.WPF.EntityViewer.md 'Pf2eDataScrapper\.WPF\.EntityViewer') | WPF\-окно для просмотра сущностей Pathfinder 2e, с возможностью фильтрации и поиска по данным\. | +| [Pf2eDataScrapper\.WPF\.EntityViewer\.Component](Pf2eDataScrapper.WPF.EntityViewer.Component.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.Component') | Компоненты, которые используются в WPF\-окне просмотра сущностей Pathfinder 2e\. | +| [Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure](Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.EntityViewStructure') | Структура представления сущностей Pathfinder 2e в WPF\-приложении, включая классы и интерфейсы для отображения данных\. | +| [Pf2eDataScrapper\.WPF\.EntityViewer\.Stores](Pf2eDataScrapper.WPF.EntityViewer.Stores.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.Stores') | Хранилища данных для WPF\-приложения просмотра сущностей Pathfinder 2e, которые управляют состоянием и данными приложения\. | +| [Pf2eDataScrapper\.WPF\.EntityViewer\.ViewModel](Pf2eDataScrapper.WPF.EntityViewer.ViewModel.md 'Pf2eDataScrapper\.WPF\.EntityViewer\.ViewModel') | ViewModel для WPF\-приложения просмотра сущностей Pathfinder 2e, которые связывают данные и представление\. | +| [Pf2eDataScrapper\.WPF\.ProgressForm](Pf2eDataScrapper.WPF.ProgressForm.md 'Pf2eDataScrapper\.WPF\.ProgressForm') | WPF\-окно для отображения прогресса выполнения операций, таких как импорт данных или обработка сущностей Pathfinder 2e\. | +| [Pf2eDataScrapper\.WPF\.StartForm](Pf2eDataScrapper.WPF.StartForm.md 'Pf2eDataScrapper\.WPF\.StartForm') | WPF\-окно для запуска приложения, которое позволяет пользователю выбрать импортёр и начать обработку данных Pathfinder 2e\. | +| [Pf2eDataScrapper\.WPF\.StartForm\.Components](Pf2eDataScrapper.WPF.StartForm.Components.md 'Pf2eDataScrapper\.WPF\.StartForm\.Components') | Компоненты, которые используются в WPF\-окне запуска приложения для выбора импортёра и настройки параметров обработки данных Pathfinder 2e\. | +| [XamlGeneratedNamespace](XamlGeneratedNamespace.md 'XamlGeneratedNamespace') | | diff --git a/Documentation/Pf2eModel/Action.Actions.md b/Documentation/Pf2eModel/Action.Actions.md new file mode 100644 index 0000000..f6376f1 --- /dev/null +++ b/Documentation/Pf2eModel/Action.Actions.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Action](Action.md 'Pf2eModel\.Model\.Structure\.Action') + +## Action\.Actions Property + +Количество действий\. + +```csharp +public Pf2eModel.Model.Enum.ActionEnum Actions { get; set; } +``` + +#### Property Value +[ActionEnum](ActionEnum.md 'Pf2eModel\.Model\.Enum\.ActionEnum') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Action.Category.md b/Documentation/Pf2eModel/Action.Category.md new file mode 100644 index 0000000..a6840f7 --- /dev/null +++ b/Documentation/Pf2eModel/Action.Category.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Action](Action.md 'Pf2eModel\.Model\.Structure\.Action') + +## Action\.Category Property + +Категория действия\. + +```csharp +public Pf2eModel.Model.Enum.ActionCategory Category { get; set; } +``` + +#### Property Value +[ActionCategory](ActionCategory.md 'Pf2eModel\.Model\.Enum\.ActionCategory') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Action.Entity.md b/Documentation/Pf2eModel/Action.Entity.md new file mode 100644 index 0000000..d30db6a --- /dev/null +++ b/Documentation/Pf2eModel/Action.Entity.md @@ -0,0 +1,15 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Action](Action.md 'Pf2eModel\.Model\.Structure\.Action') + +## Action\.Entity Property + +Корневая сущность\. + +```csharp +public Pf2eModel.Model.Base.Entity Entity { get; set; } +``` + +Implements [Entity](IEntity.Entity.md 'Pf2eModel\.Model\.IEntity\.Entity') + +#### Property Value +[Entity](Entity.md 'Pf2eModel\.Model\.Base\.Entity') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Action.Extra.md b/Documentation/Pf2eModel/Action.Extra.md new file mode 100644 index 0000000..25f50a2 --- /dev/null +++ b/Documentation/Pf2eModel/Action.Extra.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Action](Action.md 'Pf2eModel\.Model\.Structure\.Action') + +## Action\.Extra Property + +Дополнительная информация\. + +```csharp +public string? Extra { get; set; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Action.Id.md b/Documentation/Pf2eModel/Action.Id.md new file mode 100644 index 0000000..48a8f33 --- /dev/null +++ b/Documentation/Pf2eModel/Action.Id.md @@ -0,0 +1,15 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Action](Action.md 'Pf2eModel\.Model\.Structure\.Action') + +## Action\.Id Property + +Идентификатор сущности\. + +```csharp +public int Id { get; set; } +``` + +Implements [Id](IEntity.Id.md 'Pf2eModel\.Model\.IEntity\.Id') + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Action.md b/Documentation/Pf2eModel/Action.md new file mode 100644 index 0000000..70c0b42 --- /dev/null +++ b/Documentation/Pf2eModel/Action.md @@ -0,0 +1,22 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure') + +## Action Class + +Действие\. + +```csharp +public class Action : Pf2eModel.Model.IEntity +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 Action + +Implements [IEntity](IEntity.md 'Pf2eModel\.Model\.IEntity') + +| Properties | | +| :--- | :--- | +| [Actions](Action.Actions.md 'Pf2eModel\.Model\.Structure\.Action\.Actions') | Количество действий\. | +| [Category](Action.Category.md 'Pf2eModel\.Model\.Structure\.Action\.Category') | Категория действия\. | +| [Entity](Action.Entity.md 'Pf2eModel\.Model\.Structure\.Action\.Entity') | Корневая сущность\. | +| [Extra](Action.Extra.md 'Pf2eModel\.Model\.Structure\.Action\.Extra') | Дополнительная информация\. | +| [Id](Action.Id.md 'Pf2eModel\.Model\.Structure\.Action\.Id') | Идентификатор сущности\. | diff --git a/Documentation/Pf2eModel/ActionCategory.md b/Documentation/Pf2eModel/ActionCategory.md new file mode 100644 index 0000000..5d7feb2 --- /dev/null +++ b/Documentation/Pf2eModel/ActionCategory.md @@ -0,0 +1,95 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Enum](Pf2eModel.Model.Enum.md 'Pf2eModel\.Model\.Enum') + +## ActionCategory Enum + +Тип действия\. + +```csharp +public enum ActionCategory +``` +### Fields + + + +`Unknown` 0 + +Неизвестный тип действия\. + + + +`Archetype` 1 + +Действие архетипа\. + + + +`SkillAction` 2 + +Дествие навыка\. + + + +`ClassFeature` 3 + +Действие классовой способности\. + + + +`ClassFeat` 4 + +Действие классовой черты\. + + + +`Offensive` 5 + +Действие атаки\. + + + +`Defensive` 6 + +Действие защиты\. + + + +`Interaction` 7 + +Действие взаимодействия\. + + + +`Familiar` 8 + +Действие фамильяра\. + + + +`ArmyTactic` 9 + +Действие тактики армии\. + + + +`ArmyWarAction` 10 + +Действие войны армии\. + + + +`KingdomActivity` 11 + +Активность королевства\. + + + +`KingdomFeat` 12 + +Действие черты королевства\. + + + +`KingdomFeature` 13 + +Действие особенности королевства\. \ No newline at end of file diff --git a/Documentation/Pf2eModel/ActionEnum.md b/Documentation/Pf2eModel/ActionEnum.md new file mode 100644 index 0000000..6fb6977 --- /dev/null +++ b/Documentation/Pf2eModel/ActionEnum.md @@ -0,0 +1,137 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Enum](Pf2eModel.Model.Enum.md 'Pf2eModel\.Model\.Enum') + +## ActionEnum Enum + +Перечиленение количества действий\. + +```csharp +public enum ActionEnum +``` +### Fields + + + +`Unknown` 0 + +Неизвестное количество действий\. + + + +`SingleAction` 1 + +Одно действие\. + + + +`TwoActions` 2 + +Два действия\. + + + +`ThreeActions` 3 + +Три действия\. + + + +`Reaction` 4 + +Реакция\. + + + +`FreeAction` 5 + +Свободное действие\. + + + +`Passive` 6 + +Пассивное действие\. + + + +`Other` 7 + +Иное количество действий, не указанное в перечислении\. + + + +`SingleActionToThreeActions` 8 + +От одного до трёх действий\. + + + +`SingleActionToTwoActions` 9 + +От одного до двух действий\. + + + +`TwoActionsToThreeActions` 10 + +От двух до трёх действий\. + + + +`TwoActionsToTwoRounds` 11 + +От двух действий до двух раундов\. + + + +`ReactionOrOneAction` 12 + +Реакция или одно действие\. + + + +`ReactionOrTwoAction` 13 + +Реакция или два действия\. + + + +`ReactionOrThreeAction` 14 + +Реакция или три действия\. + + + +`FreeActionOrOneAction` 15 + +Свободное действие или одно действие\. + + + +`OneMinute` 16 + +Одная минута\. + + + +`FiveMinutes` 17 + +Пять минут\. + + + +`TenMinutes` 18 + +Десять минут\. + + + +`ThirtyMinutes` 19 + +Тридцать минут\. + + + +`OneHour` 20 + +Один час\. \ No newline at end of file diff --git a/Documentation/Pf2eModel/Ancestry.AncestryBoosts.md b/Documentation/Pf2eModel/Ancestry.AncestryBoosts.md new file mode 100644 index 0000000..92eb599 --- /dev/null +++ b/Documentation/Pf2eModel/Ancestry.AncestryBoosts.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Ancestry](Ancestry.md 'Pf2eModel\.Model\.Structure\.Ancestry') + +## Ancestry\.AncestryBoosts Property + +Коллекция повышениий аттрибутов\. + +```csharp +public System.Collections.Generic.ICollection AncestryBoosts { get; set; } +``` + +#### Property Value +[System\.Collections\.Generic\.ICollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1')[AncestryBoost](AncestryBoost.md 'Pf2eModel\.Model\.Structure\.AncestryRelation\.AncestryBoost')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Ancestry.AncestryItems.md b/Documentation/Pf2eModel/Ancestry.AncestryItems.md new file mode 100644 index 0000000..99dbb73 --- /dev/null +++ b/Documentation/Pf2eModel/Ancestry.AncestryItems.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Ancestry](Ancestry.md 'Pf2eModel\.Model\.Structure\.Ancestry') + +## Ancestry\.AncestryItems Property + +Коллекция сущностей родословной\. + +```csharp +public System.Collections.Generic.ICollection AncestryItems { get; set; } +``` + +#### Property Value +[System\.Collections\.Generic\.ICollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1')[AncestryItem](AncestryItem.md 'Pf2eModel\.Model\.Structure\.AncestryRelation\.AncestryItem')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Ancestry.AncestryLanguages.md b/Documentation/Pf2eModel/Ancestry.AncestryLanguages.md new file mode 100644 index 0000000..af75d03 --- /dev/null +++ b/Documentation/Pf2eModel/Ancestry.AncestryLanguages.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Ancestry](Ancestry.md 'Pf2eModel\.Model\.Structure\.Ancestry') + +## Ancestry\.AncestryLanguages Property + +Коллекция языков родословной\. + +```csharp +public System.Collections.Generic.ICollection AncestryLanguages { get; set; } +``` + +#### Property Value +[System\.Collections\.Generic\.ICollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1')[AncestryLanguage](AncestryLanguage.md 'Pf2eModel\.Model\.Structure\.AncestryRelation\.AncestryLanguage')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Ancestry.Entity.md b/Documentation/Pf2eModel/Ancestry.Entity.md new file mode 100644 index 0000000..f6d18f0 --- /dev/null +++ b/Documentation/Pf2eModel/Ancestry.Entity.md @@ -0,0 +1,15 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Ancestry](Ancestry.md 'Pf2eModel\.Model\.Structure\.Ancestry') + +## Ancestry\.Entity Property + +Корневая сущность\. + +```csharp +public Pf2eModel.Model.Base.Entity Entity { get; set; } +``` + +Implements [Entity](IEntity.Entity.md 'Pf2eModel\.Model\.IEntity\.Entity') + +#### Property Value +[Entity](Entity.md 'Pf2eModel\.Model\.Base\.Entity') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Ancestry.Heritages.md b/Documentation/Pf2eModel/Ancestry.Heritages.md new file mode 100644 index 0000000..ed98cfb --- /dev/null +++ b/Documentation/Pf2eModel/Ancestry.Heritages.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Ancestry](Ancestry.md 'Pf2eModel\.Model\.Structure\.Ancestry') + +## Ancestry\.Heritages Property + +Коллекция наследий\. + +```csharp +public System.Collections.Generic.ICollection Heritages { get; set; } +``` + +#### Property Value +[System\.Collections\.Generic\.ICollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1')[Heritage](Heritage.md 'Pf2eModel\.Model\.Structure\.Heritage')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Ancestry.Hp.md b/Documentation/Pf2eModel/Ancestry.Hp.md new file mode 100644 index 0000000..441232a --- /dev/null +++ b/Documentation/Pf2eModel/Ancestry.Hp.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Ancestry](Ancestry.md 'Pf2eModel\.Model\.Structure\.Ancestry') + +## Ancestry\.Hp Property + +Количество очков здоровья\. + +```csharp +public int Hp { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Ancestry.Id.md b/Documentation/Pf2eModel/Ancestry.Id.md new file mode 100644 index 0000000..1fa80d4 --- /dev/null +++ b/Documentation/Pf2eModel/Ancestry.Id.md @@ -0,0 +1,15 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Ancestry](Ancestry.md 'Pf2eModel\.Model\.Structure\.Ancestry') + +## Ancestry\.Id Property + +Идентификатор сущности\. + +```csharp +public int Id { get; set; } +``` + +Implements [Id](IEntity.Id.md 'Pf2eModel\.Model\.IEntity\.Id') + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Ancestry.Size.md b/Documentation/Pf2eModel/Ancestry.Size.md new file mode 100644 index 0000000..9262a6d --- /dev/null +++ b/Documentation/Pf2eModel/Ancestry.Size.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Ancestry](Ancestry.md 'Pf2eModel\.Model\.Structure\.Ancestry') + +## Ancestry\.Size Property + +Размеры родословной\. + +```csharp +public Pf2eModel.Model.Enum.SizeEnum[] Size { get; set; } +``` + +#### Property Value +[SizeEnum](SizeEnum.md 'Pf2eModel\.Model\.Enum\.SizeEnum')[\[\]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System\.Array') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Ancestry.Speed.md b/Documentation/Pf2eModel/Ancestry.Speed.md new file mode 100644 index 0000000..22e66b4 --- /dev/null +++ b/Documentation/Pf2eModel/Ancestry.Speed.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Ancestry](Ancestry.md 'Pf2eModel\.Model\.Structure\.Ancestry') + +## Ancestry\.Speed Property + +Скорость передвижения\. + +```csharp +public int Speed { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Ancestry.VisionEnum.md b/Documentation/Pf2eModel/Ancestry.VisionEnum.md new file mode 100644 index 0000000..426863b --- /dev/null +++ b/Documentation/Pf2eModel/Ancestry.VisionEnum.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Ancestry](Ancestry.md 'Pf2eModel\.Model\.Structure\.Ancestry') + +## Ancestry\.VisionEnum Property + +Тип зрения\. + +```csharp +public Pf2eModel.Model.Enum.VisionEnum VisionEnum { get; set; } +``` + +#### Property Value +[VisionEnum](VisionEnum.md 'Pf2eModel\.Model\.Enum\.VisionEnum') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Ancestry.md b/Documentation/Pf2eModel/Ancestry.md new file mode 100644 index 0000000..91aaa53 --- /dev/null +++ b/Documentation/Pf2eModel/Ancestry.md @@ -0,0 +1,27 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure') + +## Ancestry Class + +Родословная\. + +```csharp +public class Ancestry : Pf2eModel.Model.IEntity +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 Ancestry + +Implements [IEntity](IEntity.md 'Pf2eModel\.Model\.IEntity') + +| Properties | | +| :--- | :--- | +| [AncestryBoosts](Ancestry.AncestryBoosts.md 'Pf2eModel\.Model\.Structure\.Ancestry\.AncestryBoosts') | Коллекция повышениий аттрибутов\. | +| [AncestryItems](Ancestry.AncestryItems.md 'Pf2eModel\.Model\.Structure\.Ancestry\.AncestryItems') | Коллекция сущностей родословной\. | +| [AncestryLanguages](Ancestry.AncestryLanguages.md 'Pf2eModel\.Model\.Structure\.Ancestry\.AncestryLanguages') | Коллекция языков родословной\. | +| [Entity](Ancestry.Entity.md 'Pf2eModel\.Model\.Structure\.Ancestry\.Entity') | Корневая сущность\. | +| [Heritages](Ancestry.Heritages.md 'Pf2eModel\.Model\.Structure\.Ancestry\.Heritages') | Коллекция наследий\. | +| [Hp](Ancestry.Hp.md 'Pf2eModel\.Model\.Structure\.Ancestry\.Hp') | Количество очков здоровья\. | +| [Id](Ancestry.Id.md 'Pf2eModel\.Model\.Structure\.Ancestry\.Id') | Идентификатор сущности\. | +| [Size](Ancestry.Size.md 'Pf2eModel\.Model\.Structure\.Ancestry\.Size') | Размеры родословной\. | +| [Speed](Ancestry.Speed.md 'Pf2eModel\.Model\.Structure\.Ancestry\.Speed') | Скорость передвижения\. | +| [VisionEnum](Ancestry.VisionEnum.md 'Pf2eModel\.Model\.Structure\.Ancestry\.VisionEnum') | Тип зрения\. | diff --git a/Documentation/Pf2eModel/AncestryBoost.Ancestry.md b/Documentation/Pf2eModel/AncestryBoost.Ancestry.md new file mode 100644 index 0000000..aa343bf --- /dev/null +++ b/Documentation/Pf2eModel/AncestryBoost.Ancestry.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.AncestryRelation](Pf2eModel.Model.Structure.AncestryRelation.md 'Pf2eModel\.Model\.Structure\.AncestryRelation').[AncestryBoost](AncestryBoost.md 'Pf2eModel\.Model\.Structure\.AncestryRelation\.AncestryBoost') + +## AncestryBoost\.Ancestry Property + +Родословная, к которой относится этот элемент набора повышений атрибутов\. + +```csharp +public Pf2eModel.Model.Structure.Ancestry Ancestry { get; set; } +``` + +#### Property Value +[Ancestry](Ancestry.md 'Pf2eModel\.Model\.Structure\.Ancestry') \ No newline at end of file diff --git a/Documentation/Pf2eModel/AncestryBoost.AncestryId.md b/Documentation/Pf2eModel/AncestryBoost.AncestryId.md new file mode 100644 index 0000000..719efde --- /dev/null +++ b/Documentation/Pf2eModel/AncestryBoost.AncestryId.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.AncestryRelation](Pf2eModel.Model.Structure.AncestryRelation.md 'Pf2eModel\.Model\.Structure\.AncestryRelation').[AncestryBoost](AncestryBoost.md 'Pf2eModel\.Model\.Structure\.AncestryRelation\.AncestryBoost') + +## AncestryBoost\.AncestryId Property + +Идентификатор родословной, к которой относится этот элемент\. + +```csharp +public int AncestryId { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/AncestryBoost.Boost.md b/Documentation/Pf2eModel/AncestryBoost.Boost.md new file mode 100644 index 0000000..2666670 --- /dev/null +++ b/Documentation/Pf2eModel/AncestryBoost.Boost.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.AncestryRelation](Pf2eModel.Model.Structure.AncestryRelation.md 'Pf2eModel\.Model\.Structure\.AncestryRelation').[AncestryBoost](AncestryBoost.md 'Pf2eModel\.Model\.Structure\.AncestryRelation\.AncestryBoost') + +## AncestryBoost\.Boost Property + +Указывает, является ли этот элемент повышением атрибута\. Если `false` \- это снижение атрибута\. + +```csharp +public bool Boost { get; set; } +``` + +#### Property Value +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') \ No newline at end of file diff --git a/Documentation/Pf2eModel/AncestryBoost.Id.md b/Documentation/Pf2eModel/AncestryBoost.Id.md new file mode 100644 index 0000000..ec0c49f --- /dev/null +++ b/Documentation/Pf2eModel/AncestryBoost.Id.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.AncestryRelation](Pf2eModel.Model.Structure.AncestryRelation.md 'Pf2eModel\.Model\.Structure\.AncestryRelation').[AncestryBoost](AncestryBoost.md 'Pf2eModel\.Model\.Structure\.AncestryRelation\.AncestryBoost') + +## AncestryBoost\.Id Property + +Идентификатор элемента\. + +```csharp +public int Id { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/AncestryBoost.Value.md b/Documentation/Pf2eModel/AncestryBoost.Value.md new file mode 100644 index 0000000..47a35e3 --- /dev/null +++ b/Documentation/Pf2eModel/AncestryBoost.Value.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.AncestryRelation](Pf2eModel.Model.Structure.AncestryRelation.md 'Pf2eModel\.Model\.Structure\.AncestryRelation').[AncestryBoost](AncestryBoost.md 'Pf2eModel\.Model\.Structure\.AncestryRelation\.AncestryBoost') + +## AncestryBoost\.Value Property + +Значение атрибута, которое повышается или понижается в этом элементе набора повышений атрибутов\. + +```csharp +public Pf2eModel.Model.Enum.AttributeValues Value { get; set; } +``` + +#### Property Value +[AttributeValues](AttributeValues.md 'Pf2eModel\.Model\.Enum\.AttributeValues') \ No newline at end of file diff --git a/Documentation/Pf2eModel/AncestryBoost.md b/Documentation/Pf2eModel/AncestryBoost.md new file mode 100644 index 0000000..b225e32 --- /dev/null +++ b/Documentation/Pf2eModel/AncestryBoost.md @@ -0,0 +1,20 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.AncestryRelation](Pf2eModel.Model.Structure.AncestryRelation.md 'Pf2eModel\.Model\.Structure\.AncestryRelation') + +## AncestryBoost Class + +Элемент набора повышений атрибутов для родословной\. + +```csharp +public class AncestryBoost +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 AncestryBoost + +| Properties | | +| :--- | :--- | +| [Ancestry](AncestryBoost.Ancestry.md 'Pf2eModel\.Model\.Structure\.AncestryRelation\.AncestryBoost\.Ancestry') | Родословная, к которой относится этот элемент набора повышений атрибутов\. | +| [AncestryId](AncestryBoost.AncestryId.md 'Pf2eModel\.Model\.Structure\.AncestryRelation\.AncestryBoost\.AncestryId') | Идентификатор родословной, к которой относится этот элемент\. | +| [Boost](AncestryBoost.Boost.md 'Pf2eModel\.Model\.Structure\.AncestryRelation\.AncestryBoost\.Boost') | Указывает, является ли этот элемент повышением атрибута\. Если `false` \- это снижение атрибута\. | +| [Id](AncestryBoost.Id.md 'Pf2eModel\.Model\.Structure\.AncestryRelation\.AncestryBoost\.Id') | Идентификатор элемента\. | +| [Value](AncestryBoost.Value.md 'Pf2eModel\.Model\.Structure\.AncestryRelation\.AncestryBoost\.Value') | Значение атрибута, которое повышается или понижается в этом элементе набора повышений атрибутов\. | diff --git a/Documentation/Pf2eModel/AncestryItem.Ancestry.md b/Documentation/Pf2eModel/AncestryItem.Ancestry.md new file mode 100644 index 0000000..e544757 --- /dev/null +++ b/Documentation/Pf2eModel/AncestryItem.Ancestry.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.AncestryRelation](Pf2eModel.Model.Structure.AncestryRelation.md 'Pf2eModel\.Model\.Structure\.AncestryRelation').[AncestryItem](AncestryItem.md 'Pf2eModel\.Model\.Structure\.AncestryRelation\.AncestryItem') + +## AncestryItem\.Ancestry Property + +Родословная, к которой относится сущность\. + +```csharp +public Pf2eModel.Model.Structure.Ancestry Ancestry { get; set; } +``` + +#### Property Value +[Ancestry](Ancestry.md 'Pf2eModel\.Model\.Structure\.Ancestry') \ No newline at end of file diff --git a/Documentation/Pf2eModel/AncestryItem.AncestryId.md b/Documentation/Pf2eModel/AncestryItem.AncestryId.md new file mode 100644 index 0000000..1e58c3f --- /dev/null +++ b/Documentation/Pf2eModel/AncestryItem.AncestryId.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.AncestryRelation](Pf2eModel.Model.Structure.AncestryRelation.md 'Pf2eModel\.Model\.Structure\.AncestryRelation').[AncestryItem](AncestryItem.md 'Pf2eModel\.Model\.Structure\.AncestryRelation\.AncestryItem') + +## AncestryItem\.AncestryId Property + +Идентификатор родословной\. + +```csharp +public int AncestryId { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/AncestryItem.Item.md b/Documentation/Pf2eModel/AncestryItem.Item.md new file mode 100644 index 0000000..c75a0d6 --- /dev/null +++ b/Documentation/Pf2eModel/AncestryItem.Item.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.AncestryRelation](Pf2eModel.Model.Structure.AncestryRelation.md 'Pf2eModel\.Model\.Structure\.AncestryRelation').[AncestryItem](AncestryItem.md 'Pf2eModel\.Model\.Structure\.AncestryRelation\.AncestryItem') + +## AncestryItem\.Item Property + +Сущность, связанная с родословной\. + +```csharp +public Pf2eModel.Model.Base.Entity Item { get; set; } +``` + +#### Property Value +[Entity](Entity.md 'Pf2eModel\.Model\.Base\.Entity') \ No newline at end of file diff --git a/Documentation/Pf2eModel/AncestryItem.ItemId.md b/Documentation/Pf2eModel/AncestryItem.ItemId.md new file mode 100644 index 0000000..7a81909 --- /dev/null +++ b/Documentation/Pf2eModel/AncestryItem.ItemId.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.AncestryRelation](Pf2eModel.Model.Structure.AncestryRelation.md 'Pf2eModel\.Model\.Structure\.AncestryRelation').[AncestryItem](AncestryItem.md 'Pf2eModel\.Model\.Structure\.AncestryRelation\.AncestryItem') + +## AncestryItem\.ItemId Property + +Идентификатор сущности, связанной с родословной\. + +```csharp +public int ItemId { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/AncestryItem.Level.md b/Documentation/Pf2eModel/AncestryItem.Level.md new file mode 100644 index 0000000..243675d --- /dev/null +++ b/Documentation/Pf2eModel/AncestryItem.Level.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.AncestryRelation](Pf2eModel.Model.Structure.AncestryRelation.md 'Pf2eModel\.Model\.Structure\.AncestryRelation').[AncestryItem](AncestryItem.md 'Pf2eModel\.Model\.Structure\.AncestryRelation\.AncestryItem') + +## AncestryItem\.Level Property + +Уровень сущности в родословной\. + +```csharp +public int Level { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/AncestryItem.md b/Documentation/Pf2eModel/AncestryItem.md new file mode 100644 index 0000000..6448a3d --- /dev/null +++ b/Documentation/Pf2eModel/AncestryItem.md @@ -0,0 +1,20 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.AncestryRelation](Pf2eModel.Model.Structure.AncestryRelation.md 'Pf2eModel\.Model\.Structure\.AncestryRelation') + +## AncestryItem Class + +Связь между родословной и сущностью\. + +```csharp +public class AncestryItem +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 AncestryItem + +| Properties | | +| :--- | :--- | +| [Ancestry](AncestryItem.Ancestry.md 'Pf2eModel\.Model\.Structure\.AncestryRelation\.AncestryItem\.Ancestry') | Родословная, к которой относится сущность\. | +| [AncestryId](AncestryItem.AncestryId.md 'Pf2eModel\.Model\.Structure\.AncestryRelation\.AncestryItem\.AncestryId') | Идентификатор родословной\. | +| [Item](AncestryItem.Item.md 'Pf2eModel\.Model\.Structure\.AncestryRelation\.AncestryItem\.Item') | Сущность, связанная с родословной\. | +| [ItemId](AncestryItem.ItemId.md 'Pf2eModel\.Model\.Structure\.AncestryRelation\.AncestryItem\.ItemId') | Идентификатор сущности, связанной с родословной\. | +| [Level](AncestryItem.Level.md 'Pf2eModel\.Model\.Structure\.AncestryRelation\.AncestryItem\.Level') | Уровень сущности в родословной\. | diff --git a/Documentation/Pf2eModel/AncestryLanguage.Ancestry.md b/Documentation/Pf2eModel/AncestryLanguage.Ancestry.md new file mode 100644 index 0000000..ac07b5c --- /dev/null +++ b/Documentation/Pf2eModel/AncestryLanguage.Ancestry.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.AncestryRelation](Pf2eModel.Model.Structure.AncestryRelation.md 'Pf2eModel\.Model\.Structure\.AncestryRelation').[AncestryLanguage](AncestryLanguage.md 'Pf2eModel\.Model\.Structure\.AncestryRelation\.AncestryLanguage') + +## AncestryLanguage\.Ancestry Property + +Родословная, к которой относится язык\. + +```csharp +public Pf2eModel.Model.Structure.Ancestry Ancestry { get; set; } +``` + +#### Property Value +[Ancestry](Ancestry.md 'Pf2eModel\.Model\.Structure\.Ancestry') \ No newline at end of file diff --git a/Documentation/Pf2eModel/AncestryLanguage.AncestryId.md b/Documentation/Pf2eModel/AncestryLanguage.AncestryId.md new file mode 100644 index 0000000..99cb8d9 --- /dev/null +++ b/Documentation/Pf2eModel/AncestryLanguage.AncestryId.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.AncestryRelation](Pf2eModel.Model.Structure.AncestryRelation.md 'Pf2eModel\.Model\.Structure\.AncestryRelation').[AncestryLanguage](AncestryLanguage.md 'Pf2eModel\.Model\.Structure\.AncestryRelation\.AncestryLanguage') + +## AncestryLanguage\.AncestryId Property + +Идентификатор родословной, к которой относится язык\. + +```csharp +public int AncestryId { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/AncestryLanguage.IsAdditional.md b/Documentation/Pf2eModel/AncestryLanguage.IsAdditional.md new file mode 100644 index 0000000..d051a14 --- /dev/null +++ b/Documentation/Pf2eModel/AncestryLanguage.IsAdditional.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.AncestryRelation](Pf2eModel.Model.Structure.AncestryRelation.md 'Pf2eModel\.Model\.Structure\.AncestryRelation').[AncestryLanguage](AncestryLanguage.md 'Pf2eModel\.Model\.Structure\.AncestryRelation\.AncestryLanguage') + +## AncestryLanguage\.IsAdditional Property + +Является ли язык дополнительным для родословной\. + +```csharp +public bool IsAdditional { get; set; } +``` + +#### Property Value +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') \ No newline at end of file diff --git a/Documentation/Pf2eModel/AncestryLanguage.Language.md b/Documentation/Pf2eModel/AncestryLanguage.Language.md new file mode 100644 index 0000000..f97ad45 --- /dev/null +++ b/Documentation/Pf2eModel/AncestryLanguage.Language.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.AncestryRelation](Pf2eModel.Model.Structure.AncestryRelation.md 'Pf2eModel\.Model\.Structure\.AncestryRelation').[AncestryLanguage](AncestryLanguage.md 'Pf2eModel\.Model\.Structure\.AncestryRelation\.AncestryLanguage') + +## AncestryLanguage\.Language Property + +Язык, связанный с родословной\. + +```csharp +public Pf2eModel.Model.Structure.Language Language { get; set; } +``` + +#### Property Value +[Language](Language.md 'Pf2eModel\.Model\.Structure\.Language') \ No newline at end of file diff --git a/Documentation/Pf2eModel/AncestryLanguage.LanguageId.md b/Documentation/Pf2eModel/AncestryLanguage.LanguageId.md new file mode 100644 index 0000000..e844004 --- /dev/null +++ b/Documentation/Pf2eModel/AncestryLanguage.LanguageId.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.AncestryRelation](Pf2eModel.Model.Structure.AncestryRelation.md 'Pf2eModel\.Model\.Structure\.AncestryRelation').[AncestryLanguage](AncestryLanguage.md 'Pf2eModel\.Model\.Structure\.AncestryRelation\.AncestryLanguage') + +## AncestryLanguage\.LanguageId Property + +Идентификатор языка, связанного с родословной\. + +```csharp +public int LanguageId { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/AncestryLanguage.md b/Documentation/Pf2eModel/AncestryLanguage.md new file mode 100644 index 0000000..d1b4172 --- /dev/null +++ b/Documentation/Pf2eModel/AncestryLanguage.md @@ -0,0 +1,20 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.AncestryRelation](Pf2eModel.Model.Structure.AncestryRelation.md 'Pf2eModel\.Model\.Structure\.AncestryRelation') + +## AncestryLanguage Class + +Связь между родословной и языком\. + +```csharp +public class AncestryLanguage +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 AncestryLanguage + +| Properties | | +| :--- | :--- | +| [Ancestry](AncestryLanguage.Ancestry.md 'Pf2eModel\.Model\.Structure\.AncestryRelation\.AncestryLanguage\.Ancestry') | Родословная, к которой относится язык\. | +| [AncestryId](AncestryLanguage.AncestryId.md 'Pf2eModel\.Model\.Structure\.AncestryRelation\.AncestryLanguage\.AncestryId') | Идентификатор родословной, к которой относится язык\. | +| [IsAdditional](AncestryLanguage.IsAdditional.md 'Pf2eModel\.Model\.Structure\.AncestryRelation\.AncestryLanguage\.IsAdditional') | Является ли язык дополнительным для родословной\. | +| [Language](AncestryLanguage.Language.md 'Pf2eModel\.Model\.Structure\.AncestryRelation\.AncestryLanguage\.Language') | Язык, связанный с родословной\. | +| [LanguageId](AncestryLanguage.LanguageId.md 'Pf2eModel\.Model\.Structure\.AncestryRelation\.AncestryLanguage\.LanguageId') | Идентификатор языка, связанного с родословной\. | diff --git a/Documentation/Pf2eModel/Archetype.DedicationFeat.md b/Documentation/Pf2eModel/Archetype.DedicationFeat.md new file mode 100644 index 0000000..7bdc0cb --- /dev/null +++ b/Documentation/Pf2eModel/Archetype.DedicationFeat.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Archetype](Archetype.md 'Pf2eModel\.Model\.Structure\.Archetype') + +## Archetype\.DedicationFeat Property + +Посвящение в архетип\. + +```csharp +public Pf2eModel.Model.Structure.Feat DedicationFeat { get; set; } +``` + +#### Property Value +[Feat](Feat.md 'Pf2eModel\.Model\.Structure\.Feat') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Archetype.DedicationFeatId.md b/Documentation/Pf2eModel/Archetype.DedicationFeatId.md new file mode 100644 index 0000000..bbac572 --- /dev/null +++ b/Documentation/Pf2eModel/Archetype.DedicationFeatId.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Archetype](Archetype.md 'Pf2eModel\.Model\.Structure\.Archetype') + +## Archetype\.DedicationFeatId Property + +Идентификатор способности, которая является посвящением в архетип\. + +```csharp +public System.Nullable DedicationFeatId { get; set; } +``` + +#### Property Value +[System\.Nullable<](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System\.Nullable\`1')[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System\.Nullable\`1') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Archetype.Entity.md b/Documentation/Pf2eModel/Archetype.Entity.md new file mode 100644 index 0000000..7af9183 --- /dev/null +++ b/Documentation/Pf2eModel/Archetype.Entity.md @@ -0,0 +1,15 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Archetype](Archetype.md 'Pf2eModel\.Model\.Structure\.Archetype') + +## Archetype\.Entity Property + +Корневая сущность\. + +```csharp +public Pf2eModel.Model.Base.Entity Entity { get; set; } +``` + +Implements [Entity](IEntity.Entity.md 'Pf2eModel\.Model\.IEntity\.Entity') + +#### Property Value +[Entity](Entity.md 'Pf2eModel\.Model\.Base\.Entity') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Archetype.Extra.md b/Documentation/Pf2eModel/Archetype.Extra.md new file mode 100644 index 0000000..9292af3 --- /dev/null +++ b/Documentation/Pf2eModel/Archetype.Extra.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Archetype](Archetype.md 'Pf2eModel\.Model\.Structure\.Archetype') + +## Archetype\.Extra Property + +Дополнительная информация об архетипе\. + +```csharp +public string? Extra { get; set; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Archetype.Feats.md b/Documentation/Pf2eModel/Archetype.Feats.md new file mode 100644 index 0000000..3803f20 --- /dev/null +++ b/Documentation/Pf2eModel/Archetype.Feats.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Archetype](Archetype.md 'Pf2eModel\.Model\.Structure\.Archetype') + +## Archetype\.Feats Property + +Способности архетипа\. + +```csharp +public System.Collections.Generic.ICollection Feats { get; set; } +``` + +#### Property Value +[System\.Collections\.Generic\.ICollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1')[Feat](Feat.md 'Pf2eModel\.Model\.Structure\.Feat')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Archetype.Id.md b/Documentation/Pf2eModel/Archetype.Id.md new file mode 100644 index 0000000..b1c8cac --- /dev/null +++ b/Documentation/Pf2eModel/Archetype.Id.md @@ -0,0 +1,15 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Archetype](Archetype.md 'Pf2eModel\.Model\.Structure\.Archetype') + +## Archetype\.Id Property + +Идентификатор сущности\. + +```csharp +public int Id { get; set; } +``` + +Implements [Id](IEntity.Id.md 'Pf2eModel\.Model\.IEntity\.Id') + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Archetype.Level.md b/Documentation/Pf2eModel/Archetype.Level.md new file mode 100644 index 0000000..db63df9 --- /dev/null +++ b/Documentation/Pf2eModel/Archetype.Level.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Archetype](Archetype.md 'Pf2eModel\.Model\.Structure\.Archetype') + +## Archetype\.Level Property + +Уровень\. + +```csharp +public int Level { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Archetype.md b/Documentation/Pf2eModel/Archetype.md new file mode 100644 index 0000000..51ec313 --- /dev/null +++ b/Documentation/Pf2eModel/Archetype.md @@ -0,0 +1,24 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure') + +## Archetype Class + +Архетип\. + +```csharp +public class Archetype : Pf2eModel.Model.IEntity +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 Archetype + +Implements [IEntity](IEntity.md 'Pf2eModel\.Model\.IEntity') + +| Properties | | +| :--- | :--- | +| [DedicationFeat](Archetype.DedicationFeat.md 'Pf2eModel\.Model\.Structure\.Archetype\.DedicationFeat') | Посвящение в архетип\. | +| [DedicationFeatId](Archetype.DedicationFeatId.md 'Pf2eModel\.Model\.Structure\.Archetype\.DedicationFeatId') | Идентификатор способности, которая является посвящением в архетип\. | +| [Entity](Archetype.Entity.md 'Pf2eModel\.Model\.Structure\.Archetype\.Entity') | Корневая сущность\. | +| [Extra](Archetype.Extra.md 'Pf2eModel\.Model\.Structure\.Archetype\.Extra') | Дополнительная информация об архетипе\. | +| [Feats](Archetype.Feats.md 'Pf2eModel\.Model\.Structure\.Archetype\.Feats') | Способности архетипа\. | +| [Id](Archetype.Id.md 'Pf2eModel\.Model\.Structure\.Archetype\.Id') | Идентификатор сущности\. | +| [Level](Archetype.Level.md 'Pf2eModel\.Model\.Structure\.Archetype\.Level') | Уровень\. | diff --git a/Documentation/Pf2eModel/ArchetypeFeats.ArchetypeId.md b/Documentation/Pf2eModel/ArchetypeFeats.ArchetypeId.md new file mode 100644 index 0000000..9a3e5ea --- /dev/null +++ b/Documentation/Pf2eModel/ArchetypeFeats.ArchetypeId.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.ArchetypeRelation](Pf2eModel.Model.Structure.ArchetypeRelation.md 'Pf2eModel\.Model\.Structure\.ArchetypeRelation').[ArchetypeFeats](ArchetypeFeats.md 'Pf2eModel\.Model\.Structure\.ArchetypeRelation\.ArchetypeFeats') + +## ArchetypeFeats\.ArchetypeId Property + +Идентификатор архетипа, к которому относится черта\. + +```csharp +public int ArchetypeId { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/ArchetypeFeats.FeatId.md b/Documentation/Pf2eModel/ArchetypeFeats.FeatId.md new file mode 100644 index 0000000..5aca938 --- /dev/null +++ b/Documentation/Pf2eModel/ArchetypeFeats.FeatId.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.ArchetypeRelation](Pf2eModel.Model.Structure.ArchetypeRelation.md 'Pf2eModel\.Model\.Structure\.ArchetypeRelation').[ArchetypeFeats](ArchetypeFeats.md 'Pf2eModel\.Model\.Structure\.ArchetypeRelation\.ArchetypeFeats') + +## ArchetypeFeats\.FeatId Property + +Идентификатор черты, связанной с архетипом\. + +```csharp +public int FeatId { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/ArchetypeFeats.md b/Documentation/Pf2eModel/ArchetypeFeats.md new file mode 100644 index 0000000..36b7d47 --- /dev/null +++ b/Documentation/Pf2eModel/ArchetypeFeats.md @@ -0,0 +1,17 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.ArchetypeRelation](Pf2eModel.Model.Structure.ArchetypeRelation.md 'Pf2eModel\.Model\.Structure\.ArchetypeRelation') + +## ArchetypeFeats Class + +Связь между архетипом и его чертами\. + +```csharp +public class ArchetypeFeats +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 ArchetypeFeats + +| Properties | | +| :--- | :--- | +| [ArchetypeId](ArchetypeFeats.ArchetypeId.md 'Pf2eModel\.Model\.Structure\.ArchetypeRelation\.ArchetypeFeats\.ArchetypeId') | Идентификатор архетипа, к которому относится черта\. | +| [FeatId](ArchetypeFeats.FeatId.md 'Pf2eModel\.Model\.Structure\.ArchetypeRelation\.ArchetypeFeats\.FeatId') | Идентификатор черты, связанной с архетипом\. | diff --git a/Documentation/Pf2eModel/AttributeValues.md b/Documentation/Pf2eModel/AttributeValues.md new file mode 100644 index 0000000..3501f7d --- /dev/null +++ b/Documentation/Pf2eModel/AttributeValues.md @@ -0,0 +1,53 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Enum](Pf2eModel.Model.Enum.md 'Pf2eModel\.Model\.Enum') + +## AttributeValues Enum + +Перечисление значений атрибутов\. + +```csharp +public enum AttributeValues +``` +### Fields + + + +`Free` 0 + +Свободный атрибут\. + + + +`Strength` 1 + +Сила\. + + + +`Dexterity` 2 + +Ловкость\. + + + +`Constitution` 3 + +Телосложение\. + + + +`Intelligence` 4 + +Интеллект\. + + + +`Wisdom` 5 + +Мудрость\. + + + +`Charisma` 6 + +Харизма\. \ No newline at end of file diff --git a/Documentation/Pf2eModel/Background.BackgroundBoosts.md b/Documentation/Pf2eModel/Background.BackgroundBoosts.md new file mode 100644 index 0000000..6368cdd --- /dev/null +++ b/Documentation/Pf2eModel/Background.BackgroundBoosts.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Background](Background.md 'Pf2eModel\.Model\.Structure\.Background') + +## Background\.BackgroundBoosts Property + +Аттрибуты предыстории\. + +```csharp +public System.Collections.Generic.ICollection BackgroundBoosts { get; set; } +``` + +#### Property Value +[System\.Collections\.Generic\.ICollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1')[BackgroundBoost](BackgroundBoost.md 'Pf2eModel\.Model\.Structure\.BackgroundRelation\.BackgroundBoost')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Background.BackgroundItems.md b/Documentation/Pf2eModel/Background.BackgroundItems.md new file mode 100644 index 0000000..bfc1300 --- /dev/null +++ b/Documentation/Pf2eModel/Background.BackgroundItems.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Background](Background.md 'Pf2eModel\.Model\.Structure\.Background') + +## Background\.BackgroundItems Property + +Способности предыстории\. + +```csharp +public System.Collections.Generic.ICollection BackgroundItems { get; set; } +``` + +#### Property Value +[System\.Collections\.Generic\.ICollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1')[BackgroundItem](BackgroundItem.md 'Pf2eModel\.Model\.Structure\.BackgroundRelation\.BackgroundItem')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Background.BackgroundSkills.md b/Documentation/Pf2eModel/Background.BackgroundSkills.md new file mode 100644 index 0000000..6b1b4c8 --- /dev/null +++ b/Documentation/Pf2eModel/Background.BackgroundSkills.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Background](Background.md 'Pf2eModel\.Model\.Structure\.Background') + +## Background\.BackgroundSkills Property + +Навыки предыстории\. + +```csharp +public System.Collections.Generic.ICollection BackgroundSkills { get; set; } +``` + +#### Property Value +[System\.Collections\.Generic\.ICollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1')[BackgroundTraining](BackgroundTraining.md 'Pf2eModel\.Model\.Structure\.BackgroundRelation\.BackgroundTraining')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Background.Entity.md b/Documentation/Pf2eModel/Background.Entity.md new file mode 100644 index 0000000..73e2faa --- /dev/null +++ b/Documentation/Pf2eModel/Background.Entity.md @@ -0,0 +1,15 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Background](Background.md 'Pf2eModel\.Model\.Structure\.Background') + +## Background\.Entity Property + +Корневая сущность\. + +```csharp +public Pf2eModel.Model.Base.Entity Entity { get; set; } +``` + +Implements [Entity](IEntity.Entity.md 'Pf2eModel\.Model\.IEntity\.Entity') + +#### Property Value +[Entity](Entity.md 'Pf2eModel\.Model\.Base\.Entity') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Background.Id.md b/Documentation/Pf2eModel/Background.Id.md new file mode 100644 index 0000000..2052759 --- /dev/null +++ b/Documentation/Pf2eModel/Background.Id.md @@ -0,0 +1,15 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Background](Background.md 'Pf2eModel\.Model\.Structure\.Background') + +## Background\.Id Property + +Идентификатор сущности\. + +```csharp +public int Id { get; set; } +``` + +Implements [Id](IEntity.Id.md 'Pf2eModel\.Model\.IEntity\.Id') + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Background.md b/Documentation/Pf2eModel/Background.md new file mode 100644 index 0000000..6fd7299 --- /dev/null +++ b/Documentation/Pf2eModel/Background.md @@ -0,0 +1,22 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure') + +## Background Class + +Предыстория\. + +```csharp +public class Background : Pf2eModel.Model.IEntity +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 Background + +Implements [IEntity](IEntity.md 'Pf2eModel\.Model\.IEntity') + +| Properties | | +| :--- | :--- | +| [BackgroundBoosts](Background.BackgroundBoosts.md 'Pf2eModel\.Model\.Structure\.Background\.BackgroundBoosts') | Аттрибуты предыстории\. | +| [BackgroundItems](Background.BackgroundItems.md 'Pf2eModel\.Model\.Structure\.Background\.BackgroundItems') | Способности предыстории\. | +| [BackgroundSkills](Background.BackgroundSkills.md 'Pf2eModel\.Model\.Structure\.Background\.BackgroundSkills') | Навыки предыстории\. | +| [Entity](Background.Entity.md 'Pf2eModel\.Model\.Structure\.Background\.Entity') | Корневая сущность\. | +| [Id](Background.Id.md 'Pf2eModel\.Model\.Structure\.Background\.Id') | Идентификатор сущности\. | diff --git a/Documentation/Pf2eModel/BackgroundBoost.Attribute.md b/Documentation/Pf2eModel/BackgroundBoost.Attribute.md new file mode 100644 index 0000000..2c58f35 --- /dev/null +++ b/Documentation/Pf2eModel/BackgroundBoost.Attribute.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.BackgroundRelation](Pf2eModel.Model.Structure.BackgroundRelation.md 'Pf2eModel\.Model\.Structure\.BackgroundRelation').[BackgroundBoost](BackgroundBoost.md 'Pf2eModel\.Model\.Structure\.BackgroundRelation\.BackgroundBoost') + +## BackgroundBoost\.Attribute Property + +Атрибут, к которому относится этот элемент набора атрибутов для предыстории\. + +```csharp +public Pf2eModel.Model.Enum.AttributeValues Attribute { get; set; } +``` + +#### Property Value +[AttributeValues](AttributeValues.md 'Pf2eModel\.Model\.Enum\.AttributeValues') \ No newline at end of file diff --git a/Documentation/Pf2eModel/BackgroundBoost.Background.md b/Documentation/Pf2eModel/BackgroundBoost.Background.md new file mode 100644 index 0000000..d7f1999 --- /dev/null +++ b/Documentation/Pf2eModel/BackgroundBoost.Background.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.BackgroundRelation](Pf2eModel.Model.Structure.BackgroundRelation.md 'Pf2eModel\.Model\.Structure\.BackgroundRelation').[BackgroundBoost](BackgroundBoost.md 'Pf2eModel\.Model\.Structure\.BackgroundRelation\.BackgroundBoost') + +## BackgroundBoost\.Background Property + +Предыстория, к которой относится этот элемент набора атрибутов\. + +```csharp +public Pf2eModel.Model.Structure.Background Background { get; set; } +``` + +#### Property Value +[Background](Background.md 'Pf2eModel\.Model\.Structure\.Background') \ No newline at end of file diff --git a/Documentation/Pf2eModel/BackgroundBoost.BackgroundId.md b/Documentation/Pf2eModel/BackgroundBoost.BackgroundId.md new file mode 100644 index 0000000..39898f2 --- /dev/null +++ b/Documentation/Pf2eModel/BackgroundBoost.BackgroundId.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.BackgroundRelation](Pf2eModel.Model.Structure.BackgroundRelation.md 'Pf2eModel\.Model\.Structure\.BackgroundRelation').[BackgroundBoost](BackgroundBoost.md 'Pf2eModel\.Model\.Structure\.BackgroundRelation\.BackgroundBoost') + +## BackgroundBoost\.BackgroundId Property + +Идентификатор предыстории, к которой относится этот элемент набора атрибутов\. + +```csharp +public int BackgroundId { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/BackgroundBoost.Id.md b/Documentation/Pf2eModel/BackgroundBoost.Id.md new file mode 100644 index 0000000..7e55421 --- /dev/null +++ b/Documentation/Pf2eModel/BackgroundBoost.Id.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.BackgroundRelation](Pf2eModel.Model.Structure.BackgroundRelation.md 'Pf2eModel\.Model\.Structure\.BackgroundRelation').[BackgroundBoost](BackgroundBoost.md 'Pf2eModel\.Model\.Structure\.BackgroundRelation\.BackgroundBoost') + +## BackgroundBoost\.Id Property + +Идентификатор элемента набора атрибутов для предыстории\. + +```csharp +public int Id { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/BackgroundBoost.md b/Documentation/Pf2eModel/BackgroundBoost.md new file mode 100644 index 0000000..9c5ba24 --- /dev/null +++ b/Documentation/Pf2eModel/BackgroundBoost.md @@ -0,0 +1,19 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.BackgroundRelation](Pf2eModel.Model.Structure.BackgroundRelation.md 'Pf2eModel\.Model\.Structure\.BackgroundRelation') + +## BackgroundBoost Class + +Элемент набора атрибутов для предыстории\. + +```csharp +public class BackgroundBoost +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 BackgroundBoost + +| Properties | | +| :--- | :--- | +| [Attribute](BackgroundBoost.Attribute.md 'Pf2eModel\.Model\.Structure\.BackgroundRelation\.BackgroundBoost\.Attribute') | Атрибут, к которому относится этот элемент набора атрибутов для предыстории\. | +| [Background](BackgroundBoost.Background.md 'Pf2eModel\.Model\.Structure\.BackgroundRelation\.BackgroundBoost\.Background') | Предыстория, к которой относится этот элемент набора атрибутов\. | +| [BackgroundId](BackgroundBoost.BackgroundId.md 'Pf2eModel\.Model\.Structure\.BackgroundRelation\.BackgroundBoost\.BackgroundId') | Идентификатор предыстории, к которой относится этот элемент набора атрибутов\. | +| [Id](BackgroundBoost.Id.md 'Pf2eModel\.Model\.Structure\.BackgroundRelation\.BackgroundBoost\.Id') | Идентификатор элемента набора атрибутов для предыстории\. | diff --git a/Documentation/Pf2eModel/BackgroundItem.Background.md b/Documentation/Pf2eModel/BackgroundItem.Background.md new file mode 100644 index 0000000..a2aa9f0 --- /dev/null +++ b/Documentation/Pf2eModel/BackgroundItem.Background.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.BackgroundRelation](Pf2eModel.Model.Structure.BackgroundRelation.md 'Pf2eModel\.Model\.Structure\.BackgroundRelation').[BackgroundItem](BackgroundItem.md 'Pf2eModel\.Model\.Structure\.BackgroundRelation\.BackgroundItem') + +## BackgroundItem\.Background Property + +Предыстория, к которой относится сущность\. + +```csharp +public Pf2eModel.Model.Structure.Background Background { get; set; } +``` + +#### Property Value +[Background](Background.md 'Pf2eModel\.Model\.Structure\.Background') \ No newline at end of file diff --git a/Documentation/Pf2eModel/BackgroundItem.BackgroundId.md b/Documentation/Pf2eModel/BackgroundItem.BackgroundId.md new file mode 100644 index 0000000..12d78cb --- /dev/null +++ b/Documentation/Pf2eModel/BackgroundItem.BackgroundId.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.BackgroundRelation](Pf2eModel.Model.Structure.BackgroundRelation.md 'Pf2eModel\.Model\.Structure\.BackgroundRelation').[BackgroundItem](BackgroundItem.md 'Pf2eModel\.Model\.Structure\.BackgroundRelation\.BackgroundItem') + +## BackgroundItem\.BackgroundId Property + +Идентификатор элемента предыстории\. + +```csharp +public int BackgroundId { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/BackgroundItem.Entity.md b/Documentation/Pf2eModel/BackgroundItem.Entity.md new file mode 100644 index 0000000..d81796c --- /dev/null +++ b/Documentation/Pf2eModel/BackgroundItem.Entity.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.BackgroundRelation](Pf2eModel.Model.Structure.BackgroundRelation.md 'Pf2eModel\.Model\.Structure\.BackgroundRelation').[BackgroundItem](BackgroundItem.md 'Pf2eModel\.Model\.Structure\.BackgroundRelation\.BackgroundItem') + +## BackgroundItem\.Entity Property + +Сущность, связанная с предысторией\. + +```csharp +public Pf2eModel.Model.Base.Entity Entity { get; set; } +``` + +#### Property Value +[Entity](Entity.md 'Pf2eModel\.Model\.Base\.Entity') \ No newline at end of file diff --git a/Documentation/Pf2eModel/BackgroundItem.EntityId.md b/Documentation/Pf2eModel/BackgroundItem.EntityId.md new file mode 100644 index 0000000..cb432ec --- /dev/null +++ b/Documentation/Pf2eModel/BackgroundItem.EntityId.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.BackgroundRelation](Pf2eModel.Model.Structure.BackgroundRelation.md 'Pf2eModel\.Model\.Structure\.BackgroundRelation').[BackgroundItem](BackgroundItem.md 'Pf2eModel\.Model\.Structure\.BackgroundRelation\.BackgroundItem') + +## BackgroundItem\.EntityId Property + +Идентификатор сущности, связанной с предысторией\. + +```csharp +public int EntityId { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/BackgroundItem.Level.md b/Documentation/Pf2eModel/BackgroundItem.Level.md new file mode 100644 index 0000000..9f89c16 --- /dev/null +++ b/Documentation/Pf2eModel/BackgroundItem.Level.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.BackgroundRelation](Pf2eModel.Model.Structure.BackgroundRelation.md 'Pf2eModel\.Model\.Structure\.BackgroundRelation').[BackgroundItem](BackgroundItem.md 'Pf2eModel\.Model\.Structure\.BackgroundRelation\.BackgroundItem') + +## BackgroundItem\.Level Property + +Уровень элемента предыстории, если применимо\. Может быть null, если уровень не указан или не применим\. + +```csharp +public System.Nullable Level { get; set; } +``` + +#### Property Value +[System\.Nullable<](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System\.Nullable\`1')[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System\.Nullable\`1') \ No newline at end of file diff --git a/Documentation/Pf2eModel/BackgroundItem.md b/Documentation/Pf2eModel/BackgroundItem.md new file mode 100644 index 0000000..1bbb7a5 --- /dev/null +++ b/Documentation/Pf2eModel/BackgroundItem.md @@ -0,0 +1,20 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.BackgroundRelation](Pf2eModel.Model.Structure.BackgroundRelation.md 'Pf2eModel\.Model\.Structure\.BackgroundRelation') + +## BackgroundItem Class + +Элемент предыстории, который может быть способностью, навыком или другим элементом, связанным с предысторией\. + +```csharp +public class BackgroundItem +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 BackgroundItem + +| Properties | | +| :--- | :--- | +| [Background](BackgroundItem.Background.md 'Pf2eModel\.Model\.Structure\.BackgroundRelation\.BackgroundItem\.Background') | Предыстория, к которой относится сущность\. | +| [BackgroundId](BackgroundItem.BackgroundId.md 'Pf2eModel\.Model\.Structure\.BackgroundRelation\.BackgroundItem\.BackgroundId') | Идентификатор элемента предыстории\. | +| [Entity](BackgroundItem.Entity.md 'Pf2eModel\.Model\.Structure\.BackgroundRelation\.BackgroundItem\.Entity') | Сущность, связанная с предысторией\. | +| [EntityId](BackgroundItem.EntityId.md 'Pf2eModel\.Model\.Structure\.BackgroundRelation\.BackgroundItem\.EntityId') | Идентификатор сущности, связанной с предысторией\. | +| [Level](BackgroundItem.Level.md 'Pf2eModel\.Model\.Structure\.BackgroundRelation\.BackgroundItem\.Level') | Уровень элемента предыстории, если применимо\. Может быть null, если уровень не указан или не применим\. | diff --git a/Documentation/Pf2eModel/BackgroundTraining.Background.md b/Documentation/Pf2eModel/BackgroundTraining.Background.md new file mode 100644 index 0000000..dc2263f --- /dev/null +++ b/Documentation/Pf2eModel/BackgroundTraining.Background.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.BackgroundRelation](Pf2eModel.Model.Structure.BackgroundRelation.md 'Pf2eModel\.Model\.Structure\.BackgroundRelation').[BackgroundTraining](BackgroundTraining.md 'Pf2eModel\.Model\.Structure\.BackgroundRelation\.BackgroundTraining') + +## BackgroundTraining\.Background Property + +Предыстория, к которой относится тренировка\. + +```csharp +public Pf2eModel.Model.Structure.Background Background { get; set; } +``` + +#### Property Value +[Background](Background.md 'Pf2eModel\.Model\.Structure\.Background') \ No newline at end of file diff --git a/Documentation/Pf2eModel/BackgroundTraining.BackgroundId.md b/Documentation/Pf2eModel/BackgroundTraining.BackgroundId.md new file mode 100644 index 0000000..af62d66 --- /dev/null +++ b/Documentation/Pf2eModel/BackgroundTraining.BackgroundId.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.BackgroundRelation](Pf2eModel.Model.Structure.BackgroundRelation.md 'Pf2eModel\.Model\.Structure\.BackgroundRelation').[BackgroundTraining](BackgroundTraining.md 'Pf2eModel\.Model\.Structure\.BackgroundRelation\.BackgroundTraining') + +## BackgroundTraining\.BackgroundId Property + +Идентификатор предыстории, к которой относится тренировка\. + +```csharp +public int BackgroundId { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/BackgroundTraining.Id.md b/Documentation/Pf2eModel/BackgroundTraining.Id.md new file mode 100644 index 0000000..a36b089 --- /dev/null +++ b/Documentation/Pf2eModel/BackgroundTraining.Id.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.BackgroundRelation](Pf2eModel.Model.Structure.BackgroundRelation.md 'Pf2eModel\.Model\.Structure\.BackgroundRelation').[BackgroundTraining](BackgroundTraining.md 'Pf2eModel\.Model\.Structure\.BackgroundRelation\.BackgroundTraining') + +## BackgroundTraining\.Id Property + +Идентификатор элемента набора связей между предысторией и тренируемым навыком\. + +```csharp +public int Id { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/BackgroundTraining.Rank.md b/Documentation/Pf2eModel/BackgroundTraining.Rank.md new file mode 100644 index 0000000..97f2d10 --- /dev/null +++ b/Documentation/Pf2eModel/BackgroundTraining.Rank.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.BackgroundRelation](Pf2eModel.Model.Structure.BackgroundRelation.md 'Pf2eModel\.Model\.Structure\.BackgroundRelation').[BackgroundTraining](BackgroundTraining.md 'Pf2eModel\.Model\.Structure\.BackgroundRelation\.BackgroundTraining') + +## BackgroundTraining\.Rank Property + +Ранг тренировки, который получает персонаж при выборе данной предыстории\. + +```csharp +public Pf2eModel.Model.Enum.TrainingRank Rank { get; set; } +``` + +#### Property Value +[TrainingRank](TrainingRank.md 'Pf2eModel\.Model\.Enum\.TrainingRank') \ No newline at end of file diff --git a/Documentation/Pf2eModel/BackgroundTraining.Training.md b/Documentation/Pf2eModel/BackgroundTraining.Training.md new file mode 100644 index 0000000..be2b285 --- /dev/null +++ b/Documentation/Pf2eModel/BackgroundTraining.Training.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.BackgroundRelation](Pf2eModel.Model.Structure.BackgroundRelation.md 'Pf2eModel\.Model\.Structure\.BackgroundRelation').[BackgroundTraining](BackgroundTraining.md 'Pf2eModel\.Model\.Structure\.BackgroundRelation\.BackgroundTraining') + +## BackgroundTraining\.Training Property + +Тренируемый навык, который получает персонаж при выборе данной предыстории\. + +```csharp +public Pf2eModel.Model.Common.Training Training { get; set; } +``` + +#### Property Value +[Training](Training.md 'Pf2eModel\.Model\.Common\.Training') \ No newline at end of file diff --git a/Documentation/Pf2eModel/BackgroundTraining.TrainingId.md b/Documentation/Pf2eModel/BackgroundTraining.TrainingId.md new file mode 100644 index 0000000..0a4f40d --- /dev/null +++ b/Documentation/Pf2eModel/BackgroundTraining.TrainingId.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.BackgroundRelation](Pf2eModel.Model.Structure.BackgroundRelation.md 'Pf2eModel\.Model\.Structure\.BackgroundRelation').[BackgroundTraining](BackgroundTraining.md 'Pf2eModel\.Model\.Structure\.BackgroundRelation\.BackgroundTraining') + +## BackgroundTraining\.TrainingId Property + +Идентификатор тренируемого навыка\. + +```csharp +public int TrainingId { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/BackgroundTraining.md b/Documentation/Pf2eModel/BackgroundTraining.md new file mode 100644 index 0000000..f20102b --- /dev/null +++ b/Documentation/Pf2eModel/BackgroundTraining.md @@ -0,0 +1,21 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.BackgroundRelation](Pf2eModel.Model.Structure.BackgroundRelation.md 'Pf2eModel\.Model\.Structure\.BackgroundRelation') + +## BackgroundTraining Class + +Элемент набора связей между предысторией и тренируемым навыком\. + +```csharp +public class BackgroundTraining +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 BackgroundTraining + +| Properties | | +| :--- | :--- | +| [Background](BackgroundTraining.Background.md 'Pf2eModel\.Model\.Structure\.BackgroundRelation\.BackgroundTraining\.Background') | Предыстория, к которой относится тренировка\. | +| [BackgroundId](BackgroundTraining.BackgroundId.md 'Pf2eModel\.Model\.Structure\.BackgroundRelation\.BackgroundTraining\.BackgroundId') | Идентификатор предыстории, к которой относится тренировка\. | +| [Id](BackgroundTraining.Id.md 'Pf2eModel\.Model\.Structure\.BackgroundRelation\.BackgroundTraining\.Id') | Идентификатор элемента набора связей между предысторией и тренируемым навыком\. | +| [Rank](BackgroundTraining.Rank.md 'Pf2eModel\.Model\.Structure\.BackgroundRelation\.BackgroundTraining\.Rank') | Ранг тренировки, который получает персонаж при выборе данной предыстории\. | +| [Training](BackgroundTraining.Training.md 'Pf2eModel\.Model\.Structure\.BackgroundRelation\.BackgroundTraining\.Training') | Тренируемый навык, который получает персонаж при выборе данной предыстории\. | +| [TrainingId](BackgroundTraining.TrainingId.md 'Pf2eModel\.Model\.Structure\.BackgroundRelation\.BackgroundTraining\.TrainingId') | Идентификатор тренируемого навыка\. | diff --git a/Documentation/Pf2eModel/Class.AdditionalTrainedSkills.md b/Documentation/Pf2eModel/Class.AdditionalTrainedSkills.md new file mode 100644 index 0000000..077419c --- /dev/null +++ b/Documentation/Pf2eModel/Class.AdditionalTrainedSkills.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Class](Class.md 'Pf2eModel\.Model\.Structure\.Class') + +## Class\.AdditionalTrainedSkills Property + +Количество дополнительных навыков\. + +```csharp +public int AdditionalTrainedSkills { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Class.ClassKeyAbilities.md b/Documentation/Pf2eModel/Class.ClassKeyAbilities.md new file mode 100644 index 0000000..eced88c --- /dev/null +++ b/Documentation/Pf2eModel/Class.ClassKeyAbilities.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Class](Class.md 'Pf2eModel\.Model\.Structure\.Class') + +## Class\.ClassKeyAbilities Property + +Аттрибуты класса\. + +```csharp +public virtual System.Collections.Generic.ICollection ClassKeyAbilities { get; set; } +``` + +#### Property Value +[System\.Collections\.Generic\.ICollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1')[ClassKeyAttribute](ClassKeyAttribute.md 'Pf2eModel\.Model\.Structure\.ClassRelation\.ClassKeyAttribute')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Class.ClassProgressions.md b/Documentation/Pf2eModel/Class.ClassProgressions.md new file mode 100644 index 0000000..01c762d --- /dev/null +++ b/Documentation/Pf2eModel/Class.ClassProgressions.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Class](Class.md 'Pf2eModel\.Model\.Structure\.Class') + +## Class\.ClassProgressions Property + +Прогрессия класса\. + +```csharp +public virtual System.Collections.Generic.ICollection ClassProgressions { get; set; } +``` + +#### Property Value +[System\.Collections\.Generic\.ICollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1')[ClassProgression](ClassProgression.md 'Pf2eModel\.Model\.Structure\.ClassRelation\.ClassProgression')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Class.ClassTrainings.md b/Documentation/Pf2eModel/Class.ClassTrainings.md new file mode 100644 index 0000000..18e319d --- /dev/null +++ b/Documentation/Pf2eModel/Class.ClassTrainings.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Class](Class.md 'Pf2eModel\.Model\.Structure\.Class') + +## Class\.ClassTrainings Property + +Навыки класса\. + +```csharp +public virtual System.Collections.Generic.ICollection ClassTrainings { get; set; } +``` + +#### Property Value +[System\.Collections\.Generic\.ICollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1')[ClassTraining](ClassTraining.md 'Pf2eModel\.Model\.Structure\.ClassRelation\.ClassTraining')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Class.Entity.md b/Documentation/Pf2eModel/Class.Entity.md new file mode 100644 index 0000000..6d80ccd --- /dev/null +++ b/Documentation/Pf2eModel/Class.Entity.md @@ -0,0 +1,15 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Class](Class.md 'Pf2eModel\.Model\.Structure\.Class') + +## Class\.Entity Property + +Корневая сущность\. + +```csharp +public Pf2eModel.Model.Base.Entity Entity { get; set; } +``` + +Implements [Entity](IEntity.Entity.md 'Pf2eModel\.Model\.IEntity\.Entity') + +#### Property Value +[Entity](Entity.md 'Pf2eModel\.Model\.Base\.Entity') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Class.Hp.md b/Documentation/Pf2eModel/Class.Hp.md new file mode 100644 index 0000000..c14e769 --- /dev/null +++ b/Documentation/Pf2eModel/Class.Hp.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Class](Class.md 'Pf2eModel\.Model\.Structure\.Class') + +## Class\.Hp Property + +Количество очков здоровья\. + +```csharp +public int Hp { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Class.Id.md b/Documentation/Pf2eModel/Class.Id.md new file mode 100644 index 0000000..1edd9da --- /dev/null +++ b/Documentation/Pf2eModel/Class.Id.md @@ -0,0 +1,15 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Class](Class.md 'Pf2eModel\.Model\.Structure\.Class') + +## Class\.Id Property + +Идентификатор сущности\. + +```csharp +public int Id { get; set; } +``` + +Implements [Id](IEntity.Id.md 'Pf2eModel\.Model\.IEntity\.Id') + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Class.Spellcasting.md b/Documentation/Pf2eModel/Class.Spellcasting.md new file mode 100644 index 0000000..50af749 --- /dev/null +++ b/Documentation/Pf2eModel/Class.Spellcasting.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Class](Class.md 'Pf2eModel\.Model\.Structure\.Class') + +## Class\.Spellcasting Property + +Флаг, указывающий на то, что класс является заклинательным\. + +```csharp +public bool Spellcasting { get; set; } +``` + +#### Property Value +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Class.SubclassGroups.md b/Documentation/Pf2eModel/Class.SubclassGroups.md new file mode 100644 index 0000000..6590bc3 --- /dev/null +++ b/Documentation/Pf2eModel/Class.SubclassGroups.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Class](Class.md 'Pf2eModel\.Model\.Structure\.Class') + +## Class\.SubclassGroups Property + +Группы подклассов\. + +```csharp +public virtual System.Collections.Generic.ICollection SubclassGroups { get; set; } +``` + +#### Property Value +[System\.Collections\.Generic\.ICollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1')[SubclassGroup](SubclassGroup.md 'Pf2eModel\.Model\.Structure\.SubclassGroup')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Class.Tradition.md b/Documentation/Pf2eModel/Class.Tradition.md new file mode 100644 index 0000000..11e9f89 --- /dev/null +++ b/Documentation/Pf2eModel/Class.Tradition.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Class](Class.md 'Pf2eModel\.Model\.Structure\.Class') + +## Class\.Tradition Property + +Традиция заклинаний класса\. + +```csharp +public System.Nullable Tradition { get; set; } +``` + +#### Property Value +[System\.Nullable<](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System\.Nullable\`1')[SpellTradition](SpellTradition.md 'Pf2eModel\.Model\.Enum\.SpellTradition')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System\.Nullable\`1') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Class.md b/Documentation/Pf2eModel/Class.md new file mode 100644 index 0000000..e3c7114 --- /dev/null +++ b/Documentation/Pf2eModel/Class.md @@ -0,0 +1,27 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure') + +## Class Class + +Класс\. + +```csharp +public class Class : Pf2eModel.Model.IEntity +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 Class + +Implements [IEntity](IEntity.md 'Pf2eModel\.Model\.IEntity') + +| Properties | | +| :--- | :--- | +| [AdditionalTrainedSkills](Class.AdditionalTrainedSkills.md 'Pf2eModel\.Model\.Structure\.Class\.AdditionalTrainedSkills') | Количество дополнительных навыков\. | +| [ClassKeyAbilities](Class.ClassKeyAbilities.md 'Pf2eModel\.Model\.Structure\.Class\.ClassKeyAbilities') | Аттрибуты класса\. | +| [ClassProgressions](Class.ClassProgressions.md 'Pf2eModel\.Model\.Structure\.Class\.ClassProgressions') | Прогрессия класса\. | +| [ClassTrainings](Class.ClassTrainings.md 'Pf2eModel\.Model\.Structure\.Class\.ClassTrainings') | Навыки класса\. | +| [Entity](Class.Entity.md 'Pf2eModel\.Model\.Structure\.Class\.Entity') | Корневая сущность\. | +| [Hp](Class.Hp.md 'Pf2eModel\.Model\.Structure\.Class\.Hp') | Количество очков здоровья\. | +| [Id](Class.Id.md 'Pf2eModel\.Model\.Structure\.Class\.Id') | Идентификатор сущности\. | +| [Spellcasting](Class.Spellcasting.md 'Pf2eModel\.Model\.Structure\.Class\.Spellcasting') | Флаг, указывающий на то, что класс является заклинательным\. | +| [SubclassGroups](Class.SubclassGroups.md 'Pf2eModel\.Model\.Structure\.Class\.SubclassGroups') | Группы подклассов\. | +| [Tradition](Class.Tradition.md 'Pf2eModel\.Model\.Structure\.Class\.Tradition') | Традиция заклинаний класса\. | diff --git a/Documentation/Pf2eModel/ClassKeyAttribute.Class.md b/Documentation/Pf2eModel/ClassKeyAttribute.Class.md new file mode 100644 index 0000000..35da912 --- /dev/null +++ b/Documentation/Pf2eModel/ClassKeyAttribute.Class.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.ClassRelation](Pf2eModel.Model.Structure.ClassRelation.md 'Pf2eModel\.Model\.Structure\.ClassRelation').[ClassKeyAttribute](ClassKeyAttribute.md 'Pf2eModel\.Model\.Structure\.ClassRelation\.ClassKeyAttribute') + +## ClassKeyAttribute\.Class Property + +Класс, к которому относится ключевой атрибут\. + +```csharp +public Pf2eModel.Model.Structure.Class Class { get; set; } +``` + +#### Property Value +[Class](Class.md 'Pf2eModel\.Model\.Structure\.Class') \ No newline at end of file diff --git a/Documentation/Pf2eModel/ClassKeyAttribute.ClassId.md b/Documentation/Pf2eModel/ClassKeyAttribute.ClassId.md new file mode 100644 index 0000000..9429999 --- /dev/null +++ b/Documentation/Pf2eModel/ClassKeyAttribute.ClassId.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.ClassRelation](Pf2eModel.Model.Structure.ClassRelation.md 'Pf2eModel\.Model\.Structure\.ClassRelation').[ClassKeyAttribute](ClassKeyAttribute.md 'Pf2eModel\.Model\.Structure\.ClassRelation\.ClassKeyAttribute') + +## ClassKeyAttribute\.ClassId Property + +Идентификатор класса, к которому относится ключевой атрибут\. + +```csharp +public int ClassId { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/ClassKeyAttribute.Id.md b/Documentation/Pf2eModel/ClassKeyAttribute.Id.md new file mode 100644 index 0000000..0e80c62 --- /dev/null +++ b/Documentation/Pf2eModel/ClassKeyAttribute.Id.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.ClassRelation](Pf2eModel.Model.Structure.ClassRelation.md 'Pf2eModel\.Model\.Structure\.ClassRelation').[ClassKeyAttribute](ClassKeyAttribute.md 'Pf2eModel\.Model\.Structure\.ClassRelation\.ClassKeyAttribute') + +## ClassKeyAttribute\.Id Property + +Идентификатор ключевого атрибута класса\. + +```csharp +public int Id { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/ClassKeyAttribute.Value.md b/Documentation/Pf2eModel/ClassKeyAttribute.Value.md new file mode 100644 index 0000000..e67e65f --- /dev/null +++ b/Documentation/Pf2eModel/ClassKeyAttribute.Value.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.ClassRelation](Pf2eModel.Model.Structure.ClassRelation.md 'Pf2eModel\.Model\.Structure\.ClassRelation').[ClassKeyAttribute](ClassKeyAttribute.md 'Pf2eModel\.Model\.Structure\.ClassRelation\.ClassKeyAttribute') + +## ClassKeyAttribute\.Value Property + +Ключевой атрибут класса\. + +```csharp +public Pf2eModel.Model.Enum.AttributeValues Value { get; set; } +``` + +#### Property Value +[AttributeValues](AttributeValues.md 'Pf2eModel\.Model\.Enum\.AttributeValues') \ No newline at end of file diff --git a/Documentation/Pf2eModel/ClassKeyAttribute.md b/Documentation/Pf2eModel/ClassKeyAttribute.md new file mode 100644 index 0000000..e010e64 --- /dev/null +++ b/Documentation/Pf2eModel/ClassKeyAttribute.md @@ -0,0 +1,19 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.ClassRelation](Pf2eModel.Model.Structure.ClassRelation.md 'Pf2eModel\.Model\.Structure\.ClassRelation') + +## ClassKeyAttribute Class + +Набор ключевых атрибутов класса\. + +```csharp +public class ClassKeyAttribute +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 ClassKeyAttribute + +| Properties | | +| :--- | :--- | +| [Class](ClassKeyAttribute.Class.md 'Pf2eModel\.Model\.Structure\.ClassRelation\.ClassKeyAttribute\.Class') | Класс, к которому относится ключевой атрибут\. | +| [ClassId](ClassKeyAttribute.ClassId.md 'Pf2eModel\.Model\.Structure\.ClassRelation\.ClassKeyAttribute\.ClassId') | Идентификатор класса, к которому относится ключевой атрибут\. | +| [Id](ClassKeyAttribute.Id.md 'Pf2eModel\.Model\.Structure\.ClassRelation\.ClassKeyAttribute\.Id') | Идентификатор ключевого атрибута класса\. | +| [Value](ClassKeyAttribute.Value.md 'Pf2eModel\.Model\.Structure\.ClassRelation\.ClassKeyAttribute\.Value') | Ключевой атрибут класса\. | diff --git a/Documentation/Pf2eModel/ClassProgression.Class.md b/Documentation/Pf2eModel/ClassProgression.Class.md new file mode 100644 index 0000000..0494ac2 --- /dev/null +++ b/Documentation/Pf2eModel/ClassProgression.Class.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.ClassRelation](Pf2eModel.Model.Structure.ClassRelation.md 'Pf2eModel\.Model\.Structure\.ClassRelation').[ClassProgression](ClassProgression.md 'Pf2eModel\.Model\.Structure\.ClassRelation\.ClassProgression') + +## ClassProgression\.Class Property + +Класс, к которому относится элемент прогрессии\. + +```csharp +public Pf2eModel.Model.Structure.Class Class { get; set; } +``` + +#### Property Value +[Class](Class.md 'Pf2eModel\.Model\.Structure\.Class') \ No newline at end of file diff --git a/Documentation/Pf2eModel/ClassProgression.ClassId.md b/Documentation/Pf2eModel/ClassProgression.ClassId.md new file mode 100644 index 0000000..5ae1dc3 --- /dev/null +++ b/Documentation/Pf2eModel/ClassProgression.ClassId.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.ClassRelation](Pf2eModel.Model.Structure.ClassRelation.md 'Pf2eModel\.Model\.Structure\.ClassRelation').[ClassProgression](ClassProgression.md 'Pf2eModel\.Model\.Structure\.ClassRelation\.ClassProgression') + +## ClassProgression\.ClassId Property + +Идентификатор класса, к которому относится элемент прогрессии\. + +```csharp +public int ClassId { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/ClassProgression.Entity.md b/Documentation/Pf2eModel/ClassProgression.Entity.md new file mode 100644 index 0000000..4441f01 --- /dev/null +++ b/Documentation/Pf2eModel/ClassProgression.Entity.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.ClassRelation](Pf2eModel.Model.Structure.ClassRelation.md 'Pf2eModel\.Model\.Structure\.ClassRelation').[ClassProgression](ClassProgression.md 'Pf2eModel\.Model\.Structure\.ClassRelation\.ClassProgression') + +## ClassProgression\.Entity Property + +Сущность, связанная с элементом прогрессии класса \(например, навык, атрибут и т\.д\.\)\. + +```csharp +public Pf2eModel.Model.Base.Entity? Entity { get; set; } +``` + +#### Property Value +[Entity](Entity.md 'Pf2eModel\.Model\.Base\.Entity') \ No newline at end of file diff --git a/Documentation/Pf2eModel/ClassProgression.EntityId.md b/Documentation/Pf2eModel/ClassProgression.EntityId.md new file mode 100644 index 0000000..f848ed4 --- /dev/null +++ b/Documentation/Pf2eModel/ClassProgression.EntityId.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.ClassRelation](Pf2eModel.Model.Structure.ClassRelation.md 'Pf2eModel\.Model\.Structure\.ClassRelation').[ClassProgression](ClassProgression.md 'Pf2eModel\.Model\.Structure\.ClassRelation\.ClassProgression') + +## ClassProgression\.EntityId Property + +Идентификатор сущности, связанной с элементом прогрессии класса \(например, навык, атрибут и т\.д\.\)\. + +```csharp +public System.Nullable EntityId { get; set; } +``` + +#### Property Value +[System\.Nullable<](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System\.Nullable\`1')[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System\.Nullable\`1') \ No newline at end of file diff --git a/Documentation/Pf2eModel/ClassProgression.Id.md b/Documentation/Pf2eModel/ClassProgression.Id.md new file mode 100644 index 0000000..2a482bb --- /dev/null +++ b/Documentation/Pf2eModel/ClassProgression.Id.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.ClassRelation](Pf2eModel.Model.Structure.ClassRelation.md 'Pf2eModel\.Model\.Structure\.ClassRelation').[ClassProgression](ClassProgression.md 'Pf2eModel\.Model\.Structure\.ClassRelation\.ClassProgression') + +## ClassProgression\.Id Property + +Идентификатор прогрессии класса\. + +```csharp +public int Id { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/ClassProgression.Level.md b/Documentation/Pf2eModel/ClassProgression.Level.md new file mode 100644 index 0000000..a87a26b --- /dev/null +++ b/Documentation/Pf2eModel/ClassProgression.Level.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.ClassRelation](Pf2eModel.Model.Structure.ClassRelation.md 'Pf2eModel\.Model\.Structure\.ClassRelation').[ClassProgression](ClassProgression.md 'Pf2eModel\.Model\.Structure\.ClassRelation\.ClassProgression') + +## ClassProgression\.Level Property + +Уровень класса, на котором элемент прогрессии доступен\. + +```csharp +public int Level { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/ClassProgression.Type.md b/Documentation/Pf2eModel/ClassProgression.Type.md new file mode 100644 index 0000000..2c9dab9 --- /dev/null +++ b/Documentation/Pf2eModel/ClassProgression.Type.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.ClassRelation](Pf2eModel.Model.Structure.ClassRelation.md 'Pf2eModel\.Model\.Structure\.ClassRelation').[ClassProgression](ClassProgression.md 'Pf2eModel\.Model\.Structure\.ClassRelation\.ClassProgression') + +## ClassProgression\.Type Property + +Тип элемента прогрессии класса\. + +```csharp +public Pf2eModel.Model.Enum.ClassProgressionType Type { get; set; } +``` + +#### Property Value +[ClassProgressionType](ClassProgressionType.md 'Pf2eModel\.Model\.Enum\.ClassProgressionType') \ No newline at end of file diff --git a/Documentation/Pf2eModel/ClassProgression.md b/Documentation/Pf2eModel/ClassProgression.md new file mode 100644 index 0000000..23cc772 --- /dev/null +++ b/Documentation/Pf2eModel/ClassProgression.md @@ -0,0 +1,22 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.ClassRelation](Pf2eModel.Model.Structure.ClassRelation.md 'Pf2eModel\.Model\.Structure\.ClassRelation') + +## ClassProgression Class + +Элемент прогрессии класса\. + +```csharp +public class ClassProgression +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 ClassProgression + +| Properties | | +| :--- | :--- | +| [Class](ClassProgression.Class.md 'Pf2eModel\.Model\.Structure\.ClassRelation\.ClassProgression\.Class') | Класс, к которому относится элемент прогрессии\. | +| [ClassId](ClassProgression.ClassId.md 'Pf2eModel\.Model\.Structure\.ClassRelation\.ClassProgression\.ClassId') | Идентификатор класса, к которому относится элемент прогрессии\. | +| [Entity](ClassProgression.Entity.md 'Pf2eModel\.Model\.Structure\.ClassRelation\.ClassProgression\.Entity') | Сущность, связанная с элементом прогрессии класса \(например, навык, атрибут и т\.д\.\)\. | +| [EntityId](ClassProgression.EntityId.md 'Pf2eModel\.Model\.Structure\.ClassRelation\.ClassProgression\.EntityId') | Идентификатор сущности, связанной с элементом прогрессии класса \(например, навык, атрибут и т\.д\.\)\. | +| [Id](ClassProgression.Id.md 'Pf2eModel\.Model\.Structure\.ClassRelation\.ClassProgression\.Id') | Идентификатор прогрессии класса\. | +| [Level](ClassProgression.Level.md 'Pf2eModel\.Model\.Structure\.ClassRelation\.ClassProgression\.Level') | Уровень класса, на котором элемент прогрессии доступен\. | +| [Type](ClassProgression.Type.md 'Pf2eModel\.Model\.Structure\.ClassRelation\.ClassProgression\.Type') | Тип элемента прогрессии класса\. | diff --git a/Documentation/Pf2eModel/ClassProgressionType.md b/Documentation/Pf2eModel/ClassProgressionType.md new file mode 100644 index 0000000..a02dc00 --- /dev/null +++ b/Documentation/Pf2eModel/ClassProgressionType.md @@ -0,0 +1,53 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Enum](Pf2eModel.Model.Enum.md 'Pf2eModel\.Model\.Enum') + +## ClassProgressionType Enum + +Тип элемента прогрессии класса\. + +```csharp +public enum ClassProgressionType +``` +### Fields + + + +`Entity` 0 + +Неизвестный тип прогрессии класса\. + + + +`AncestryFeat` 1 + +Навык архетипа\. + + + +`ClassFeat` 2 + +Классовая особенность\. + + + +`GeneralFeat` 3 + +Общий навык\. + + + +`SkillFeat` 4 + +Навык + + + +`SkillIncrease` 5 + +Увеличение навыка\. + + + +`AttributeIncrease` 6 + +Увеличение атрибута\. \ No newline at end of file diff --git a/Documentation/Pf2eModel/ClassTraining.Class.md b/Documentation/Pf2eModel/ClassTraining.Class.md new file mode 100644 index 0000000..fe1a781 --- /dev/null +++ b/Documentation/Pf2eModel/ClassTraining.Class.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.ClassRelation](Pf2eModel.Model.Structure.ClassRelation.md 'Pf2eModel\.Model\.Structure\.ClassRelation').[ClassTraining](ClassTraining.md 'Pf2eModel\.Model\.Structure\.ClassRelation\.ClassTraining') + +## ClassTraining\.Class Property + +Класс, к которому относится тренировка\. + +```csharp +public Pf2eModel.Model.Structure.Class Class { get; set; } +``` + +#### Property Value +[Class](Class.md 'Pf2eModel\.Model\.Structure\.Class') \ No newline at end of file diff --git a/Documentation/Pf2eModel/ClassTraining.ClassId.md b/Documentation/Pf2eModel/ClassTraining.ClassId.md new file mode 100644 index 0000000..fbc1f6b --- /dev/null +++ b/Documentation/Pf2eModel/ClassTraining.ClassId.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.ClassRelation](Pf2eModel.Model.Structure.ClassRelation.md 'Pf2eModel\.Model\.Structure\.ClassRelation').[ClassTraining](ClassTraining.md 'Pf2eModel\.Model\.Structure\.ClassRelation\.ClassTraining') + +## ClassTraining\.ClassId Property + +Идентификатор класса, к которому относится тренировка\. + +```csharp +public int ClassId { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/ClassTraining.Id.md b/Documentation/Pf2eModel/ClassTraining.Id.md new file mode 100644 index 0000000..99a6b9c --- /dev/null +++ b/Documentation/Pf2eModel/ClassTraining.Id.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.ClassRelation](Pf2eModel.Model.Structure.ClassRelation.md 'Pf2eModel\.Model\.Structure\.ClassRelation').[ClassTraining](ClassTraining.md 'Pf2eModel\.Model\.Structure\.ClassRelation\.ClassTraining') + +## ClassTraining\.Id Property + +Идентификатор набора элементов, связывающий класс и тренируемый навык\. + +```csharp +public int Id { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/ClassTraining.Rank.md b/Documentation/Pf2eModel/ClassTraining.Rank.md new file mode 100644 index 0000000..3feefb4 --- /dev/null +++ b/Documentation/Pf2eModel/ClassTraining.Rank.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.ClassRelation](Pf2eModel.Model.Structure.ClassRelation.md 'Pf2eModel\.Model\.Structure\.ClassRelation').[ClassTraining](ClassTraining.md 'Pf2eModel\.Model\.Structure\.ClassRelation\.ClassTraining') + +## ClassTraining\.Rank Property + +Ранг тренировки, определяющий уровень владения навыком\. + +```csharp +public Pf2eModel.Model.Enum.TrainingRank Rank { get; set; } +``` + +#### Property Value +[TrainingRank](TrainingRank.md 'Pf2eModel\.Model\.Enum\.TrainingRank') \ No newline at end of file diff --git a/Documentation/Pf2eModel/ClassTraining.Training.md b/Documentation/Pf2eModel/ClassTraining.Training.md new file mode 100644 index 0000000..0e7718b --- /dev/null +++ b/Documentation/Pf2eModel/ClassTraining.Training.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.ClassRelation](Pf2eModel.Model.Structure.ClassRelation.md 'Pf2eModel\.Model\.Structure\.ClassRelation').[ClassTraining](ClassTraining.md 'Pf2eModel\.Model\.Structure\.ClassRelation\.ClassTraining') + +## ClassTraining\.Training Property + +Тренируемый навык, к которому относится тренировка\. + +```csharp +public Pf2eModel.Model.Common.Training? Training { get; set; } +``` + +#### Property Value +[Training](Training.md 'Pf2eModel\.Model\.Common\.Training') \ No newline at end of file diff --git a/Documentation/Pf2eModel/ClassTraining.TrainingId.md b/Documentation/Pf2eModel/ClassTraining.TrainingId.md new file mode 100644 index 0000000..7283849 --- /dev/null +++ b/Documentation/Pf2eModel/ClassTraining.TrainingId.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.ClassRelation](Pf2eModel.Model.Structure.ClassRelation.md 'Pf2eModel\.Model\.Structure\.ClassRelation').[ClassTraining](ClassTraining.md 'Pf2eModel\.Model\.Structure\.ClassRelation\.ClassTraining') + +## ClassTraining\.TrainingId Property + +Идентификатор тренируемого навыка, к которому относится тренировка\. + +```csharp +public System.Nullable TrainingId { get; set; } +``` + +#### Property Value +[System\.Nullable<](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System\.Nullable\`1')[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System\.Nullable\`1') \ No newline at end of file diff --git a/Documentation/Pf2eModel/ClassTraining.md b/Documentation/Pf2eModel/ClassTraining.md new file mode 100644 index 0000000..64573df --- /dev/null +++ b/Documentation/Pf2eModel/ClassTraining.md @@ -0,0 +1,21 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.ClassRelation](Pf2eModel.Model.Structure.ClassRelation.md 'Pf2eModel\.Model\.Structure\.ClassRelation') + +## ClassTraining Class + +Набор элементов, связывающий класс и тренируемый навык\. + +```csharp +public class ClassTraining +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 ClassTraining + +| Properties | | +| :--- | :--- | +| [Class](ClassTraining.Class.md 'Pf2eModel\.Model\.Structure\.ClassRelation\.ClassTraining\.Class') | Класс, к которому относится тренировка\. | +| [ClassId](ClassTraining.ClassId.md 'Pf2eModel\.Model\.Structure\.ClassRelation\.ClassTraining\.ClassId') | Идентификатор класса, к которому относится тренировка\. | +| [Id](ClassTraining.Id.md 'Pf2eModel\.Model\.Structure\.ClassRelation\.ClassTraining\.Id') | Идентификатор набора элементов, связывающий класс и тренируемый навык\. | +| [Rank](ClassTraining.Rank.md 'Pf2eModel\.Model\.Structure\.ClassRelation\.ClassTraining\.Rank') | Ранг тренировки, определяющий уровень владения навыком\. | +| [Training](ClassTraining.Training.md 'Pf2eModel\.Model\.Structure\.ClassRelation\.ClassTraining\.Training') | Тренируемый навык, к которому относится тренировка\. | +| [TrainingId](ClassTraining.TrainingId.md 'Pf2eModel\.Model\.Structure\.ClassRelation\.ClassTraining\.TrainingId') | Идентификатор тренируемого навыка, к которому относится тренировка\. | diff --git a/Documentation/Pf2eModel/Condition.Entity.md b/Documentation/Pf2eModel/Condition.Entity.md new file mode 100644 index 0000000..fb31a97 --- /dev/null +++ b/Documentation/Pf2eModel/Condition.Entity.md @@ -0,0 +1,15 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Condition](Condition.md 'Pf2eModel\.Model\.Structure\.Condition') + +## Condition\.Entity Property + +Корневая сущность\. + +```csharp +public Pf2eModel.Model.Base.Entity Entity { get; set; } +``` + +Implements [Entity](IEntity.Entity.md 'Pf2eModel\.Model\.IEntity\.Entity') + +#### Property Value +[Entity](Entity.md 'Pf2eModel\.Model\.Base\.Entity') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Condition.Extra.md b/Documentation/Pf2eModel/Condition.Extra.md new file mode 100644 index 0000000..8cac110 --- /dev/null +++ b/Documentation/Pf2eModel/Condition.Extra.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Condition](Condition.md 'Pf2eModel\.Model\.Structure\.Condition') + +## Condition\.Extra Property + +Дополнительная информация\. + +```csharp +public string? Extra { get; set; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Condition.Group.md b/Documentation/Pf2eModel/Condition.Group.md new file mode 100644 index 0000000..23c8487 --- /dev/null +++ b/Documentation/Pf2eModel/Condition.Group.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Condition](Condition.md 'Pf2eModel\.Model\.Structure\.Condition') + +## Condition\.Group Property + +Группа состояния\. + +```csharp +public System.Nullable Group { get; set; } +``` + +#### Property Value +[System\.Nullable<](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System\.Nullable\`1')[ConditionGroup](ConditionGroup.md 'Pf2eModel\.Model\.Enum\.ConditionGroup')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System\.Nullable\`1') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Condition.Id.md b/Documentation/Pf2eModel/Condition.Id.md new file mode 100644 index 0000000..ff34817 --- /dev/null +++ b/Documentation/Pf2eModel/Condition.Id.md @@ -0,0 +1,15 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Condition](Condition.md 'Pf2eModel\.Model\.Structure\.Condition') + +## Condition\.Id Property + +Идентификатор сущности\. + +```csharp +public int Id { get; set; } +``` + +Implements [Id](IEntity.Id.md 'Pf2eModel\.Model\.IEntity\.Id') + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Condition.md b/Documentation/Pf2eModel/Condition.md new file mode 100644 index 0000000..6a3e95e --- /dev/null +++ b/Documentation/Pf2eModel/Condition.md @@ -0,0 +1,21 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure') + +## Condition Class + +Состояние\. + +```csharp +public class Condition : Pf2eModel.Model.IEntity +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 Condition + +Implements [IEntity](IEntity.md 'Pf2eModel\.Model\.IEntity') + +| Properties | | +| :--- | :--- | +| [Entity](Condition.Entity.md 'Pf2eModel\.Model\.Structure\.Condition\.Entity') | Корневая сущность\. | +| [Extra](Condition.Extra.md 'Pf2eModel\.Model\.Structure\.Condition\.Extra') | Дополнительная информация\. | +| [Group](Condition.Group.md 'Pf2eModel\.Model\.Structure\.Condition\.Group') | Группа состояния\. | +| [Id](Condition.Id.md 'Pf2eModel\.Model\.Structure\.Condition\.Id') | Идентификатор сущности\. | diff --git a/Documentation/Pf2eModel/ConditionGroup.md b/Documentation/Pf2eModel/ConditionGroup.md new file mode 100644 index 0000000..03b6687 --- /dev/null +++ b/Documentation/Pf2eModel/ConditionGroup.md @@ -0,0 +1,47 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Enum](Pf2eModel.Model.Enum.md 'Pf2eModel\.Model\.Enum') + +## ConditionGroup Enum + +Тип состояния + +```csharp +public enum ConditionGroup +``` +### Fields + + + +`Unknown` 0 + +Неизвестое состояние\. + + + +`Senses` 1 + +Чувство\. + + + +`Abilities` 2 + +Способность\. + + + +`Death` 3 + +Смерть\. + + + +`Attitudes` 4 + +Отношение\. \(???\) + + + +`Detection` 5 + +Обнаружение\. \ No newline at end of file diff --git a/Documentation/Pf2eModel/Deity.Category.md b/Documentation/Pf2eModel/Deity.Category.md new file mode 100644 index 0000000..f8a5e1b --- /dev/null +++ b/Documentation/Pf2eModel/Deity.Category.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Deity](Deity.md 'Pf2eModel\.Model\.Structure\.Deity') + +## Deity\.Category Property + +Тип божества\. + +```csharp +public Pf2eModel.Model.Enum.DeityCategory Category { get; set; } +``` + +#### Property Value +[DeityCategory](DeityCategory.md 'Pf2eModel\.Model\.Enum\.DeityCategory') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Deity.DeityAttributes.md b/Documentation/Pf2eModel/Deity.DeityAttributes.md new file mode 100644 index 0000000..0a3a3c8 --- /dev/null +++ b/Documentation/Pf2eModel/Deity.DeityAttributes.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Deity](Deity.md 'Pf2eModel\.Model\.Structure\.Deity') + +## Deity\.DeityAttributes Property + +Аттрибуты божества\. + +```csharp +public System.Collections.Generic.ICollection DeityAttributes { get; set; } +``` + +#### Property Value +[System\.Collections\.Generic\.ICollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1')[DeityAttribute](DeityAttribute.md 'Pf2eModel\.Model\.Structure\.DeityRelation\.DeityAttribute')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Deity.DeityDomains.md b/Documentation/Pf2eModel/Deity.DeityDomains.md new file mode 100644 index 0000000..4ed35e7 --- /dev/null +++ b/Documentation/Pf2eModel/Deity.DeityDomains.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Deity](Deity.md 'Pf2eModel\.Model\.Structure\.Deity') + +## Deity\.DeityDomains Property + +Домены божества\. + +```csharp +public System.Collections.Generic.ICollection DeityDomains { get; set; } +``` + +#### Property Value +[System\.Collections\.Generic\.ICollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1')[DeityDomain](DeityDomain.md 'Pf2eModel\.Model\.Structure\.DeityRelation\.DeityDomain')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Deity.DeitySpells.md b/Documentation/Pf2eModel/Deity.DeitySpells.md new file mode 100644 index 0000000..bf028cb --- /dev/null +++ b/Documentation/Pf2eModel/Deity.DeitySpells.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Deity](Deity.md 'Pf2eModel\.Model\.Structure\.Deity') + +## Deity\.DeitySpells Property + +Заклинания божества\. + +```csharp +public System.Collections.Generic.ICollection DeitySpells { get; set; } +``` + +#### Property Value +[System\.Collections\.Generic\.ICollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1')[DeitySpell](DeitySpell.md 'Pf2eModel\.Model\.Structure\.DeityRelation\.DeitySpell')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Deity.DeityWeapons.md b/Documentation/Pf2eModel/Deity.DeityWeapons.md new file mode 100644 index 0000000..25a7f49 --- /dev/null +++ b/Documentation/Pf2eModel/Deity.DeityWeapons.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Deity](Deity.md 'Pf2eModel\.Model\.Structure\.Deity') + +## Deity\.DeityWeapons Property + +Оружия божества\. + +```csharp +public System.Collections.Generic.ICollection DeityWeapons { get; set; } +``` + +#### Property Value +[System\.Collections\.Generic\.ICollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1')[DeityWeapon](DeityWeapon.md 'Pf2eModel\.Model\.Structure\.DeityRelation\.DeityWeapon')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Deity.Entity.md b/Documentation/Pf2eModel/Deity.Entity.md new file mode 100644 index 0000000..58cddba --- /dev/null +++ b/Documentation/Pf2eModel/Deity.Entity.md @@ -0,0 +1,15 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Deity](Deity.md 'Pf2eModel\.Model\.Structure\.Deity') + +## Deity\.Entity Property + +Корневая сущность\. + +```csharp +public Pf2eModel.Model.Base.Entity Entity { get; set; } +``` + +Implements [Entity](IEntity.Entity.md 'Pf2eModel\.Model\.IEntity\.Entity') + +#### Property Value +[Entity](Entity.md 'Pf2eModel\.Model\.Base\.Entity') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Deity.Fonts.md b/Documentation/Pf2eModel/Deity.Fonts.md new file mode 100644 index 0000000..f4684d1 --- /dev/null +++ b/Documentation/Pf2eModel/Deity.Fonts.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Deity](Deity.md 'Pf2eModel\.Model\.Structure\.Deity') + +## Deity\.Fonts Property + +Тип божественный силы\. + +```csharp +public Pf2eModel.Model.Enum.DeityFonts Fonts { get; set; } +``` + +#### Property Value +[DeityFonts](DeityFonts.md 'Pf2eModel\.Model\.Enum\.DeityFonts') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Deity.Id.md b/Documentation/Pf2eModel/Deity.Id.md new file mode 100644 index 0000000..ad0568a --- /dev/null +++ b/Documentation/Pf2eModel/Deity.Id.md @@ -0,0 +1,15 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Deity](Deity.md 'Pf2eModel\.Model\.Structure\.Deity') + +## Deity\.Id Property + +Идентификатор сущности\. + +```csharp +public int Id { get; set; } +``` + +Implements [Id](IEntity.Id.md 'Pf2eModel\.Model\.IEntity\.Id') + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Deity.Sanctification.md b/Documentation/Pf2eModel/Deity.Sanctification.md new file mode 100644 index 0000000..9619fed --- /dev/null +++ b/Documentation/Pf2eModel/Deity.Sanctification.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Deity](Deity.md 'Pf2eModel\.Model\.Structure\.Deity') + +## Deity\.Sanctification Property + +Тип освящения\. + +```csharp +public Pf2eModel.Model.Enum.DeitySanctification Sanctification { get; set; } +``` + +#### Property Value +[DeitySanctification](DeitySanctification.md 'Pf2eModel\.Model\.Enum\.DeitySanctification') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Deity.SanctificationMust.md b/Documentation/Pf2eModel/Deity.SanctificationMust.md new file mode 100644 index 0000000..a3d21dd --- /dev/null +++ b/Documentation/Pf2eModel/Deity.SanctificationMust.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Deity](Deity.md 'Pf2eModel\.Model\.Structure\.Deity') + +## Deity\.SanctificationMust Property + +Обязательное освящение\. + +```csharp +public bool SanctificationMust { get; set; } +``` + +#### Property Value +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Deity.Skills.md b/Documentation/Pf2eModel/Deity.Skills.md new file mode 100644 index 0000000..9a78dcf --- /dev/null +++ b/Documentation/Pf2eModel/Deity.Skills.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Deity](Deity.md 'Pf2eModel\.Model\.Structure\.Deity') + +## Deity\.Skills Property + +Навыки божества\. + +```csharp +public System.Collections.Generic.ICollection Skills { get; set; } +``` + +#### Property Value +[System\.Collections\.Generic\.ICollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1')[Training](Training.md 'Pf2eModel\.Model\.Common\.Training')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Deity.md b/Documentation/Pf2eModel/Deity.md new file mode 100644 index 0000000..8d755f2 --- /dev/null +++ b/Documentation/Pf2eModel/Deity.md @@ -0,0 +1,28 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure') + +## Deity Class + +Божество\. + +```csharp +public class Deity : Pf2eModel.Model.IEntity +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 Deity + +Implements [IEntity](IEntity.md 'Pf2eModel\.Model\.IEntity') + +| Properties | | +| :--- | :--- | +| [Category](Deity.Category.md 'Pf2eModel\.Model\.Structure\.Deity\.Category') | Тип божества\. | +| [DeityAttributes](Deity.DeityAttributes.md 'Pf2eModel\.Model\.Structure\.Deity\.DeityAttributes') | Аттрибуты божества\. | +| [DeityDomains](Deity.DeityDomains.md 'Pf2eModel\.Model\.Structure\.Deity\.DeityDomains') | Домены божества\. | +| [DeitySpells](Deity.DeitySpells.md 'Pf2eModel\.Model\.Structure\.Deity\.DeitySpells') | Заклинания божества\. | +| [DeityWeapons](Deity.DeityWeapons.md 'Pf2eModel\.Model\.Structure\.Deity\.DeityWeapons') | Оружия божества\. | +| [Entity](Deity.Entity.md 'Pf2eModel\.Model\.Structure\.Deity\.Entity') | Корневая сущность\. | +| [Fonts](Deity.Fonts.md 'Pf2eModel\.Model\.Structure\.Deity\.Fonts') | Тип божественный силы\. | +| [Id](Deity.Id.md 'Pf2eModel\.Model\.Structure\.Deity\.Id') | Идентификатор сущности\. | +| [Sanctification](Deity.Sanctification.md 'Pf2eModel\.Model\.Structure\.Deity\.Sanctification') | Тип освящения\. | +| [SanctificationMust](Deity.SanctificationMust.md 'Pf2eModel\.Model\.Structure\.Deity\.SanctificationMust') | Обязательное освящение\. | +| [Skills](Deity.Skills.md 'Pf2eModel\.Model\.Structure\.Deity\.Skills') | Навыки божества\. | diff --git a/Documentation/Pf2eModel/DeityAttribute.Attribute.md b/Documentation/Pf2eModel/DeityAttribute.Attribute.md new file mode 100644 index 0000000..2309eda --- /dev/null +++ b/Documentation/Pf2eModel/DeityAttribute.Attribute.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.DeityRelation](Pf2eModel.Model.Structure.DeityRelation.md 'Pf2eModel\.Model\.Structure\.DeityRelation').[DeityAttribute](DeityAttribute.md 'Pf2eModel\.Model\.Structure\.DeityRelation\.DeityAttribute') + +## DeityAttribute\.Attribute Property + +Атрибут божества\. + +```csharp +public Pf2eModel.Model.Enum.AttributeValues Attribute { get; set; } +``` + +#### Property Value +[AttributeValues](AttributeValues.md 'Pf2eModel\.Model\.Enum\.AttributeValues') \ No newline at end of file diff --git a/Documentation/Pf2eModel/DeityAttribute.Deity.md b/Documentation/Pf2eModel/DeityAttribute.Deity.md new file mode 100644 index 0000000..c59bf55 --- /dev/null +++ b/Documentation/Pf2eModel/DeityAttribute.Deity.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.DeityRelation](Pf2eModel.Model.Structure.DeityRelation.md 'Pf2eModel\.Model\.Structure\.DeityRelation').[DeityAttribute](DeityAttribute.md 'Pf2eModel\.Model\.Structure\.DeityRelation\.DeityAttribute') + +## DeityAttribute\.Deity Property + +Божество, к которому относится атрибут\. + +```csharp +public Pf2eModel.Model.Structure.Deity Deity { get; set; } +``` + +#### Property Value +[Deity](Deity.md 'Pf2eModel\.Model\.Structure\.Deity') \ No newline at end of file diff --git a/Documentation/Pf2eModel/DeityAttribute.DeityId.md b/Documentation/Pf2eModel/DeityAttribute.DeityId.md new file mode 100644 index 0000000..a8cbb73 --- /dev/null +++ b/Documentation/Pf2eModel/DeityAttribute.DeityId.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.DeityRelation](Pf2eModel.Model.Structure.DeityRelation.md 'Pf2eModel\.Model\.Structure\.DeityRelation').[DeityAttribute](DeityAttribute.md 'Pf2eModel\.Model\.Structure\.DeityRelation\.DeityAttribute') + +## DeityAttribute\.DeityId Property + +Идентификатор божества\. + +```csharp +public int DeityId { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/DeityAttribute.md b/Documentation/Pf2eModel/DeityAttribute.md new file mode 100644 index 0000000..6a95a78 --- /dev/null +++ b/Documentation/Pf2eModel/DeityAttribute.md @@ -0,0 +1,18 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.DeityRelation](Pf2eModel.Model.Structure.DeityRelation.md 'Pf2eModel\.Model\.Structure\.DeityRelation') + +## DeityAttribute Class + +Элемент отношения божества и атрибута\. + +```csharp +public class DeityAttribute +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 DeityAttribute + +| Properties | | +| :--- | :--- | +| [Attribute](DeityAttribute.Attribute.md 'Pf2eModel\.Model\.Structure\.DeityRelation\.DeityAttribute\.Attribute') | Атрибут божества\. | +| [Deity](DeityAttribute.Deity.md 'Pf2eModel\.Model\.Structure\.DeityRelation\.DeityAttribute\.Deity') | Божество, к которому относится атрибут\. | +| [DeityId](DeityAttribute.DeityId.md 'Pf2eModel\.Model\.Structure\.DeityRelation\.DeityAttribute\.DeityId') | Идентификатор божества\. | diff --git a/Documentation/Pf2eModel/DeityCategory.md b/Documentation/Pf2eModel/DeityCategory.md new file mode 100644 index 0000000..d2921b6 --- /dev/null +++ b/Documentation/Pf2eModel/DeityCategory.md @@ -0,0 +1,35 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Enum](Pf2eModel.Model.Enum.md 'Pf2eModel\.Model\.Enum') + +## DeityCategory Enum + +Тип божества\. + +```csharp +public enum DeityCategory +``` +### Fields + + + +`Deity` 0 + +Божество\. + + + +`Pantheon` 1 + +Пантеон\. + + + +`Covenant` 2 + +Ковенант\. + + + +`Philosophy` 3 + +Философия\. \ No newline at end of file diff --git a/Documentation/Pf2eModel/DeityDomain.Deity.md b/Documentation/Pf2eModel/DeityDomain.Deity.md new file mode 100644 index 0000000..db0bba3 --- /dev/null +++ b/Documentation/Pf2eModel/DeityDomain.Deity.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.DeityRelation](Pf2eModel.Model.Structure.DeityRelation.md 'Pf2eModel\.Model\.Structure\.DeityRelation').[DeityDomain](DeityDomain.md 'Pf2eModel\.Model\.Structure\.DeityRelation\.DeityDomain') + +## DeityDomain\.Deity Property + +Божество, к которому относится домен\. + +```csharp +public virtual Pf2eModel.Model.Structure.Deity Deity { get; set; } +``` + +#### Property Value +[Deity](Deity.md 'Pf2eModel\.Model\.Structure\.Deity') \ No newline at end of file diff --git a/Documentation/Pf2eModel/DeityDomain.DeityId.md b/Documentation/Pf2eModel/DeityDomain.DeityId.md new file mode 100644 index 0000000..9847b45 --- /dev/null +++ b/Documentation/Pf2eModel/DeityDomain.DeityId.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.DeityRelation](Pf2eModel.Model.Structure.DeityRelation.md 'Pf2eModel\.Model\.Structure\.DeityRelation').[DeityDomain](DeityDomain.md 'Pf2eModel\.Model\.Structure\.DeityRelation\.DeityDomain') + +## DeityDomain\.DeityId Property + +Идентификатор божества, к которому относится домен\. + +```csharp +public int DeityId { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/DeityDomain.Id.md b/Documentation/Pf2eModel/DeityDomain.Id.md new file mode 100644 index 0000000..a03ec34 --- /dev/null +++ b/Documentation/Pf2eModel/DeityDomain.Id.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.DeityRelation](Pf2eModel.Model.Structure.DeityRelation.md 'Pf2eModel\.Model\.Structure\.DeityRelation').[DeityDomain](DeityDomain.md 'Pf2eModel\.Model\.Structure\.DeityRelation\.DeityDomain') + +## DeityDomain\.Id Property + +Идентификатор отношения божества и домена\. + +```csharp +public int Id { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/DeityDomain.IsPrimary.md b/Documentation/Pf2eModel/DeityDomain.IsPrimary.md new file mode 100644 index 0000000..3f495ae --- /dev/null +++ b/Documentation/Pf2eModel/DeityDomain.IsPrimary.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.DeityRelation](Pf2eModel.Model.Structure.DeityRelation.md 'Pf2eModel\.Model\.Structure\.DeityRelation').[DeityDomain](DeityDomain.md 'Pf2eModel\.Model\.Structure\.DeityRelation\.DeityDomain') + +## DeityDomain\.IsPrimary Property + +Флаг, указывающий, является ли домен основным для божества\. + +```csharp +public bool IsPrimary { get; set; } +``` + +#### Property Value +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') \ No newline at end of file diff --git a/Documentation/Pf2eModel/DeityDomain.Value.md b/Documentation/Pf2eModel/DeityDomain.Value.md new file mode 100644 index 0000000..21a9e36 --- /dev/null +++ b/Documentation/Pf2eModel/DeityDomain.Value.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.DeityRelation](Pf2eModel.Model.Structure.DeityRelation.md 'Pf2eModel\.Model\.Structure\.DeityRelation').[DeityDomain](DeityDomain.md 'Pf2eModel\.Model\.Structure\.DeityRelation\.DeityDomain') + +## DeityDomain\.Value Property + +Значение домена божества, например, "Свет", "Тьма" и т\.д\. + +```csharp +public string Value { get; set; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eModel/DeityDomain.md b/Documentation/Pf2eModel/DeityDomain.md new file mode 100644 index 0000000..b7bcfb1 --- /dev/null +++ b/Documentation/Pf2eModel/DeityDomain.md @@ -0,0 +1,20 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.DeityRelation](Pf2eModel.Model.Structure.DeityRelation.md 'Pf2eModel\.Model\.Structure\.DeityRelation') + +## DeityDomain Class + +Элемент отношения божества и домена\. + +```csharp +public class DeityDomain +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 DeityDomain + +| Properties | | +| :--- | :--- | +| [Deity](DeityDomain.Deity.md 'Pf2eModel\.Model\.Structure\.DeityRelation\.DeityDomain\.Deity') | Божество, к которому относится домен\. | +| [DeityId](DeityDomain.DeityId.md 'Pf2eModel\.Model\.Structure\.DeityRelation\.DeityDomain\.DeityId') | Идентификатор божества, к которому относится домен\. | +| [Id](DeityDomain.Id.md 'Pf2eModel\.Model\.Structure\.DeityRelation\.DeityDomain\.Id') | Идентификатор отношения божества и домена\. | +| [IsPrimary](DeityDomain.IsPrimary.md 'Pf2eModel\.Model\.Structure\.DeityRelation\.DeityDomain\.IsPrimary') | Флаг, указывающий, является ли домен основным для божества\. | +| [Value](DeityDomain.Value.md 'Pf2eModel\.Model\.Structure\.DeityRelation\.DeityDomain\.Value') | Значение домена божества, например, "Свет", "Тьма" и т\.д\. | diff --git a/Documentation/Pf2eModel/DeityFonts.md b/Documentation/Pf2eModel/DeityFonts.md new file mode 100644 index 0000000..7cd0271 --- /dev/null +++ b/Documentation/Pf2eModel/DeityFonts.md @@ -0,0 +1,35 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Enum](Pf2eModel.Model.Enum.md 'Pf2eModel\.Model\.Enum') + +## DeityFonts Enum + +Тип божественной силы\. + +```csharp +public enum DeityFonts +``` +### Fields + + + +`None` 0 + +Без божественной силы\. + + + +`Heal` 1 + +Исцеление\. + + + +`Harm` 2 + +Урон\. + + + +`Any` 3 + +Любой тип божественной силы\. \ No newline at end of file diff --git a/Documentation/Pf2eModel/DeitySanctification.md b/Documentation/Pf2eModel/DeitySanctification.md new file mode 100644 index 0000000..cb27b0f --- /dev/null +++ b/Documentation/Pf2eModel/DeitySanctification.md @@ -0,0 +1,29 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Enum](Pf2eModel.Model.Enum.md 'Pf2eModel\.Model\.Enum') + +## DeitySanctification Enum + +Тип освящения божества\. + +```csharp +public enum DeitySanctification +``` +### Fields + + + +`Holy` 0 + +Святость\. + + + +`Unholy` 1 + +Нечестивость\. + + + +`Any` 2 + +Любое\. \ No newline at end of file diff --git a/Documentation/Pf2eModel/DeitySpell.Deity.md b/Documentation/Pf2eModel/DeitySpell.Deity.md new file mode 100644 index 0000000..e950ef1 --- /dev/null +++ b/Documentation/Pf2eModel/DeitySpell.Deity.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.DeityRelation](Pf2eModel.Model.Structure.DeityRelation.md 'Pf2eModel\.Model\.Structure\.DeityRelation').[DeitySpell](DeitySpell.md 'Pf2eModel\.Model\.Structure\.DeityRelation\.DeitySpell') + +## DeitySpell\.Deity Property + +Божество, к которому относится заклинание\. + +```csharp +public virtual Pf2eModel.Model.Structure.Deity Deity { get; set; } +``` + +#### Property Value +[Deity](Deity.md 'Pf2eModel\.Model\.Structure\.Deity') \ No newline at end of file diff --git a/Documentation/Pf2eModel/DeitySpell.DeityId.md b/Documentation/Pf2eModel/DeitySpell.DeityId.md new file mode 100644 index 0000000..6cf3875 --- /dev/null +++ b/Documentation/Pf2eModel/DeitySpell.DeityId.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.DeityRelation](Pf2eModel.Model.Structure.DeityRelation.md 'Pf2eModel\.Model\.Structure\.DeityRelation').[DeitySpell](DeitySpell.md 'Pf2eModel\.Model\.Structure\.DeityRelation\.DeitySpell') + +## DeitySpell\.DeityId Property + +Идентификатор божества, к которому относится заклинание\. + +```csharp +public int DeityId { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/DeitySpell.Id.md b/Documentation/Pf2eModel/DeitySpell.Id.md new file mode 100644 index 0000000..1b01db2 --- /dev/null +++ b/Documentation/Pf2eModel/DeitySpell.Id.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.DeityRelation](Pf2eModel.Model.Structure.DeityRelation.md 'Pf2eModel\.Model\.Structure\.DeityRelation').[DeitySpell](DeitySpell.md 'Pf2eModel\.Model\.Structure\.DeityRelation\.DeitySpell') + +## DeitySpell\.Id Property + +Идентификатор связи божества и заклинания\. + +```csharp +public int Id { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/DeitySpell.Level.md b/Documentation/Pf2eModel/DeitySpell.Level.md new file mode 100644 index 0000000..1447018 --- /dev/null +++ b/Documentation/Pf2eModel/DeitySpell.Level.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.DeityRelation](Pf2eModel.Model.Structure.DeityRelation.md 'Pf2eModel\.Model\.Structure\.DeityRelation').[DeitySpell](DeitySpell.md 'Pf2eModel\.Model\.Structure\.DeityRelation\.DeitySpell') + +## DeitySpell\.Level Property + +Уровень заклинания\. + +```csharp +public int Level { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/DeitySpell.Spell.md b/Documentation/Pf2eModel/DeitySpell.Spell.md new file mode 100644 index 0000000..69b2ac9 --- /dev/null +++ b/Documentation/Pf2eModel/DeitySpell.Spell.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.DeityRelation](Pf2eModel.Model.Structure.DeityRelation.md 'Pf2eModel\.Model\.Structure\.DeityRelation').[DeitySpell](DeitySpell.md 'Pf2eModel\.Model\.Structure\.DeityRelation\.DeitySpell') + +## DeitySpell\.Spell Property + +Заклинание, связанное с божеством\. + +```csharp +public virtual Pf2eModel.Model.Structure.Spell Spell { get; set; } +``` + +#### Property Value +[Spell](Spell.md 'Pf2eModel\.Model\.Structure\.Spell') \ No newline at end of file diff --git a/Documentation/Pf2eModel/DeitySpell.SpellId.md b/Documentation/Pf2eModel/DeitySpell.SpellId.md new file mode 100644 index 0000000..285a9ab --- /dev/null +++ b/Documentation/Pf2eModel/DeitySpell.SpellId.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.DeityRelation](Pf2eModel.Model.Structure.DeityRelation.md 'Pf2eModel\.Model\.Structure\.DeityRelation').[DeitySpell](DeitySpell.md 'Pf2eModel\.Model\.Structure\.DeityRelation\.DeitySpell') + +## DeitySpell\.SpellId Property + +Идентификатор заклинания, связанного с божеством\. + +```csharp +public int SpellId { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/DeitySpell.md b/Documentation/Pf2eModel/DeitySpell.md new file mode 100644 index 0000000..7962984 --- /dev/null +++ b/Documentation/Pf2eModel/DeitySpell.md @@ -0,0 +1,21 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.DeityRelation](Pf2eModel.Model.Structure.DeityRelation.md 'Pf2eModel\.Model\.Structure\.DeityRelation') + +## DeitySpell Class + +Связь божества и заклинания\. + +```csharp +public class DeitySpell +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 DeitySpell + +| Properties | | +| :--- | :--- | +| [Deity](DeitySpell.Deity.md 'Pf2eModel\.Model\.Structure\.DeityRelation\.DeitySpell\.Deity') | Божество, к которому относится заклинание\. | +| [DeityId](DeitySpell.DeityId.md 'Pf2eModel\.Model\.Structure\.DeityRelation\.DeitySpell\.DeityId') | Идентификатор божества, к которому относится заклинание\. | +| [Id](DeitySpell.Id.md 'Pf2eModel\.Model\.Structure\.DeityRelation\.DeitySpell\.Id') | Идентификатор связи божества и заклинания\. | +| [Level](DeitySpell.Level.md 'Pf2eModel\.Model\.Structure\.DeityRelation\.DeitySpell\.Level') | Уровень заклинания\. | +| [Spell](DeitySpell.Spell.md 'Pf2eModel\.Model\.Structure\.DeityRelation\.DeitySpell\.Spell') | Заклинание, связанное с божеством\. | +| [SpellId](DeitySpell.SpellId.md 'Pf2eModel\.Model\.Structure\.DeityRelation\.DeitySpell\.SpellId') | Идентификатор заклинания, связанного с божеством\. | diff --git a/Documentation/Pf2eModel/DeityWeapon.Deity.md b/Documentation/Pf2eModel/DeityWeapon.Deity.md new file mode 100644 index 0000000..84d5526 --- /dev/null +++ b/Documentation/Pf2eModel/DeityWeapon.Deity.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.DeityRelation](Pf2eModel.Model.Structure.DeityRelation.md 'Pf2eModel\.Model\.Structure\.DeityRelation').[DeityWeapon](DeityWeapon.md 'Pf2eModel\.Model\.Structure\.DeityRelation\.DeityWeapon') + +## DeityWeapon\.Deity Property + +Божество, к которому относится оружие\. + +```csharp +public virtual Pf2eModel.Model.Structure.Deity Deity { get; set; } +``` + +#### Property Value +[Deity](Deity.md 'Pf2eModel\.Model\.Structure\.Deity') \ No newline at end of file diff --git a/Documentation/Pf2eModel/DeityWeapon.DeityId.md b/Documentation/Pf2eModel/DeityWeapon.DeityId.md new file mode 100644 index 0000000..761e704 --- /dev/null +++ b/Documentation/Pf2eModel/DeityWeapon.DeityId.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.DeityRelation](Pf2eModel.Model.Structure.DeityRelation.md 'Pf2eModel\.Model\.Structure\.DeityRelation').[DeityWeapon](DeityWeapon.md 'Pf2eModel\.Model\.Structure\.DeityRelation\.DeityWeapon') + +## DeityWeapon\.DeityId Property + +Идентификатор божества, к которому относится оружие\. + +```csharp +public int DeityId { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/DeityWeapon.Id.md b/Documentation/Pf2eModel/DeityWeapon.Id.md new file mode 100644 index 0000000..5288137 --- /dev/null +++ b/Documentation/Pf2eModel/DeityWeapon.Id.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.DeityRelation](Pf2eModel.Model.Structure.DeityRelation.md 'Pf2eModel\.Model\.Structure\.DeityRelation').[DeityWeapon](DeityWeapon.md 'Pf2eModel\.Model\.Structure\.DeityRelation\.DeityWeapon') + +## DeityWeapon\.Id Property + +Идентификатор связи божества с оружием\. + +```csharp +public int Id { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/DeityWeapon.Weapon.md b/Documentation/Pf2eModel/DeityWeapon.Weapon.md new file mode 100644 index 0000000..a9d44b6 --- /dev/null +++ b/Documentation/Pf2eModel/DeityWeapon.Weapon.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.DeityRelation](Pf2eModel.Model.Structure.DeityRelation.md 'Pf2eModel\.Model\.Structure\.DeityRelation').[DeityWeapon](DeityWeapon.md 'Pf2eModel\.Model\.Structure\.DeityRelation\.DeityWeapon') + +## DeityWeapon\.Weapon Property + +Название оружия, связанного с божеством\. Будет изменено на идентификатор оружия в будущем, когда будет реализована система оружия\. + +```csharp +public string Weapon { get; set; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eModel/DeityWeapon.md b/Documentation/Pf2eModel/DeityWeapon.md new file mode 100644 index 0000000..d0184bb --- /dev/null +++ b/Documentation/Pf2eModel/DeityWeapon.md @@ -0,0 +1,19 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.DeityRelation](Pf2eModel.Model.Structure.DeityRelation.md 'Pf2eModel\.Model\.Structure\.DeityRelation') + +## DeityWeapon Class + +Связь божества с оружием\. + +```csharp +public class DeityWeapon +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 DeityWeapon + +| Properties | | +| :--- | :--- | +| [Deity](DeityWeapon.Deity.md 'Pf2eModel\.Model\.Structure\.DeityRelation\.DeityWeapon\.Deity') | Божество, к которому относится оружие\. | +| [DeityId](DeityWeapon.DeityId.md 'Pf2eModel\.Model\.Structure\.DeityRelation\.DeityWeapon\.DeityId') | Идентификатор божества, к которому относится оружие\. | +| [Id](DeityWeapon.Id.md 'Pf2eModel\.Model\.Structure\.DeityRelation\.DeityWeapon\.Id') | Идентификатор связи божества с оружием\. | +| [Weapon](DeityWeapon.Weapon.md 'Pf2eModel\.Model\.Structure\.DeityRelation\.DeityWeapon\.Weapon') | Название оружия, связанного с божеством\. Будет изменено на идентификатор оружия в будущем, когда будет реализована система оружия\. | diff --git a/Documentation/Pf2eModel/EfCleanHelper.GetName(IEntityType,string).md b/Documentation/Pf2eModel/EfCleanHelper.GetName(IEntityType,string).md new file mode 100644 index 0000000..44c6417 --- /dev/null +++ b/Documentation/Pf2eModel/EfCleanHelper.GetName(IEntityType,string).md @@ -0,0 +1,26 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel](Pf2eModel.md 'Pf2eModel').[EfCleanHelper](EfCleanHelper.md 'Pf2eModel\.EfCleanHelper') + +## EfCleanHelper\.GetName\(IEntityType, string\) Method + +Определение полного названия таблицы по служебному классу\. + +```csharp +private static string GetName(Microsoft.EntityFrameworkCore.Metadata.IEntityType entityType, string defaultSchemaName="public"); +``` +#### Parameters + + + +`entityType` [Microsoft\.EntityFrameworkCore\.Metadata\.IEntityType](https://docs.microsoft.com/en-us/dotnet/api/Microsoft.EntityFrameworkCore.Metadata.IEntityType 'Microsoft\.EntityFrameworkCore\.Metadata\.IEntityType') + +Служебный класс, определяющий таблицу базы данных\. + + + +`defaultSchemaName` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +Схема таблицы по умолчанию \(`"public"` для PostgresSQL\) + +#### Returns +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eModel/EfCleanHelper.TableName.md b/Documentation/Pf2eModel/EfCleanHelper.TableName.md new file mode 100644 index 0000000..98ef263 --- /dev/null +++ b/Documentation/Pf2eModel/EfCleanHelper.TableName.md @@ -0,0 +1,67 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel](Pf2eModel.md 'Pf2eModel').[EfCleanHelper](EfCleanHelper.md 'Pf2eModel\.EfCleanHelper') + +## EfCleanHelper\.TableName Method + +| Overloads | | +| :--- | :--- | +| [TableName<T>\(DbContext\)](EfCleanHelper.TableName.md#Pf2eModel.EfCleanHelper.TableName_T_(Microsoft.EntityFrameworkCore.DbContext) 'Pf2eModel\.EfCleanHelper\.TableName\\(Microsoft\.EntityFrameworkCore\.DbContext\)') | Определение полного названия таблицы по типу сущности\. | +| [TableName<T>\(DbSet<T>\)](EfCleanHelper.TableName.md#Pf2eModel.EfCleanHelper.TableName_T_(Microsoft.EntityFrameworkCore.DbSet_T_) 'Pf2eModel\.EfCleanHelper\.TableName\\(Microsoft\.EntityFrameworkCore\.DbSet\\)') | Определение полного названия таблицы по типу сущности\. | + + + +## EfCleanHelper\.TableName\\(DbContext\) Method + +Определение полного названия таблицы по типу сущности\. + +```csharp +public static string TableName(Microsoft.EntityFrameworkCore.DbContext dbContext) + where T : class; +``` +#### Type parameters + + + +`T` + +Тип искомой сущности\. +#### Parameters + + + +`dbContext` [Microsoft\.EntityFrameworkCore\.DbContext](https://docs.microsoft.com/en-us/dotnet/api/Microsoft.EntityFrameworkCore.DbContext 'Microsoft\.EntityFrameworkCore\.DbContext') + +Контекст, в котором производится поиск таблицы\. + +#### Returns +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') +Строковое представление названия таблицы\. + + + +## EfCleanHelper\.TableName\\(DbSet\\) Method + +Определение полного названия таблицы по типу сущности\. + +```csharp +public static string TableName(Microsoft.EntityFrameworkCore.DbSet dbSet) + where T : class; +``` +#### Type parameters + + + +`T` + +Тип искомой сущности\. +#### Parameters + + + +`dbSet` [Microsoft\.EntityFrameworkCore\.DbSet<](https://docs.microsoft.com/en-us/dotnet/api/Microsoft.EntityFrameworkCore.DbSet-1 'Microsoft\.EntityFrameworkCore\.DbSet\`1')[T](EfCleanHelper.md#Pf2eModel.EfCleanHelper.TableName_T_(Microsoft.EntityFrameworkCore.DbSet_T_).T 'Pf2eModel\.EfCleanHelper\.TableName\\(Microsoft\.EntityFrameworkCore\.DbSet\\)\.T')[>](https://docs.microsoft.com/en-us/dotnet/api/Microsoft.EntityFrameworkCore.DbSet-1 'Microsoft\.EntityFrameworkCore\.DbSet\`1') + +CLR\-представление таблицы, название которой требуется определить\. + +#### Returns +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') +Строковое представление названия таблицы\. \ No newline at end of file diff --git a/Documentation/Pf2eModel/EfCleanHelper.TruncateAll(thisDbContext).md b/Documentation/Pf2eModel/EfCleanHelper.TruncateAll(thisDbContext).md new file mode 100644 index 0000000..24f65aa --- /dev/null +++ b/Documentation/Pf2eModel/EfCleanHelper.TruncateAll(thisDbContext).md @@ -0,0 +1,21 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel](Pf2eModel.md 'Pf2eModel').[EfCleanHelper](EfCleanHelper.md 'Pf2eModel\.EfCleanHelper') + +## EfCleanHelper\.TruncateAll\(this DbContext\) Method + +Получение SQL\-команды отчистки содержимого всех таблиц базы данных\. + +```csharp +public static string TruncateAll(this Microsoft.EntityFrameworkCore.DbContext context); +``` +#### Parameters + + + +`context` [Microsoft\.EntityFrameworkCore\.DbContext](https://docs.microsoft.com/en-us/dotnet/api/Microsoft.EntityFrameworkCore.DbContext 'Microsoft\.EntityFrameworkCore\.DbContext') + +Контекст базы данных, в которой необходимо отчистить все строки\. + +#### Returns +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') +Строковое представление выполненных SQL\-команды\. \ No newline at end of file diff --git a/Documentation/Pf2eModel/EfCleanHelper.Truncate_T_(thisDbSet_T_).md b/Documentation/Pf2eModel/EfCleanHelper.Truncate_T_(thisDbSet_T_).md new file mode 100644 index 0000000..e3d2b8b --- /dev/null +++ b/Documentation/Pf2eModel/EfCleanHelper.Truncate_T_(thisDbSet_T_).md @@ -0,0 +1,29 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel](Pf2eModel.md 'Pf2eModel').[EfCleanHelper](EfCleanHelper.md 'Pf2eModel\.EfCleanHelper') + +## EfCleanHelper\.Truncate\\(this DbSet\\) Method + +Отчистка содержимого таблицы\. + +```csharp +public static string Truncate(this Microsoft.EntityFrameworkCore.DbSet dbSet) + where T : class; +``` +#### Type parameters + + + +`T` + +Тип сущности, таблицу которой необходимо отчистить\. +#### Parameters + + + +`dbSet` [Microsoft\.EntityFrameworkCore\.DbSet<](https://docs.microsoft.com/en-us/dotnet/api/Microsoft.EntityFrameworkCore.DbSet-1 'Microsoft\.EntityFrameworkCore\.DbSet\`1')[T](EfCleanHelper.Truncate_T_(thisDbSet_T_).md#Pf2eModel.EfCleanHelper.Truncate_T_(thisMicrosoft.EntityFrameworkCore.DbSet_T_).T 'Pf2eModel\.EfCleanHelper\.Truncate\\(this Microsoft\.EntityFrameworkCore\.DbSet\\)\.T')[>](https://docs.microsoft.com/en-us/dotnet/api/Microsoft.EntityFrameworkCore.DbSet-1 'Microsoft\.EntityFrameworkCore\.DbSet\`1') + +CLR\-представление таблицы, которую требуется отчистить\. + +#### Returns +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') +Строковое представление выполненной SQL\-команды\. \ No newline at end of file diff --git a/Documentation/Pf2eModel/EfCleanHelper.md b/Documentation/Pf2eModel/EfCleanHelper.md new file mode 100644 index 0000000..2780e60 --- /dev/null +++ b/Documentation/Pf2eModel/EfCleanHelper.md @@ -0,0 +1,22 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel](Pf2eModel.md 'Pf2eModel') + +## EfCleanHelper Class + +Класс, обеспецивающий общий способ для отчистки данных таблиц\. + +Источник: https://www\.codeproject\.com/Articles/5339402/Delete\-All\-Rows\-in\-Entity\-Framework\-Core\-6 + +```csharp +public static class EfCleanHelper +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 EfCleanHelper + +| Methods | | +| :--- | :--- | +| [GetName\(IEntityType, string\)](EfCleanHelper.GetName(IEntityType,string).md 'Pf2eModel\.EfCleanHelper\.GetName\(Microsoft\.EntityFrameworkCore\.Metadata\.IEntityType, string\)') | Определение полного названия таблицы по служебному классу\. | +| [TableName<T>\(DbContext\)](EfCleanHelper.TableName.md#Pf2eModel.EfCleanHelper.TableName_T_(Microsoft.EntityFrameworkCore.DbContext) 'Pf2eModel\.EfCleanHelper\.TableName\\(Microsoft\.EntityFrameworkCore\.DbContext\)') | Определение полного названия таблицы по типу сущности\. | +| [TableName<T>\(DbSet<T>\)](EfCleanHelper.TableName.md#Pf2eModel.EfCleanHelper.TableName_T_(Microsoft.EntityFrameworkCore.DbSet_T_) 'Pf2eModel\.EfCleanHelper\.TableName\\(Microsoft\.EntityFrameworkCore\.DbSet\\)') | Определение полного названия таблицы по типу сущности\. | +| [Truncate<T>\(this DbSet<T>\)](EfCleanHelper.Truncate_T_(thisDbSet_T_).md 'Pf2eModel\.EfCleanHelper\.Truncate\\(this Microsoft\.EntityFrameworkCore\.DbSet\\)') | Отчистка содержимого таблицы\. | +| [TruncateAll\(this DbContext\)](EfCleanHelper.TruncateAll(thisDbContext).md 'Pf2eModel\.EfCleanHelper\.TruncateAll\(this Microsoft\.EntityFrameworkCore\.DbContext\)') | Получение SQL\-команды отчистки содержимого всех таблиц базы данных\. | diff --git a/Documentation/Pf2eModel/ElementEnum.md b/Documentation/Pf2eModel/ElementEnum.md new file mode 100644 index 0000000..205a975 --- /dev/null +++ b/Documentation/Pf2eModel/ElementEnum.md @@ -0,0 +1,53 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Enum](Pf2eModel.Model.Enum.md 'Pf2eModel\.Model\.Enum') + +## ElementEnum Enum + +Перечисление элементов\. + +```csharp +public enum ElementEnum +``` +### Fields + + + +`Universal` 0 + +Универсальный элемент\. + + + +`Air` 1 + +Воздух\. + + + +`Water` 2 + +Вода\. + + + +`Earth` 3 + +Земля\. + + + +`Fire` 4 + +Огонь\. + + + +`Wood` 5 + +Дерево\. + + + +`Metal` 6 + +Металл\. \ No newline at end of file diff --git a/Documentation/Pf2eModel/Entity.Aliases.md b/Documentation/Pf2eModel/Entity.Aliases.md new file mode 100644 index 0000000..fd3e834 --- /dev/null +++ b/Documentation/Pf2eModel/Entity.Aliases.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Base](Pf2eModel.Model.Base.md 'Pf2eModel\.Model\.Base').[Entity](Entity.md 'Pf2eModel\.Model\.Base\.Entity') + +## Entity\.Aliases Property + +Коллекция алиасов + +```csharp +public System.Collections.Generic.ICollection Aliases { get; set; } +``` + +#### Property Value +[System\.Collections\.Generic\.ICollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1')[EntityAlias](EntityAlias.md 'Pf2eModel\.Model\.Base\.EntityAlias')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Entity.Description.md b/Documentation/Pf2eModel/Entity.Description.md new file mode 100644 index 0000000..c880fb1 --- /dev/null +++ b/Documentation/Pf2eModel/Entity.Description.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Base](Pf2eModel.Model.Base.md 'Pf2eModel\.Model\.Base').[Entity](Entity.md 'Pf2eModel\.Model\.Base\.Entity') + +## Entity\.Description Property + +Текстовое описание сущности\. + +```csharp +public string Description { get; set; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Entity.Externals.md b/Documentation/Pf2eModel/Entity.Externals.md new file mode 100644 index 0000000..6e63c9d --- /dev/null +++ b/Documentation/Pf2eModel/Entity.Externals.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Base](Pf2eModel.Model.Base.md 'Pf2eModel\.Model\.Base').[Entity](Entity.md 'Pf2eModel\.Model\.Base\.Entity') + +## Entity\.Externals Property + +Коллекция внешних ссылок, связанных с сущностью\. + +```csharp +public System.Collections.Generic.ICollection Externals { get; set; } +``` + +#### Property Value +[System\.Collections\.Generic\.ICollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1')[EntityExternal](EntityExternal.md 'Pf2eModel\.Model\.Base\.Targets\.EntityExternal')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Entity.Id.md b/Documentation/Pf2eModel/Entity.Id.md new file mode 100644 index 0000000..183ea2f --- /dev/null +++ b/Documentation/Pf2eModel/Entity.Id.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Base](Pf2eModel.Model.Base.md 'Pf2eModel\.Model\.Base').[Entity](Entity.md 'Pf2eModel\.Model\.Base\.Entity') + +## Entity\.Id Property + +Идентификатор сущности\. + +```csharp +public int Id { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Entity.Img.md b/Documentation/Pf2eModel/Entity.Img.md new file mode 100644 index 0000000..31b5669 --- /dev/null +++ b/Documentation/Pf2eModel/Entity.Img.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Base](Pf2eModel.Model.Base.md 'Pf2eModel\.Model\.Base').[Entity](Entity.md 'Pf2eModel\.Model\.Base\.Entity') + +## Entity\.Img Property + +Изображение сущности\. + +```csharp +public string Img { get; set; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Entity.IsChecked.md b/Documentation/Pf2eModel/Entity.IsChecked.md new file mode 100644 index 0000000..b82ffbd --- /dev/null +++ b/Documentation/Pf2eModel/Entity.IsChecked.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Base](Pf2eModel.Model.Base.md 'Pf2eModel\.Model\.Base').[Entity](Entity.md 'Pf2eModel\.Model\.Base\.Entity') + +## Entity\.IsChecked Property + +Флаг, указывающий, что объект был проверен и не требует автоматической перезаписи\. + +```csharp +public System.Nullable IsChecked { get; set; } +``` + +#### Property Value +[System\.Nullable<](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System\.Nullable\`1')[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System\.Nullable\`1') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Entity.IsTranslated.md b/Documentation/Pf2eModel/Entity.IsTranslated.md new file mode 100644 index 0000000..81b3c7f --- /dev/null +++ b/Documentation/Pf2eModel/Entity.IsTranslated.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Base](Pf2eModel.Model.Base.md 'Pf2eModel\.Model\.Base').[Entity](Entity.md 'Pf2eModel\.Model\.Base\.Entity') + +## Entity\.IsTranslated Property + +Флаг, указывающий, что у объекта существует перевод\. + +```csharp +public System.Nullable IsTranslated { get; set; } +``` + +#### Property Value +[System\.Nullable<](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System\.Nullable\`1')[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System\.Nullable\`1') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Entity.Keywords.md b/Documentation/Pf2eModel/Entity.Keywords.md new file mode 100644 index 0000000..5273f5d --- /dev/null +++ b/Documentation/Pf2eModel/Entity.Keywords.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Base](Pf2eModel.Model.Base.md 'Pf2eModel\.Model\.Base').[Entity](Entity.md 'Pf2eModel\.Model\.Base\.Entity') + +## Entity\.Keywords Property + +Коллекция ключевых слов, связанных с сущностью\. + +```csharp +public System.Collections.Generic.ICollection Keywords { get; set; } +``` + +#### Property Value +[System\.Collections\.Generic\.ICollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1')[Keyword](Keyword.md 'Pf2eModel\.Model\.Base\.Keywords\.Keyword')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Entity.LegacyEntities.md b/Documentation/Pf2eModel/Entity.LegacyEntities.md new file mode 100644 index 0000000..fa4a8d6 --- /dev/null +++ b/Documentation/Pf2eModel/Entity.LegacyEntities.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Base](Pf2eModel.Model.Base.md 'Pf2eModel\.Model\.Base').[Entity](Entity.md 'Pf2eModel\.Model\.Base\.Entity') + +## Entity\.LegacyEntities Property + +Коллекция устаревших сущностей\. + +```csharp +public System.Collections.Generic.ICollection LegacyEntities { get; set; } +``` + +#### Property Value +[System\.Collections\.Generic\.ICollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1')[Entity](Entity.md 'Pf2eModel\.Model\.Base\.Entity')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Entity.LegacyTransferEntities.md b/Documentation/Pf2eModel/Entity.LegacyTransferEntities.md new file mode 100644 index 0000000..ebcd6a3 --- /dev/null +++ b/Documentation/Pf2eModel/Entity.LegacyTransferEntities.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Base](Pf2eModel.Model.Base.md 'Pf2eModel\.Model\.Base').[Entity](Entity.md 'Pf2eModel\.Model\.Base\.Entity') + +## Entity\.LegacyTransferEntities Property + +Коллекция переходных объектов для устаревших сущностей\. + +```csharp +public System.Collections.Generic.ICollection LegacyTransferEntities { get; set; } +``` + +#### Property Value +[System\.Collections\.Generic\.ICollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1')[LegacyRemaster](LegacyRemaster.md 'Pf2eModel\.Model\.Base\.LegacyRemaster')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Entity.Name.md b/Documentation/Pf2eModel/Entity.Name.md new file mode 100644 index 0000000..162055d --- /dev/null +++ b/Documentation/Pf2eModel/Entity.Name.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Base](Pf2eModel.Model.Base.md 'Pf2eModel\.Model\.Base').[Entity](Entity.md 'Pf2eModel\.Model\.Base\.Entity') + +## Entity\.Name Property + +Отображаемое имя сущности\. + +```csharp +public Pf2eModel.Model.Common.I18n.LocaleString Name { get; set; } +``` + +#### Property Value +[LocaleString](LocaleString.md 'Pf2eModel\.Model\.Common\.I18n\.LocaleString') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Entity.Rarity.md b/Documentation/Pf2eModel/Entity.Rarity.md new file mode 100644 index 0000000..d3ab50a --- /dev/null +++ b/Documentation/Pf2eModel/Entity.Rarity.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Base](Pf2eModel.Model.Base.md 'Pf2eModel\.Model\.Base').[Entity](Entity.md 'Pf2eModel\.Model\.Base\.Entity') + +## Entity\.Rarity Property + +Редкость сущности\. + +```csharp +public Pf2eModel.Model.Enum.EntityRarity Rarity { get; set; } +``` + +#### Property Value +[EntityRarity](EntityRarity.md 'Pf2eModel\.Model\.Enum\.EntityRarity') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Entity.RemasterEntities.md b/Documentation/Pf2eModel/Entity.RemasterEntities.md new file mode 100644 index 0000000..a95007c --- /dev/null +++ b/Documentation/Pf2eModel/Entity.RemasterEntities.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Base](Pf2eModel.Model.Base.md 'Pf2eModel\.Model\.Base').[Entity](Entity.md 'Pf2eModel\.Model\.Base\.Entity') + +## Entity\.RemasterEntities Property + +Коллекция обновлённых сущностей\. + +```csharp +public System.Collections.Generic.ICollection RemasterEntities { get; set; } +``` + +#### Property Value +[System\.Collections\.Generic\.ICollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1')[Entity](Entity.md 'Pf2eModel\.Model\.Base\.Entity')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Entity.RemasterTransferEntities.md b/Documentation/Pf2eModel/Entity.RemasterTransferEntities.md new file mode 100644 index 0000000..08395f7 --- /dev/null +++ b/Documentation/Pf2eModel/Entity.RemasterTransferEntities.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Base](Pf2eModel.Model.Base.md 'Pf2eModel\.Model\.Base').[Entity](Entity.md 'Pf2eModel\.Model\.Base\.Entity') + +## Entity\.RemasterTransferEntities Property + +Коллекция переходных объектов для обновлённых сущностей\. + +```csharp +public System.Collections.Generic.ICollection RemasterTransferEntities { get; set; } +``` + +#### Property Value +[System\.Collections\.Generic\.ICollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1')[LegacyRemaster](LegacyRemaster.md 'Pf2eModel\.Model\.Base\.LegacyRemaster')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Entity.Slug.md b/Documentation/Pf2eModel/Entity.Slug.md new file mode 100644 index 0000000..11db849 --- /dev/null +++ b/Documentation/Pf2eModel/Entity.Slug.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Base](Pf2eModel.Model.Base.md 'Pf2eModel\.Model\.Base').[Entity](Entity.md 'Pf2eModel\.Model\.Base\.Entity') + +## Entity\.Slug Property + +Часть имени в URL\. + +```csharp +public string Slug { get; set; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Entity.Sources.md b/Documentation/Pf2eModel/Entity.Sources.md new file mode 100644 index 0000000..a9e1fdc --- /dev/null +++ b/Documentation/Pf2eModel/Entity.Sources.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Base](Pf2eModel.Model.Base.md 'Pf2eModel\.Model\.Base').[Entity](Entity.md 'Pf2eModel\.Model\.Base\.Entity') + +## Entity\.Sources Property + +Коллекция источников, связанных с сущностью\. + +```csharp +public System.Collections.Generic.ICollection Sources { get; set; } +``` + +#### Property Value +[System\.Collections\.Generic\.ICollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1')[EntitySource](EntitySource.md 'Pf2eModel\.Model\.Base\.Source\.EntitySource')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Entity.Traits.md b/Documentation/Pf2eModel/Entity.Traits.md new file mode 100644 index 0000000..abfb4e9 --- /dev/null +++ b/Documentation/Pf2eModel/Entity.Traits.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Base](Pf2eModel.Model.Base.md 'Pf2eModel\.Model\.Base').[Entity](Entity.md 'Pf2eModel\.Model\.Base\.Entity') + +## Entity\.Traits Property + +Коллекция признаков, связанных с сущностью\. + +```csharp +public System.Collections.Generic.ICollection Traits { get; set; } +``` + +#### Property Value +[System\.Collections\.Generic\.ICollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1')[Trait](Trait.md 'Pf2eModel\.Model\.Structure\.Trait')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Entity.Type.md b/Documentation/Pf2eModel/Entity.Type.md new file mode 100644 index 0000000..7411e9c --- /dev/null +++ b/Documentation/Pf2eModel/Entity.Type.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Base](Pf2eModel.Model.Base.md 'Pf2eModel\.Model\.Base').[Entity](Entity.md 'Pf2eModel\.Model\.Base\.Entity') + +## Entity\.Type Property + +Тип сущности\. + +```csharp +public Pf2eModel.Model.Enum.EntityType Type { get; set; } +``` + +#### Property Value +[EntityType](EntityType.md 'Pf2eModel\.Model\.Enum\.EntityType') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Entity.md b/Documentation/Pf2eModel/Entity.md new file mode 100644 index 0000000..255c56a --- /dev/null +++ b/Documentation/Pf2eModel/Entity.md @@ -0,0 +1,33 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Base](Pf2eModel.Model.Base.md 'Pf2eModel\.Model\.Base') + +## Entity Class + +Корневая сущность\. + +```csharp +public class Entity +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 Entity + +| Properties | | +| :--- | :--- | +| [Aliases](Entity.Aliases.md 'Pf2eModel\.Model\.Base\.Entity\.Aliases') | Коллекция алиасов | +| [Description](Entity.Description.md 'Pf2eModel\.Model\.Base\.Entity\.Description') | Текстовое описание сущности\. | +| [Externals](Entity.Externals.md 'Pf2eModel\.Model\.Base\.Entity\.Externals') | Коллекция внешних ссылок, связанных с сущностью\. | +| [Id](Entity.Id.md 'Pf2eModel\.Model\.Base\.Entity\.Id') | Идентификатор сущности\. | +| [Img](Entity.Img.md 'Pf2eModel\.Model\.Base\.Entity\.Img') | Изображение сущности\. | +| [IsChecked](Entity.IsChecked.md 'Pf2eModel\.Model\.Base\.Entity\.IsChecked') | Флаг, указывающий, что объект был проверен и не требует автоматической перезаписи\. | +| [IsTranslated](Entity.IsTranslated.md 'Pf2eModel\.Model\.Base\.Entity\.IsTranslated') | Флаг, указывающий, что у объекта существует перевод\. | +| [Keywords](Entity.Keywords.md 'Pf2eModel\.Model\.Base\.Entity\.Keywords') | Коллекция ключевых слов, связанных с сущностью\. | +| [LegacyEntities](Entity.LegacyEntities.md 'Pf2eModel\.Model\.Base\.Entity\.LegacyEntities') | Коллекция устаревших сущностей\. | +| [LegacyTransferEntities](Entity.LegacyTransferEntities.md 'Pf2eModel\.Model\.Base\.Entity\.LegacyTransferEntities') | Коллекция переходных объектов для устаревших сущностей\. | +| [Name](Entity.Name.md 'Pf2eModel\.Model\.Base\.Entity\.Name') | Отображаемое имя сущности\. | +| [Rarity](Entity.Rarity.md 'Pf2eModel\.Model\.Base\.Entity\.Rarity') | Редкость сущности\. | +| [RemasterEntities](Entity.RemasterEntities.md 'Pf2eModel\.Model\.Base\.Entity\.RemasterEntities') | Коллекция обновлённых сущностей\. | +| [RemasterTransferEntities](Entity.RemasterTransferEntities.md 'Pf2eModel\.Model\.Base\.Entity\.RemasterTransferEntities') | Коллекция переходных объектов для обновлённых сущностей\. | +| [Slug](Entity.Slug.md 'Pf2eModel\.Model\.Base\.Entity\.Slug') | Часть имени в URL\. | +| [Sources](Entity.Sources.md 'Pf2eModel\.Model\.Base\.Entity\.Sources') | Коллекция источников, связанных с сущностью\. | +| [Traits](Entity.Traits.md 'Pf2eModel\.Model\.Base\.Entity\.Traits') | Коллекция признаков, связанных с сущностью\. | +| [Type](Entity.Type.md 'Pf2eModel\.Model\.Base\.Entity\.Type') | Тип сущности\. | diff --git a/Documentation/Pf2eModel/EntityAlias.Entity.md b/Documentation/Pf2eModel/EntityAlias.Entity.md new file mode 100644 index 0000000..c4364e4 --- /dev/null +++ b/Documentation/Pf2eModel/EntityAlias.Entity.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Base](Pf2eModel.Model.Base.md 'Pf2eModel\.Model\.Base').[EntityAlias](EntityAlias.md 'Pf2eModel\.Model\.Base\.EntityAlias') + +## EntityAlias\.Entity Property + +Связанная + +```csharp +public Pf2eModel.Model.Base.Entity Entity { get; set; } +``` + +#### Property Value +[Entity](Entity.md 'Pf2eModel\.Model\.Base\.Entity') \ No newline at end of file diff --git a/Documentation/Pf2eModel/EntityAlias.EntityId.md b/Documentation/Pf2eModel/EntityAlias.EntityId.md new file mode 100644 index 0000000..7e3e2be --- /dev/null +++ b/Documentation/Pf2eModel/EntityAlias.EntityId.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Base](Pf2eModel.Model.Base.md 'Pf2eModel\.Model\.Base').[EntityAlias](EntityAlias.md 'Pf2eModel\.Model\.Base\.EntityAlias') + +## EntityAlias\.EntityId Property + +Идентификатор связанной сущности\. + +```csharp +public int EntityId { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/EntityAlias.Id.md b/Documentation/Pf2eModel/EntityAlias.Id.md new file mode 100644 index 0000000..141e6b0 --- /dev/null +++ b/Documentation/Pf2eModel/EntityAlias.Id.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Base](Pf2eModel.Model.Base.md 'Pf2eModel\.Model\.Base').[EntityAlias](EntityAlias.md 'Pf2eModel\.Model\.Base\.EntityAlias') + +## EntityAlias\.Id Property + +Идентификатор источника\. + +```csharp +public int Id { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/EntityAlias.Name.md b/Documentation/Pf2eModel/EntityAlias.Name.md new file mode 100644 index 0000000..f16588f --- /dev/null +++ b/Documentation/Pf2eModel/EntityAlias.Name.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Base](Pf2eModel.Model.Base.md 'Pf2eModel\.Model\.Base').[EntityAlias](EntityAlias.md 'Pf2eModel\.Model\.Base\.EntityAlias') + +## EntityAlias\.Name Property + +Отображаемое имя источника\. + +```csharp +public string Name { get; set; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eModel/EntityAlias.md b/Documentation/Pf2eModel/EntityAlias.md new file mode 100644 index 0000000..4c8adb2 --- /dev/null +++ b/Documentation/Pf2eModel/EntityAlias.md @@ -0,0 +1,19 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Base](Pf2eModel.Model.Base.md 'Pf2eModel\.Model\.Base') + +## EntityAlias Class + +Алиас сущности\. + +```csharp +public class EntityAlias +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 EntityAlias + +| Properties | | +| :--- | :--- | +| [Entity](EntityAlias.Entity.md 'Pf2eModel\.Model\.Base\.EntityAlias\.Entity') | Связанная | +| [EntityId](EntityAlias.EntityId.md 'Pf2eModel\.Model\.Base\.EntityAlias\.EntityId') | Идентификатор связанной сущности\. | +| [Id](EntityAlias.Id.md 'Pf2eModel\.Model\.Base\.EntityAlias\.Id') | Идентификатор источника\. | +| [Name](EntityAlias.Name.md 'Pf2eModel\.Model\.Base\.EntityAlias\.Name') | Отображаемое имя источника\. | diff --git a/Documentation/Pf2eModel/EntityExternal.Entity.md b/Documentation/Pf2eModel/EntityExternal.Entity.md new file mode 100644 index 0000000..278c623 --- /dev/null +++ b/Documentation/Pf2eModel/EntityExternal.Entity.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Base\.Targets](Pf2eModel.Model.Base.Targets.md 'Pf2eModel\.Model\.Base\.Targets').[EntityExternal](EntityExternal.md 'Pf2eModel\.Model\.Base\.Targets\.EntityExternal') + +## EntityExternal\.Entity Property + +Сущность, которая ссылается на внешнюю ссылку\. + +```csharp +public Pf2eModel.Model.Base.Entity Entity { get; set; } +``` + +#### Property Value +[Entity](Entity.md 'Pf2eModel\.Model\.Base\.Entity') \ No newline at end of file diff --git a/Documentation/Pf2eModel/EntityExternal.EntityId.md b/Documentation/Pf2eModel/EntityExternal.EntityId.md new file mode 100644 index 0000000..6d83f77 --- /dev/null +++ b/Documentation/Pf2eModel/EntityExternal.EntityId.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Base\.Targets](Pf2eModel.Model.Base.Targets.md 'Pf2eModel\.Model\.Base\.Targets').[EntityExternal](EntityExternal.md 'Pf2eModel\.Model\.Base\.Targets\.EntityExternal') + +## EntityExternal\.EntityId Property + +Идентификатор сущности\. + +```csharp +public int EntityId { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/EntityExternal.ExternalId.md b/Documentation/Pf2eModel/EntityExternal.ExternalId.md new file mode 100644 index 0000000..d03719b --- /dev/null +++ b/Documentation/Pf2eModel/EntityExternal.ExternalId.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Base\.Targets](Pf2eModel.Model.Base.Targets.md 'Pf2eModel\.Model\.Base\.Targets').[EntityExternal](EntityExternal.md 'Pf2eModel\.Model\.Base\.Targets\.EntityExternal') + +## EntityExternal\.ExternalId Property + +Идентификатор элемента по ссылке\. + +```csharp +public string? ExternalId { get; set; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eModel/EntityExternal.Md5.md b/Documentation/Pf2eModel/EntityExternal.Md5.md new file mode 100644 index 0000000..da7262d --- /dev/null +++ b/Documentation/Pf2eModel/EntityExternal.Md5.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Base\.Targets](Pf2eModel.Model.Base.Targets.md 'Pf2eModel\.Model\.Base\.Targets').[EntityExternal](EntityExternal.md 'Pf2eModel\.Model\.Base\.Targets\.EntityExternal') + +## EntityExternal\.Md5 Property + +Контрольная сумма объекта\. + +```csharp +public string Md5 { get; set; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eModel/EntityExternal.Suffix.md b/Documentation/Pf2eModel/EntityExternal.Suffix.md new file mode 100644 index 0000000..5e540bc --- /dev/null +++ b/Documentation/Pf2eModel/EntityExternal.Suffix.md @@ -0,0 +1,14 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Base\.Targets](Pf2eModel.Model.Base.Targets.md 'Pf2eModel\.Model\.Base\.Targets').[EntityExternal](EntityExternal.md 'Pf2eModel\.Model\.Base\.Targets\.EntityExternal') + +## EntityExternal\.Suffix Property + +Конечная часть URL внешней ссылки\. +Для источников Foundry \- полный UUID объекта\. + +```csharp +public string Suffix { get; set; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eModel/EntityExternal.Target.md b/Documentation/Pf2eModel/EntityExternal.Target.md new file mode 100644 index 0000000..a1514ae --- /dev/null +++ b/Documentation/Pf2eModel/EntityExternal.Target.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Base\.Targets](Pf2eModel.Model.Base.Targets.md 'Pf2eModel\.Model\.Base\.Targets').[EntityExternal](EntityExternal.md 'Pf2eModel\.Model\.Base\.Targets\.EntityExternal') + +## EntityExternal\.Target Property + +Цель внешней ссылки\. + +```csharp +public Pf2eModel.Model.Base.Targets.ExternalTarget Target { get; set; } +``` + +#### Property Value +[ExternalTarget](ExternalTarget.md 'Pf2eModel\.Model\.Base\.Targets\.ExternalTarget') \ No newline at end of file diff --git a/Documentation/Pf2eModel/EntityExternal.TargetId.md b/Documentation/Pf2eModel/EntityExternal.TargetId.md new file mode 100644 index 0000000..28a91d9 --- /dev/null +++ b/Documentation/Pf2eModel/EntityExternal.TargetId.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Base\.Targets](Pf2eModel.Model.Base.Targets.md 'Pf2eModel\.Model\.Base\.Targets').[EntityExternal](EntityExternal.md 'Pf2eModel\.Model\.Base\.Targets\.EntityExternal') + +## EntityExternal\.TargetId Property + +Идентификатор цели\. + +```csharp +public int TargetId { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/EntityExternal.md b/Documentation/Pf2eModel/EntityExternal.md new file mode 100644 index 0000000..d79a5ca --- /dev/null +++ b/Documentation/Pf2eModel/EntityExternal.md @@ -0,0 +1,22 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Base\.Targets](Pf2eModel.Model.Base.Targets.md 'Pf2eModel\.Model\.Base\.Targets') + +## EntityExternal Class + +Внешняя ссылка сущности\. + +```csharp +public class EntityExternal +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 EntityExternal + +| Properties | | +| :--- | :--- | +| [Entity](EntityExternal.Entity.md 'Pf2eModel\.Model\.Base\.Targets\.EntityExternal\.Entity') | Сущность, которая ссылается на внешнюю ссылку\. | +| [EntityId](EntityExternal.EntityId.md 'Pf2eModel\.Model\.Base\.Targets\.EntityExternal\.EntityId') | Идентификатор сущности\. | +| [ExternalId](EntityExternal.ExternalId.md 'Pf2eModel\.Model\.Base\.Targets\.EntityExternal\.ExternalId') | Идентификатор элемента по ссылке\. | +| [Md5](EntityExternal.Md5.md 'Pf2eModel\.Model\.Base\.Targets\.EntityExternal\.Md5') | Контрольная сумма объекта\. | +| [Suffix](EntityExternal.Suffix.md 'Pf2eModel\.Model\.Base\.Targets\.EntityExternal\.Suffix') | Конечная часть URL внешней ссылки\. Для источников Foundry \- полный UUID объекта\. | +| [Target](EntityExternal.Target.md 'Pf2eModel\.Model\.Base\.Targets\.EntityExternal\.Target') | Цель внешней ссылки\. | +| [TargetId](EntityExternal.TargetId.md 'Pf2eModel\.Model\.Base\.Targets\.EntityExternal\.TargetId') | Идентификатор цели\. | diff --git a/Documentation/Pf2eModel/EntityOfTypeAttribute.EntityOfTypeAttribute(EntityType).md b/Documentation/Pf2eModel/EntityOfTypeAttribute.EntityOfTypeAttribute(EntityType).md new file mode 100644 index 0000000..f0d3df3 --- /dev/null +++ b/Documentation/Pf2eModel/EntityOfTypeAttribute.EntityOfTypeAttribute(EntityType).md @@ -0,0 +1,17 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel](Pf2eModel.md 'Pf2eModel').[EntityOfTypeAttribute](EntityOfTypeAttribute.md 'Pf2eModel\.EntityOfTypeAttribute') + +## EntityOfTypeAttribute\(EntityType\) Constructor + +Аттрибут, указывающий тип сущности\. + +```csharp +public EntityOfTypeAttribute(Pf2eModel.Model.Enum.EntityType type); +``` +#### Parameters + + + +`type` [EntityType](EntityType.md 'Pf2eModel\.Model\.Enum\.EntityType') + +Тип сущности\. \ No newline at end of file diff --git a/Documentation/Pf2eModel/EntityOfTypeAttribute.Resolve(Entity).md b/Documentation/Pf2eModel/EntityOfTypeAttribute.Resolve(Entity).md new file mode 100644 index 0000000..c88eb64 --- /dev/null +++ b/Documentation/Pf2eModel/EntityOfTypeAttribute.Resolve(Entity).md @@ -0,0 +1,29 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel](Pf2eModel.md 'Pf2eModel').[EntityOfTypeAttribute](EntityOfTypeAttribute.md 'Pf2eModel\.EntityOfTypeAttribute') + +## EntityOfTypeAttribute\.Resolve\(Entity\) Method + +Метод для получения программного типа сущности по её типу\. + +```csharp +public static System.Type Resolve(Pf2eModel.Model.Base.Entity entity); +``` +#### Parameters + + + +`entity` [Entity](Entity.md 'Pf2eModel\.Model\.Base\.Entity') + +Тип сущности\. + +#### Returns +[System\.Type](https://docs.microsoft.com/en-us/dotnet/api/System.Type 'System\.Type') +Программный тип сущности\. + +#### Exceptions + +[System\.Exception](https://docs.microsoft.com/en-us/dotnet/api/System.Exception 'System\.Exception') +Если есть ошибка в структурах\. + +[System\.ComponentModel\.InvalidEnumArgumentException](https://docs.microsoft.com/en-us/dotnet/api/System.ComponentModel.InvalidEnumArgumentException 'System\.ComponentModel\.InvalidEnumArgumentException') +Тип сущности\. \ No newline at end of file diff --git a/Documentation/Pf2eModel/EntityOfTypeAttribute.Type.md b/Documentation/Pf2eModel/EntityOfTypeAttribute.Type.md new file mode 100644 index 0000000..72d1bc6 --- /dev/null +++ b/Documentation/Pf2eModel/EntityOfTypeAttribute.Type.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel](Pf2eModel.md 'Pf2eModel').[EntityOfTypeAttribute](EntityOfTypeAttribute.md 'Pf2eModel\.EntityOfTypeAttribute') + +## EntityOfTypeAttribute\.Type Property + +Тип сущности\. + +```csharp +public Pf2eModel.Model.Enum.EntityType Type { get; } +``` + +#### Property Value +[EntityType](EntityType.md 'Pf2eModel\.Model\.Enum\.EntityType') \ No newline at end of file diff --git a/Documentation/Pf2eModel/EntityOfTypeAttribute.md b/Documentation/Pf2eModel/EntityOfTypeAttribute.md new file mode 100644 index 0000000..a2ed6c4 --- /dev/null +++ b/Documentation/Pf2eModel/EntityOfTypeAttribute.md @@ -0,0 +1,24 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel](Pf2eModel.md 'Pf2eModel') + +## EntityOfTypeAttribute Class + +Аттрибут, указывающий тип сущности\. + +```csharp +public class EntityOfTypeAttribute : System.Attribute +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [System\.Attribute](https://docs.microsoft.com/en-us/dotnet/api/System.Attribute 'System\.Attribute') 🡒 EntityOfTypeAttribute + +| Constructors | | +| :--- | :--- | +| [EntityOfTypeAttribute\(EntityType\)](EntityOfTypeAttribute.EntityOfTypeAttribute(EntityType).md 'Pf2eModel\.EntityOfTypeAttribute\.EntityOfTypeAttribute\(Pf2eModel\.Model\.Enum\.EntityType\)') | Аттрибут, указывающий тип сущности\. | + +| Properties | | +| :--- | :--- | +| [Type](EntityOfTypeAttribute.Type.md 'Pf2eModel\.EntityOfTypeAttribute\.Type') | Тип сущности\. | + +| Methods | | +| :--- | :--- | +| [Resolve\(Entity\)](EntityOfTypeAttribute.Resolve(Entity).md 'Pf2eModel\.EntityOfTypeAttribute\.Resolve\(Pf2eModel\.Model\.Base\.Entity\)') | Метод для получения программного типа сущности по её типу\. | diff --git a/Documentation/Pf2eModel/EntityRarity.md b/Documentation/Pf2eModel/EntityRarity.md new file mode 100644 index 0000000..527ca2f --- /dev/null +++ b/Documentation/Pf2eModel/EntityRarity.md @@ -0,0 +1,35 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Enum](Pf2eModel.Model.Enum.md 'Pf2eModel\.Model\.Enum') + +## EntityRarity Enum + +Перечисление редкости сущности\. + +```csharp +public enum EntityRarity +``` +### Fields + + + +`Common` 0 + +Обычная редкость\. + + + +`Uncommon` 1 + +Необычная редкость\. + + + +`Rare` 2 + +Редкая редкость\. + + + +`Unique` 3 + +Уникальная редкость\. \ No newline at end of file diff --git a/Documentation/Pf2eModel/EntitySource.Entity.md b/Documentation/Pf2eModel/EntitySource.Entity.md new file mode 100644 index 0000000..539b53c --- /dev/null +++ b/Documentation/Pf2eModel/EntitySource.Entity.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Base\.Source](Pf2eModel.Model.Base.Source.md 'Pf2eModel\.Model\.Base\.Source').[EntitySource](EntitySource.md 'Pf2eModel\.Model\.Base\.Source\.EntitySource') + +## EntitySource\.Entity Property + +Сущность, к которой относится источник\. + +```csharp +public Pf2eModel.Model.Base.Entity Entity { get; set; } +``` + +#### Property Value +[Entity](Entity.md 'Pf2eModel\.Model\.Base\.Entity') \ No newline at end of file diff --git a/Documentation/Pf2eModel/EntitySource.EntityId.md b/Documentation/Pf2eModel/EntitySource.EntityId.md new file mode 100644 index 0000000..f9c6143 --- /dev/null +++ b/Documentation/Pf2eModel/EntitySource.EntityId.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Base\.Source](Pf2eModel.Model.Base.Source.md 'Pf2eModel\.Model\.Base\.Source').[EntitySource](EntitySource.md 'Pf2eModel\.Model\.Base\.Source\.EntitySource') + +## EntitySource\.EntityId Property + +Идентификатор сущности\. + +```csharp +public int EntityId { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/EntitySource.Id.md b/Documentation/Pf2eModel/EntitySource.Id.md new file mode 100644 index 0000000..4ca7028 --- /dev/null +++ b/Documentation/Pf2eModel/EntitySource.Id.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Base\.Source](Pf2eModel.Model.Base.Source.md 'Pf2eModel\.Model\.Base\.Source').[EntitySource](EntitySource.md 'Pf2eModel\.Model\.Base\.Source\.EntitySource') + +## EntitySource\.Id Property + +Идентификатор связи\. + +```csharp +public int Id { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/EntitySource.IsRemaster.md b/Documentation/Pf2eModel/EntitySource.IsRemaster.md new file mode 100644 index 0000000..b9ee85f --- /dev/null +++ b/Documentation/Pf2eModel/EntitySource.IsRemaster.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Base\.Source](Pf2eModel.Model.Base.Source.md 'Pf2eModel\.Model\.Base\.Source').[EntitySource](EntitySource.md 'Pf2eModel\.Model\.Base\.Source\.EntitySource') + +## EntitySource\.IsRemaster Property + +Флаг, указывающий, что объект является частью ремастера\. + +```csharp +public bool IsRemaster { get; set; } +``` + +#### Property Value +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') \ No newline at end of file diff --git a/Documentation/Pf2eModel/EntitySource.Source.md b/Documentation/Pf2eModel/EntitySource.Source.md new file mode 100644 index 0000000..30546ce --- /dev/null +++ b/Documentation/Pf2eModel/EntitySource.Source.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Base\.Source](Pf2eModel.Model.Base.Source.md 'Pf2eModel\.Model\.Base\.Source').[EntitySource](EntitySource.md 'Pf2eModel\.Model\.Base\.Source\.EntitySource') + +## EntitySource\.Source Property + +Источник, к которому относится сущность\. + +```csharp +public Pf2eModel.Model.Base.Source.Source Source { get; set; } +``` + +#### Property Value +[Source](Source.md 'Pf2eModel\.Model\.Base\.Source\.Source') \ No newline at end of file diff --git a/Documentation/Pf2eModel/EntitySource.SourceId.md b/Documentation/Pf2eModel/EntitySource.SourceId.md new file mode 100644 index 0000000..33da3bc --- /dev/null +++ b/Documentation/Pf2eModel/EntitySource.SourceId.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Base\.Source](Pf2eModel.Model.Base.Source.md 'Pf2eModel\.Model\.Base\.Source').[EntitySource](EntitySource.md 'Pf2eModel\.Model\.Base\.Source\.EntitySource') + +## EntitySource\.SourceId Property + +Идентификатор источника\. + +```csharp +public int SourceId { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/EntitySource.Suffix.md b/Documentation/Pf2eModel/EntitySource.Suffix.md new file mode 100644 index 0000000..acd4060 --- /dev/null +++ b/Documentation/Pf2eModel/EntitySource.Suffix.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Base\.Source](Pf2eModel.Model.Base.Source.md 'Pf2eModel\.Model\.Base\.Source').[EntitySource](EntitySource.md 'Pf2eModel\.Model\.Base\.Source\.EntitySource') + +## EntitySource\.Suffix Property + +Дополнительная информация о источнике, например, номер страницы, номер тома и т\.д\. + +```csharp +public string Suffix { get; set; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eModel/EntitySource.md b/Documentation/Pf2eModel/EntitySource.md new file mode 100644 index 0000000..90fef51 --- /dev/null +++ b/Documentation/Pf2eModel/EntitySource.md @@ -0,0 +1,22 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Base\.Source](Pf2eModel.Model.Base.Source.md 'Pf2eModel\.Model\.Base\.Source') + +## EntitySource Class + +Связь между сущностью и источником\. + +```csharp +public class EntitySource +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 EntitySource + +| Properties | | +| :--- | :--- | +| [Entity](EntitySource.Entity.md 'Pf2eModel\.Model\.Base\.Source\.EntitySource\.Entity') | Сущность, к которой относится источник\. | +| [EntityId](EntitySource.EntityId.md 'Pf2eModel\.Model\.Base\.Source\.EntitySource\.EntityId') | Идентификатор сущности\. | +| [Id](EntitySource.Id.md 'Pf2eModel\.Model\.Base\.Source\.EntitySource\.Id') | Идентификатор связи\. | +| [IsRemaster](EntitySource.IsRemaster.md 'Pf2eModel\.Model\.Base\.Source\.EntitySource\.IsRemaster') | Флаг, указывающий, что объект является частью ремастера\. | +| [Source](EntitySource.Source.md 'Pf2eModel\.Model\.Base\.Source\.EntitySource\.Source') | Источник, к которому относится сущность\. | +| [SourceId](EntitySource.SourceId.md 'Pf2eModel\.Model\.Base\.Source\.EntitySource\.SourceId') | Идентификатор источника\. | +| [Suffix](EntitySource.Suffix.md 'Pf2eModel\.Model\.Base\.Source\.EntitySource\.Suffix') | Дополнительная информация о источнике, например, номер страницы, номер тома и т\.д\. | diff --git a/Documentation/Pf2eModel/EntityType.md b/Documentation/Pf2eModel/EntityType.md new file mode 100644 index 0000000..e2fc266 --- /dev/null +++ b/Documentation/Pf2eModel/EntityType.md @@ -0,0 +1,125 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Enum](Pf2eModel.Model.Enum.md 'Pf2eModel\.Model\.Enum') + +## EntityType Enum + +Тип сущности\. + +```csharp +public enum EntityType +``` +### Fields + + + +`Unknown` 0 + +Неизвестный тип сущности\. + + + +`Trait` 1 + +Признак\. + + + +`Action` 2 + +Действие\. + + + +`Ancestry` 3 + +Родословная\. + + + +`Archetype` 4 + +Архетип\. + + + +`Background` 5 + +Происхождение\. + + + +`Backpack` 6 + +Рюкзак\. + + + +`CampaignFeature` 7 + +Способность кампании\. + + + +`Class` 8 + +Класс\. + + + +`SubclassGroup` 9 + +Группа подклассов\. + + + +`Subclass` 10 + +Подкласс\. + + + +`Condition` 11 + +Состояние\. + + + +`Deity` 12 + +Божество\. + + + +`Feat` 13 + +Навык\. + + + +`Heritage` 14 + +Наследие\. + + + +`Spell` 15 + +Заклианиние\. + + + +`Ritual` 16 + +Ритуал\. + + + +`Language` 17 + +Язык\. + + + +`Rule` 18 + +Правило\. \ No newline at end of file diff --git a/Documentation/Pf2eModel/ExternalTarget.EntityExternals.md b/Documentation/Pf2eModel/ExternalTarget.EntityExternals.md new file mode 100644 index 0000000..a1e44d5 --- /dev/null +++ b/Documentation/Pf2eModel/ExternalTarget.EntityExternals.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Base\.Targets](Pf2eModel.Model.Base.Targets.md 'Pf2eModel\.Model\.Base\.Targets').[ExternalTarget](ExternalTarget.md 'Pf2eModel\.Model\.Base\.Targets\.ExternalTarget') + +## ExternalTarget\.EntityExternals Property + +Коллекция сущностей, которые ссылаются на эту цель\. + +```csharp +public System.Collections.Generic.ICollection EntityExternals { get; set; } +``` + +#### Property Value +[System\.Collections\.Generic\.ICollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1')[EntityExternal](EntityExternal.md 'Pf2eModel\.Model\.Base\.Targets\.EntityExternal')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1') \ No newline at end of file diff --git a/Documentation/Pf2eModel/ExternalTarget.Icon.md b/Documentation/Pf2eModel/ExternalTarget.Icon.md new file mode 100644 index 0000000..02f1071 --- /dev/null +++ b/Documentation/Pf2eModel/ExternalTarget.Icon.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Base\.Targets](Pf2eModel.Model.Base.Targets.md 'Pf2eModel\.Model\.Base\.Targets').[ExternalTarget](ExternalTarget.md 'Pf2eModel\.Model\.Base\.Targets\.ExternalTarget') + +## ExternalTarget\.Icon Property + +Иконка цели\. + +```csharp +public string Icon { get; set; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eModel/ExternalTarget.Id.md b/Documentation/Pf2eModel/ExternalTarget.Id.md new file mode 100644 index 0000000..a13ece6 --- /dev/null +++ b/Documentation/Pf2eModel/ExternalTarget.Id.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Base\.Targets](Pf2eModel.Model.Base.Targets.md 'Pf2eModel\.Model\.Base\.Targets').[ExternalTarget](ExternalTarget.md 'Pf2eModel\.Model\.Base\.Targets\.ExternalTarget') + +## ExternalTarget\.Id Property + +Идентификатор цели\. + +```csharp +public int Id { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/ExternalTarget.Name.md b/Documentation/Pf2eModel/ExternalTarget.Name.md new file mode 100644 index 0000000..1455533 --- /dev/null +++ b/Documentation/Pf2eModel/ExternalTarget.Name.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Base\.Targets](Pf2eModel.Model.Base.Targets.md 'Pf2eModel\.Model\.Base\.Targets').[ExternalTarget](ExternalTarget.md 'Pf2eModel\.Model\.Base\.Targets\.ExternalTarget') + +## ExternalTarget\.Name Property + +Название цели\. + +```csharp +public string Name { get; set; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eModel/ExternalTarget.Prefix.md b/Documentation/Pf2eModel/ExternalTarget.Prefix.md new file mode 100644 index 0000000..560f151 --- /dev/null +++ b/Documentation/Pf2eModel/ExternalTarget.Prefix.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Base\.Targets](Pf2eModel.Model.Base.Targets.md 'Pf2eModel\.Model\.Base\.Targets').[ExternalTarget](ExternalTarget.md 'Pf2eModel\.Model\.Base\.Targets\.ExternalTarget') + +## ExternalTarget\.Prefix Property + +Префикс для URL\-адреса внешней ссылки\. + +```csharp +public string Prefix { get; set; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eModel/ExternalTarget.md b/Documentation/Pf2eModel/ExternalTarget.md new file mode 100644 index 0000000..69d0627 --- /dev/null +++ b/Documentation/Pf2eModel/ExternalTarget.md @@ -0,0 +1,20 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Base\.Targets](Pf2eModel.Model.Base.Targets.md 'Pf2eModel\.Model\.Base\.Targets') + +## ExternalTarget Class + +Цель внешней ссылки\. + +```csharp +public class ExternalTarget +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 ExternalTarget + +| Properties | | +| :--- | :--- | +| [EntityExternals](ExternalTarget.EntityExternals.md 'Pf2eModel\.Model\.Base\.Targets\.ExternalTarget\.EntityExternals') | Коллекция сущностей, которые ссылаются на эту цель\. | +| [Icon](ExternalTarget.Icon.md 'Pf2eModel\.Model\.Base\.Targets\.ExternalTarget\.Icon') | Иконка цели\. | +| [Id](ExternalTarget.Id.md 'Pf2eModel\.Model\.Base\.Targets\.ExternalTarget\.Id') | Идентификатор цели\. | +| [Name](ExternalTarget.Name.md 'Pf2eModel\.Model\.Base\.Targets\.ExternalTarget\.Name') | Название цели\. | +| [Prefix](ExternalTarget.Prefix.md 'Pf2eModel\.Model\.Base\.Targets\.ExternalTarget\.Prefix') | Префикс для URL\-адреса внешней ссылки\. | diff --git a/Documentation/Pf2eModel/Feat.Actions.md b/Documentation/Pf2eModel/Feat.Actions.md new file mode 100644 index 0000000..3cd3097 --- /dev/null +++ b/Documentation/Pf2eModel/Feat.Actions.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Feat](Feat.md 'Pf2eModel\.Model\.Structure\.Feat') + +## Feat\.Actions Property + +Количество действий, необходимых для применения фита\. + +```csharp +public Pf2eModel.Model.Enum.ActionEnum Actions { get; set; } +``` + +#### Property Value +[ActionEnum](ActionEnum.md 'Pf2eModel\.Model\.Enum\.ActionEnum') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Feat.Archetypes.md b/Documentation/Pf2eModel/Feat.Archetypes.md new file mode 100644 index 0000000..c255665 --- /dev/null +++ b/Documentation/Pf2eModel/Feat.Archetypes.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Feat](Feat.md 'Pf2eModel\.Model\.Structure\.Feat') + +## Feat\.Archetypes Property + +Архетипы, которые могут использовать эту способность\. + +```csharp +public System.Collections.Generic.ICollection Archetypes { get; set; } +``` + +#### Property Value +[System\.Collections\.Generic\.ICollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1')[Archetype](Archetype.md 'Pf2eModel\.Model\.Structure\.Archetype')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Feat.Category.md b/Documentation/Pf2eModel/Feat.Category.md new file mode 100644 index 0000000..6581bcb --- /dev/null +++ b/Documentation/Pf2eModel/Feat.Category.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Feat](Feat.md 'Pf2eModel\.Model\.Structure\.Feat') + +## Feat\.Category Property + +Категория способности\. + +```csharp +public Pf2eModel.Model.Enum.FeatCategory Category { get; set; } +``` + +#### Property Value +[FeatCategory](FeatCategory.md 'Pf2eModel\.Model\.Enum\.FeatCategory') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Feat.Entity.md b/Documentation/Pf2eModel/Feat.Entity.md new file mode 100644 index 0000000..0c482b2 --- /dev/null +++ b/Documentation/Pf2eModel/Feat.Entity.md @@ -0,0 +1,15 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Feat](Feat.md 'Pf2eModel\.Model\.Structure\.Feat') + +## Feat\.Entity Property + +Корневая сущность\. + +```csharp +public Pf2eModel.Model.Base.Entity Entity { get; set; } +``` + +Implements [Entity](IEntity.Entity.md 'Pf2eModel\.Model\.IEntity\.Entity') + +#### Property Value +[Entity](Entity.md 'Pf2eModel\.Model\.Base\.Entity') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Feat.Extra.md b/Documentation/Pf2eModel/Feat.Extra.md new file mode 100644 index 0000000..2637ea2 --- /dev/null +++ b/Documentation/Pf2eModel/Feat.Extra.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Feat](Feat.md 'Pf2eModel\.Model\.Structure\.Feat') + +## Feat\.Extra Property + +Дополнительная информация\. + +```csharp +public string? Extra { get; set; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Feat.FeatPrerequisites.md b/Documentation/Pf2eModel/Feat.FeatPrerequisites.md new file mode 100644 index 0000000..ea4cc40 --- /dev/null +++ b/Documentation/Pf2eModel/Feat.FeatPrerequisites.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Feat](Feat.md 'Pf2eModel\.Model\.Structure\.Feat') + +## Feat\.FeatPrerequisites Property + +Требования к получению способности\. + +```csharp +public System.Collections.Generic.ICollection FeatPrerequisites { get; set; } +``` + +#### Property Value +[System\.Collections\.Generic\.ICollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1')[FeatPrerequisite](FeatPrerequisite.md 'Pf2eModel\.Model\.Structure\.FeatRelation\.FeatPrerequisite')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Feat.Id.md b/Documentation/Pf2eModel/Feat.Id.md new file mode 100644 index 0000000..9f2684a --- /dev/null +++ b/Documentation/Pf2eModel/Feat.Id.md @@ -0,0 +1,15 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Feat](Feat.md 'Pf2eModel\.Model\.Structure\.Feat') + +## Feat\.Id Property + +Идентификатор сущности\. + +```csharp +public int Id { get; set; } +``` + +Implements [Id](IEntity.Id.md 'Pf2eModel\.Model\.IEntity\.Id') + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Feat.Level.md b/Documentation/Pf2eModel/Feat.Level.md new file mode 100644 index 0000000..57baeaf --- /dev/null +++ b/Documentation/Pf2eModel/Feat.Level.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Feat](Feat.md 'Pf2eModel\.Model\.Structure\.Feat') + +## Feat\.Level Property + +Уровень способности\. + +```csharp +public int Level { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Feat.md b/Documentation/Pf2eModel/Feat.md new file mode 100644 index 0000000..50fc59e --- /dev/null +++ b/Documentation/Pf2eModel/Feat.md @@ -0,0 +1,25 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure') + +## Feat Class + +Способность\. + +```csharp +public class Feat : Pf2eModel.Model.IEntity +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 Feat + +Implements [IEntity](IEntity.md 'Pf2eModel\.Model\.IEntity') + +| Properties | | +| :--- | :--- | +| [Actions](Feat.Actions.md 'Pf2eModel\.Model\.Structure\.Feat\.Actions') | Количество действий, необходимых для применения фита\. | +| [Archetypes](Feat.Archetypes.md 'Pf2eModel\.Model\.Structure\.Feat\.Archetypes') | Архетипы, которые могут использовать эту способность\. | +| [Category](Feat.Category.md 'Pf2eModel\.Model\.Structure\.Feat\.Category') | Категория способности\. | +| [Entity](Feat.Entity.md 'Pf2eModel\.Model\.Structure\.Feat\.Entity') | Корневая сущность\. | +| [Extra](Feat.Extra.md 'Pf2eModel\.Model\.Structure\.Feat\.Extra') | Дополнительная информация\. | +| [FeatPrerequisites](Feat.FeatPrerequisites.md 'Pf2eModel\.Model\.Structure\.Feat\.FeatPrerequisites') | Требования к получению способности\. | +| [Id](Feat.Id.md 'Pf2eModel\.Model\.Structure\.Feat\.Id') | Идентификатор сущности\. | +| [Level](Feat.Level.md 'Pf2eModel\.Model\.Structure\.Feat\.Level') | Уровень способности\. | diff --git a/Documentation/Pf2eModel/FeatCategory.md b/Documentation/Pf2eModel/FeatCategory.md new file mode 100644 index 0000000..e9d05fc --- /dev/null +++ b/Documentation/Pf2eModel/FeatCategory.md @@ -0,0 +1,95 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Enum](Pf2eModel.Model.Enum.md 'Pf2eModel\.Model\.Enum') + +## FeatCategory Enum + +Категория черты\. + +```csharp +public enum FeatCategory +``` +### Fields + + + +`Uncategorized` 0 + +Черта, которая не относится ни к одной из категорий\. + + + +`Ancestry` 1 + +Черта наследия\. Возможная коллизия между [Ancestry](FeatCategory.md#Pf2eModel.Model.Enum.FeatCategory.Ancestry 'Pf2eModel\.Model\.Enum\.FeatCategory\.Ancestry') и [AncestryFeature](FeatCategory.md#Pf2eModel.Model.Enum.FeatCategory.AncestryFeature 'Pf2eModel\.Model\.Enum\.FeatCategory\.AncestryFeature')\. + + + +`AncestryFeature` 2 + +Черта наследия\. Возможная коллизия между [Ancestry](FeatCategory.md#Pf2eModel.Model.Enum.FeatCategory.Ancestry 'Pf2eModel\.Model\.Enum\.FeatCategory\.Ancestry') и [AncestryFeature](FeatCategory.md#Pf2eModel.Model.Enum.FeatCategory.AncestryFeature 'Pf2eModel\.Model\.Enum\.FeatCategory\.AncestryFeature')\. + + + +`Archetype` 3 + +Черта архетипа\. + + + +`Calling` 4 + +Черта мифического призвания\. + + + +`Class` 5 + +Черта класса\. Возможная коллизия между [ClassFeature](FeatCategory.md#Pf2eModel.Model.Enum.FeatCategory.ClassFeature 'Pf2eModel\.Model\.Enum\.FeatCategory\.ClassFeature') и [Class](FeatCategory.md#Pf2eModel.Model.Enum.FeatCategory.Class 'Pf2eModel\.Model\.Enum\.FeatCategory\.Class')\. + + + +`ClassFeature` 6 + +Черта класса\. Возможная коллизия между [Class](FeatCategory.md#Pf2eModel.Model.Enum.FeatCategory.Class 'Pf2eModel\.Model\.Enum\.FeatCategory\.Class') и [ClassFeature](FeatCategory.md#Pf2eModel.Model.Enum.FeatCategory.ClassFeature 'Pf2eModel\.Model\.Enum\.FeatCategory\.ClassFeature')\. + + + +`Skill` 7 + +Черта навыка\. + + + +`General` 8 + +Общая черта\. + + + +`Bonus` 9 + +Бонусная черта\. + + + +`Deityboon` 10 + +Божественный дар\. + + + +`Curse` 11 + +Проклятие\. + + + +`Pfsboon` 12 + +Дар сообщества Pathfinder Society\. + + + +`CampaignFeature` 13 + +Черта кампании\. \ No newline at end of file diff --git a/Documentation/Pf2eModel/FeatPrerequisite.Feat.md b/Documentation/Pf2eModel/FeatPrerequisite.Feat.md new file mode 100644 index 0000000..ca6df89 --- /dev/null +++ b/Documentation/Pf2eModel/FeatPrerequisite.Feat.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.FeatRelation](Pf2eModel.Model.Structure.FeatRelation.md 'Pf2eModel\.Model\.Structure\.FeatRelation').[FeatPrerequisite](FeatPrerequisite.md 'Pf2eModel\.Model\.Structure\.FeatRelation\.FeatPrerequisite') + +## FeatPrerequisite\.Feat Property + +Черта, к которой относится предварительное требование\. + +```csharp +public virtual Pf2eModel.Model.Structure.Feat Feat { get; set; } +``` + +#### Property Value +[Feat](Feat.md 'Pf2eModel\.Model\.Structure\.Feat') \ No newline at end of file diff --git a/Documentation/Pf2eModel/FeatPrerequisite.FeatId.md b/Documentation/Pf2eModel/FeatPrerequisite.FeatId.md new file mode 100644 index 0000000..8de1937 --- /dev/null +++ b/Documentation/Pf2eModel/FeatPrerequisite.FeatId.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.FeatRelation](Pf2eModel.Model.Structure.FeatRelation.md 'Pf2eModel\.Model\.Structure\.FeatRelation').[FeatPrerequisite](FeatPrerequisite.md 'Pf2eModel\.Model\.Structure\.FeatRelation\.FeatPrerequisite') + +## FeatPrerequisite\.FeatId Property + +Идентификатор черты, к которой относится предварительное требование\. + +```csharp +public int FeatId { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/FeatPrerequisite.Id.md b/Documentation/Pf2eModel/FeatPrerequisite.Id.md new file mode 100644 index 0000000..3bcc899 --- /dev/null +++ b/Documentation/Pf2eModel/FeatPrerequisite.Id.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.FeatRelation](Pf2eModel.Model.Structure.FeatRelation.md 'Pf2eModel\.Model\.Structure\.FeatRelation').[FeatPrerequisite](FeatPrerequisite.md 'Pf2eModel\.Model\.Structure\.FeatRelation\.FeatPrerequisite') + +## FeatPrerequisite\.Id Property + +Идентификатор предварительного требования для чериы\. + +```csharp +public int Id { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/FeatPrerequisite.Value.md b/Documentation/Pf2eModel/FeatPrerequisite.Value.md new file mode 100644 index 0000000..139e54d --- /dev/null +++ b/Documentation/Pf2eModel/FeatPrerequisite.Value.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.FeatRelation](Pf2eModel.Model.Structure.FeatRelation.md 'Pf2eModel\.Model\.Structure\.FeatRelation').[FeatPrerequisite](FeatPrerequisite.md 'Pf2eModel\.Model\.Structure\.FeatRelation\.FeatPrerequisite') + +## FeatPrerequisite\.Value Property + +Предварительное требование для черты\. + +```csharp +public string Value { get; set; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eModel/FeatPrerequisite.md b/Documentation/Pf2eModel/FeatPrerequisite.md new file mode 100644 index 0000000..33adedc --- /dev/null +++ b/Documentation/Pf2eModel/FeatPrerequisite.md @@ -0,0 +1,19 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.FeatRelation](Pf2eModel.Model.Structure.FeatRelation.md 'Pf2eModel\.Model\.Structure\.FeatRelation') + +## FeatPrerequisite Class + +Предварительное требование для черты\. + +```csharp +public class FeatPrerequisite +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 FeatPrerequisite + +| Properties | | +| :--- | :--- | +| [Feat](FeatPrerequisite.Feat.md 'Pf2eModel\.Model\.Structure\.FeatRelation\.FeatPrerequisite\.Feat') | Черта, к которой относится предварительное требование\. | +| [FeatId](FeatPrerequisite.FeatId.md 'Pf2eModel\.Model\.Structure\.FeatRelation\.FeatPrerequisite\.FeatId') | Идентификатор черты, к которой относится предварительное требование\. | +| [Id](FeatPrerequisite.Id.md 'Pf2eModel\.Model\.Structure\.FeatRelation\.FeatPrerequisite\.Id') | Идентификатор предварительного требования для чериы\. | +| [Value](FeatPrerequisite.Value.md 'Pf2eModel\.Model\.Structure\.FeatRelation\.FeatPrerequisite\.Value') | Предварительное требование для черты\. | diff --git a/Documentation/Pf2eModel/Frequency.Id.md b/Documentation/Pf2eModel/Frequency.Id.md new file mode 100644 index 0000000..d99cc9b --- /dev/null +++ b/Documentation/Pf2eModel/Frequency.Id.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Common](Pf2eModel.Model.Common.md 'Pf2eModel\.Model\.Common').[Frequency](Frequency.md 'Pf2eModel\.Model\.Common\.Frequency') + +## Frequency\.Id Property + +Идентификатор\. + +```csharp +public int Id { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Frequency.Max.md b/Documentation/Pf2eModel/Frequency.Max.md new file mode 100644 index 0000000..91f819b --- /dev/null +++ b/Documentation/Pf2eModel/Frequency.Max.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Common](Pf2eModel.Model.Common.md 'Pf2eModel\.Model\.Common').[Frequency](Frequency.md 'Pf2eModel\.Model\.Common\.Frequency') + +## Frequency\.Max Property + +Максимальная продолжительсность\. + +```csharp +public int Max { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Frequency.Per.md b/Documentation/Pf2eModel/Frequency.Per.md new file mode 100644 index 0000000..f7f0fec --- /dev/null +++ b/Documentation/Pf2eModel/Frequency.Per.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Common](Pf2eModel.Model.Common.md 'Pf2eModel\.Model\.Common').[Frequency](Frequency.md 'Pf2eModel\.Model\.Common\.Frequency') + +## Frequency\.Per Property + +Частота использования\. + +```csharp +public int Per { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Frequency.Value.md b/Documentation/Pf2eModel/Frequency.Value.md new file mode 100644 index 0000000..17d433e --- /dev/null +++ b/Documentation/Pf2eModel/Frequency.Value.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Common](Pf2eModel.Model.Common.md 'Pf2eModel\.Model\.Common').[Frequency](Frequency.md 'Pf2eModel\.Model\.Common\.Frequency') + +## Frequency\.Value Property + +Значение использования\. + +```csharp +public System.Nullable Value { get; set; } +``` + +#### Property Value +[System\.Nullable<](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System\.Nullable\`1')[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System\.Nullable\`1') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Frequency.md b/Documentation/Pf2eModel/Frequency.md new file mode 100644 index 0000000..81cf428 --- /dev/null +++ b/Documentation/Pf2eModel/Frequency.md @@ -0,0 +1,19 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Common](Pf2eModel.Model.Common.md 'Pf2eModel\.Model\.Common') + +## Frequency Class + +Частота использования\. + +```csharp +public class Frequency +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 Frequency + +| Properties | | +| :--- | :--- | +| [Id](Frequency.Id.md 'Pf2eModel\.Model\.Common\.Frequency\.Id') | Идентификатор\. | +| [Max](Frequency.Max.md 'Pf2eModel\.Model\.Common\.Frequency\.Max') | Максимальная продолжительсность\. | +| [Per](Frequency.Per.md 'Pf2eModel\.Model\.Common\.Frequency\.Per') | Частота использования\. | +| [Value](Frequency.Value.md 'Pf2eModel\.Model\.Common\.Frequency\.Value') | Значение использования\. | diff --git a/Documentation/Pf2eModel/Heritage.Ancestry.md b/Documentation/Pf2eModel/Heritage.Ancestry.md new file mode 100644 index 0000000..ba704b7 --- /dev/null +++ b/Documentation/Pf2eModel/Heritage.Ancestry.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Heritage](Heritage.md 'Pf2eModel\.Model\.Structure\.Heritage') + +## Heritage\.Ancestry Property + +Родословная\. + +```csharp +public Pf2eModel.Model.Structure.Ancestry? Ancestry { get; set; } +``` + +#### Property Value +[Ancestry](Ancestry.md 'Pf2eModel\.Model\.Structure\.Ancestry') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Heritage.AncestryId.md b/Documentation/Pf2eModel/Heritage.AncestryId.md new file mode 100644 index 0000000..31b3719 --- /dev/null +++ b/Documentation/Pf2eModel/Heritage.AncestryId.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Heritage](Heritage.md 'Pf2eModel\.Model\.Structure\.Heritage') + +## Heritage\.AncestryId Property + +Идентификатор родословной\. + +```csharp +public System.Nullable AncestryId { get; set; } +``` + +#### Property Value +[System\.Nullable<](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System\.Nullable\`1')[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System\.Nullable\`1') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Heritage.Entity.md b/Documentation/Pf2eModel/Heritage.Entity.md new file mode 100644 index 0000000..f6466ab --- /dev/null +++ b/Documentation/Pf2eModel/Heritage.Entity.md @@ -0,0 +1,15 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Heritage](Heritage.md 'Pf2eModel\.Model\.Structure\.Heritage') + +## Heritage\.Entity Property + +Корневая сущность\. + +```csharp +public Pf2eModel.Model.Base.Entity Entity { get; set; } +``` + +Implements [Entity](IEntity.Entity.md 'Pf2eModel\.Model\.IEntity\.Entity') + +#### Property Value +[Entity](Entity.md 'Pf2eModel\.Model\.Base\.Entity') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Heritage.Id.md b/Documentation/Pf2eModel/Heritage.Id.md new file mode 100644 index 0000000..9d6b772 --- /dev/null +++ b/Documentation/Pf2eModel/Heritage.Id.md @@ -0,0 +1,15 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Heritage](Heritage.md 'Pf2eModel\.Model\.Structure\.Heritage') + +## Heritage\.Id Property + +Идентификатор сущности\. + +```csharp +public int Id { get; set; } +``` + +Implements [Id](IEntity.Id.md 'Pf2eModel\.Model\.IEntity\.Id') + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Heritage.md b/Documentation/Pf2eModel/Heritage.md new file mode 100644 index 0000000..323fa8a --- /dev/null +++ b/Documentation/Pf2eModel/Heritage.md @@ -0,0 +1,21 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure') + +## Heritage Class + +Наследие\. + +```csharp +public class Heritage : Pf2eModel.Model.IEntity +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 Heritage + +Implements [IEntity](IEntity.md 'Pf2eModel\.Model\.IEntity') + +| Properties | | +| :--- | :--- | +| [Ancestry](Heritage.Ancestry.md 'Pf2eModel\.Model\.Structure\.Heritage\.Ancestry') | Родословная\. | +| [AncestryId](Heritage.AncestryId.md 'Pf2eModel\.Model\.Structure\.Heritage\.AncestryId') | Идентификатор родословной\. | +| [Entity](Heritage.Entity.md 'Pf2eModel\.Model\.Structure\.Heritage\.Entity') | Корневая сущность\. | +| [Id](Heritage.Id.md 'Pf2eModel\.Model\.Structure\.Heritage\.Id') | Идентификатор сущности\. | diff --git a/Documentation/Pf2eModel/IEntity.Entity.md b/Documentation/Pf2eModel/IEntity.Entity.md new file mode 100644 index 0000000..4c877bd --- /dev/null +++ b/Documentation/Pf2eModel/IEntity.Entity.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model](Pf2eModel.Model.md 'Pf2eModel\.Model').[IEntity](IEntity.md 'Pf2eModel\.Model\.IEntity') + +## IEntity\.Entity Property + +Корневая сущность\. + +```csharp +Pf2eModel.Model.Base.Entity Entity { get; set; } +``` + +#### Property Value +[Entity](Entity.md 'Pf2eModel\.Model\.Base\.Entity') \ No newline at end of file diff --git a/Documentation/Pf2eModel/IEntity.Id.md b/Documentation/Pf2eModel/IEntity.Id.md new file mode 100644 index 0000000..6b94e13 --- /dev/null +++ b/Documentation/Pf2eModel/IEntity.Id.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model](Pf2eModel.Model.md 'Pf2eModel\.Model').[IEntity](IEntity.md 'Pf2eModel\.Model\.IEntity') + +## IEntity\.Id Property + +Идентификатор сущности\. + +```csharp +int Id { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/IEntity.md b/Documentation/Pf2eModel/IEntity.md new file mode 100644 index 0000000..4cdc981 --- /dev/null +++ b/Documentation/Pf2eModel/IEntity.md @@ -0,0 +1,33 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model](Pf2eModel.Model.md 'Pf2eModel\.Model') + +## IEntity Interface + +Интерфейс сущностей структуры\. + +```csharp +public interface IEntity +``` + +Derived +↳ [Action](Action.md 'Pf2eModel\.Model\.Structure\.Action') +↳ [Ancestry](Ancestry.md 'Pf2eModel\.Model\.Structure\.Ancestry') +↳ [Archetype](Archetype.md 'Pf2eModel\.Model\.Structure\.Archetype') +↳ [Background](Background.md 'Pf2eModel\.Model\.Structure\.Background') +↳ [Class](Class.md 'Pf2eModel\.Model\.Structure\.Class') +↳ [Condition](Condition.md 'Pf2eModel\.Model\.Structure\.Condition') +↳ [Deity](Deity.md 'Pf2eModel\.Model\.Structure\.Deity') +↳ [Feat](Feat.md 'Pf2eModel\.Model\.Structure\.Feat') +↳ [Heritage](Heritage.md 'Pf2eModel\.Model\.Structure\.Heritage') +↳ [Language](Language.md 'Pf2eModel\.Model\.Structure\.Language') +↳ [Ritual](Ritual.md 'Pf2eModel\.Model\.Structure\.Ritual') +↳ [Rule](Rule.md 'Pf2eModel\.Model\.Structure\.Rule') +↳ [Spell](Spell.md 'Pf2eModel\.Model\.Structure\.Spell') +↳ [Subclass](Subclass.md 'Pf2eModel\.Model\.Structure\.Subclass') +↳ [SubclassGroup](SubclassGroup.md 'Pf2eModel\.Model\.Structure\.SubclassGroup') +↳ [Trait](Trait.md 'Pf2eModel\.Model\.Structure\.Trait') + +| Properties | | +| :--- | :--- | +| [Entity](IEntity.Entity.md 'Pf2eModel\.Model\.IEntity\.Entity') | Корневая сущность\. | +| [Id](IEntity.Id.md 'Pf2eModel\.Model\.IEntity\.Id') | Идентификатор сущности\. | diff --git a/Documentation/Pf2eModel/Keyword.Aliases.md b/Documentation/Pf2eModel/Keyword.Aliases.md new file mode 100644 index 0000000..b84be43 --- /dev/null +++ b/Documentation/Pf2eModel/Keyword.Aliases.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Base\.Keywords](Pf2eModel.Model.Base.Keywords.md 'Pf2eModel\.Model\.Base\.Keywords').[Keyword](Keyword.md 'Pf2eModel\.Model\.Base\.Keywords\.Keyword') + +## Keyword\.Aliases Property + +Коллекция синонимов ключевого слова\. + +```csharp +public System.Collections.Generic.ICollection Aliases { get; set; } +``` + +#### Property Value +[System\.Collections\.Generic\.ICollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1')[KeywordAlias](KeywordAlias.md 'Pf2eModel\.Model\.Base\.Keywords\.KeywordAlias')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Keyword.Entities.md b/Documentation/Pf2eModel/Keyword.Entities.md new file mode 100644 index 0000000..5dcdae7 --- /dev/null +++ b/Documentation/Pf2eModel/Keyword.Entities.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Base\.Keywords](Pf2eModel.Model.Base.Keywords.md 'Pf2eModel\.Model\.Base\.Keywords').[Keyword](Keyword.md 'Pf2eModel\.Model\.Base\.Keywords\.Keyword') + +## Keyword\.Entities Property + +Коллекция сущностей, которые используют это ключевое слово\. + +```csharp +public System.Collections.Generic.ICollection Entities { get; set; } +``` + +#### Property Value +[System\.Collections\.Generic\.ICollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1')[Entity](Entity.md 'Pf2eModel\.Model\.Base\.Entity')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Keyword.Id.md b/Documentation/Pf2eModel/Keyword.Id.md new file mode 100644 index 0000000..7b8721c --- /dev/null +++ b/Documentation/Pf2eModel/Keyword.Id.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Base\.Keywords](Pf2eModel.Model.Base.Keywords.md 'Pf2eModel\.Model\.Base\.Keywords').[Keyword](Keyword.md 'Pf2eModel\.Model\.Base\.Keywords\.Keyword') + +## Keyword\.Id Property + +Идентификатор\. + +```csharp +public int Id { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Keyword.Name.md b/Documentation/Pf2eModel/Keyword.Name.md new file mode 100644 index 0000000..1e9769d --- /dev/null +++ b/Documentation/Pf2eModel/Keyword.Name.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Base\.Keywords](Pf2eModel.Model.Base.Keywords.md 'Pf2eModel\.Model\.Base\.Keywords').[Keyword](Keyword.md 'Pf2eModel\.Model\.Base\.Keywords\.Keyword') + +## Keyword\.Name Field + +Отображаемое имя ключевого слова\. + +```csharp +public LocaleString Name; +``` + +#### Field Value +[LocaleString](LocaleString.md 'Pf2eModel\.Model\.Common\.I18n\.LocaleString') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Keyword.Slug.md b/Documentation/Pf2eModel/Keyword.Slug.md new file mode 100644 index 0000000..6e62997 --- /dev/null +++ b/Documentation/Pf2eModel/Keyword.Slug.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Base\.Keywords](Pf2eModel.Model.Base.Keywords.md 'Pf2eModel\.Model\.Base\.Keywords').[Keyword](Keyword.md 'Pf2eModel\.Model\.Base\.Keywords\.Keyword') + +## Keyword\.Slug Property + +Часть имени в URL\. + +```csharp +public string Slug { get; set; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Keyword.md b/Documentation/Pf2eModel/Keyword.md new file mode 100644 index 0000000..fdec7d4 --- /dev/null +++ b/Documentation/Pf2eModel/Keyword.md @@ -0,0 +1,23 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Base\.Keywords](Pf2eModel.Model.Base.Keywords.md 'Pf2eModel\.Model\.Base\.Keywords') + +## Keyword Class + +Ключевое слово\. + +```csharp +public class Keyword +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 Keyword + +| Fields | | +| :--- | :--- | +| [Name](Keyword.Name.md 'Pf2eModel\.Model\.Base\.Keywords\.Keyword\.Name') | Отображаемое имя ключевого слова\. | + +| Properties | | +| :--- | :--- | +| [Aliases](Keyword.Aliases.md 'Pf2eModel\.Model\.Base\.Keywords\.Keyword\.Aliases') | Коллекция синонимов ключевого слова\. | +| [Entities](Keyword.Entities.md 'Pf2eModel\.Model\.Base\.Keywords\.Keyword\.Entities') | Коллекция сущностей, которые используют это ключевое слово\. | +| [Id](Keyword.Id.md 'Pf2eModel\.Model\.Base\.Keywords\.Keyword\.Id') | Идентификатор\. | +| [Slug](Keyword.Slug.md 'Pf2eModel\.Model\.Base\.Keywords\.Keyword\.Slug') | Часть имени в URL\. | diff --git a/Documentation/Pf2eModel/KeywordAlias.Id.md b/Documentation/Pf2eModel/KeywordAlias.Id.md new file mode 100644 index 0000000..c5c29d7 --- /dev/null +++ b/Documentation/Pf2eModel/KeywordAlias.Id.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Base\.Keywords](Pf2eModel.Model.Base.Keywords.md 'Pf2eModel\.Model\.Base\.Keywords').[KeywordAlias](KeywordAlias.md 'Pf2eModel\.Model\.Base\.Keywords\.KeywordAlias') + +## KeywordAlias\.Id Property + +Идентификатор\. + +```csharp +public int Id { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/KeywordAlias.Keyword.md b/Documentation/Pf2eModel/KeywordAlias.Keyword.md new file mode 100644 index 0000000..40b00d9 --- /dev/null +++ b/Documentation/Pf2eModel/KeywordAlias.Keyword.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Base\.Keywords](Pf2eModel.Model.Base.Keywords.md 'Pf2eModel\.Model\.Base\.Keywords').[KeywordAlias](KeywordAlias.md 'Pf2eModel\.Model\.Base\.Keywords\.KeywordAlias') + +## KeywordAlias\.Keyword Property + +Ключевое слово, к которому относится синоним\. + +```csharp +public Pf2eModel.Model.Base.Keywords.Keyword Keyword { get; set; } +``` + +#### Property Value +[Keyword](Keyword.md 'Pf2eModel\.Model\.Base\.Keywords\.Keyword') \ No newline at end of file diff --git a/Documentation/Pf2eModel/KeywordAlias.KeywordId.md b/Documentation/Pf2eModel/KeywordAlias.KeywordId.md new file mode 100644 index 0000000..8b56193 --- /dev/null +++ b/Documentation/Pf2eModel/KeywordAlias.KeywordId.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Base\.Keywords](Pf2eModel.Model.Base.Keywords.md 'Pf2eModel\.Model\.Base\.Keywords').[KeywordAlias](KeywordAlias.md 'Pf2eModel\.Model\.Base\.Keywords\.KeywordAlias') + +## KeywordAlias\.KeywordId Property + +Идентификатор связаннного ключевого слова\. + +```csharp +public int KeywordId { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/KeywordAlias.Value.md b/Documentation/Pf2eModel/KeywordAlias.Value.md new file mode 100644 index 0000000..0c5b2cc --- /dev/null +++ b/Documentation/Pf2eModel/KeywordAlias.Value.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Base\.Keywords](Pf2eModel.Model.Base.Keywords.md 'Pf2eModel\.Model\.Base\.Keywords').[KeywordAlias](KeywordAlias.md 'Pf2eModel\.Model\.Base\.Keywords\.KeywordAlias') + +## KeywordAlias\.Value Property + +Значение синонима ключевого слова\. + +```csharp +public string Value { get; set; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eModel/KeywordAlias.md b/Documentation/Pf2eModel/KeywordAlias.md new file mode 100644 index 0000000..3f4e3bd --- /dev/null +++ b/Documentation/Pf2eModel/KeywordAlias.md @@ -0,0 +1,19 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Base\.Keywords](Pf2eModel.Model.Base.Keywords.md 'Pf2eModel\.Model\.Base\.Keywords') + +## KeywordAlias Class + +Синоним ключевого слова\. + +```csharp +public class KeywordAlias +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 KeywordAlias + +| Properties | | +| :--- | :--- | +| [Id](KeywordAlias.Id.md 'Pf2eModel\.Model\.Base\.Keywords\.KeywordAlias\.Id') | Идентификатор\. | +| [Keyword](KeywordAlias.Keyword.md 'Pf2eModel\.Model\.Base\.Keywords\.KeywordAlias\.Keyword') | Ключевое слово, к которому относится синоним\. | +| [KeywordId](KeywordAlias.KeywordId.md 'Pf2eModel\.Model\.Base\.Keywords\.KeywordAlias\.KeywordId') | Идентификатор связаннного ключевого слова\. | +| [Value](KeywordAlias.Value.md 'Pf2eModel\.Model\.Base\.Keywords\.KeywordAlias\.Value') | Значение синонима ключевого слова\. | diff --git a/Documentation/Pf2eModel/Language.Entity.md b/Documentation/Pf2eModel/Language.Entity.md new file mode 100644 index 0000000..30fa0d1 --- /dev/null +++ b/Documentation/Pf2eModel/Language.Entity.md @@ -0,0 +1,15 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Language](Language.md 'Pf2eModel\.Model\.Structure\.Language') + +## Language\.Entity Property + +Корневая сущность\. + +```csharp +public Pf2eModel.Model.Base.Entity Entity { get; set; } +``` + +Implements [Entity](IEntity.Entity.md 'Pf2eModel\.Model\.IEntity\.Entity') + +#### Property Value +[Entity](Entity.md 'Pf2eModel\.Model\.Base\.Entity') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Language.Id.md b/Documentation/Pf2eModel/Language.Id.md new file mode 100644 index 0000000..5295d5e --- /dev/null +++ b/Documentation/Pf2eModel/Language.Id.md @@ -0,0 +1,15 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Language](Language.md 'Pf2eModel\.Model\.Structure\.Language') + +## Language\.Id Property + +Идентификатор сущности\. + +```csharp +public int Id { get; set; } +``` + +Implements [Id](IEntity.Id.md 'Pf2eModel\.Model\.IEntity\.Id') + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Language.md b/Documentation/Pf2eModel/Language.md new file mode 100644 index 0000000..8f5ebca --- /dev/null +++ b/Documentation/Pf2eModel/Language.md @@ -0,0 +1,19 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure') + +## Language Class + +Язык\. + +```csharp +public class Language : Pf2eModel.Model.IEntity +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 Language + +Implements [IEntity](IEntity.md 'Pf2eModel\.Model\.IEntity') + +| Properties | | +| :--- | :--- | +| [Entity](Language.Entity.md 'Pf2eModel\.Model\.Structure\.Language\.Entity') | Корневая сущность\. | +| [Id](Language.Id.md 'Pf2eModel\.Model\.Structure\.Language\.Id') | Идентификатор сущности\. | diff --git a/Documentation/Pf2eModel/LegacyRemaster.LegacyEntity.md b/Documentation/Pf2eModel/LegacyRemaster.LegacyEntity.md new file mode 100644 index 0000000..d075b79 --- /dev/null +++ b/Documentation/Pf2eModel/LegacyRemaster.LegacyEntity.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Base](Pf2eModel.Model.Base.md 'Pf2eModel\.Model\.Base').[LegacyRemaster](LegacyRemaster.md 'Pf2eModel\.Model\.Base\.LegacyRemaster') + +## LegacyRemaster\.LegacyEntity Property + +Устаревшая сущность\. + +```csharp +public Pf2eModel.Model.Base.Entity LegacyEntity { get; set; } +``` + +#### Property Value +[Entity](Entity.md 'Pf2eModel\.Model\.Base\.Entity') \ No newline at end of file diff --git a/Documentation/Pf2eModel/LegacyRemaster.LegacyId.md b/Documentation/Pf2eModel/LegacyRemaster.LegacyId.md new file mode 100644 index 0000000..3b8baa0 --- /dev/null +++ b/Documentation/Pf2eModel/LegacyRemaster.LegacyId.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Base](Pf2eModel.Model.Base.md 'Pf2eModel\.Model\.Base').[LegacyRemaster](LegacyRemaster.md 'Pf2eModel\.Model\.Base\.LegacyRemaster') + +## LegacyRemaster\.LegacyId Property + +Идентификатор устаревшей сущности\. + +```csharp +public int LegacyId { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/LegacyRemaster.RemasterEntity.md b/Documentation/Pf2eModel/LegacyRemaster.RemasterEntity.md new file mode 100644 index 0000000..1b1a618 --- /dev/null +++ b/Documentation/Pf2eModel/LegacyRemaster.RemasterEntity.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Base](Pf2eModel.Model.Base.md 'Pf2eModel\.Model\.Base').[LegacyRemaster](LegacyRemaster.md 'Pf2eModel\.Model\.Base\.LegacyRemaster') + +## LegacyRemaster\.RemasterEntity Property + +Обновлённая сущность\. + +```csharp +public Pf2eModel.Model.Base.Entity RemasterEntity { get; set; } +``` + +#### Property Value +[Entity](Entity.md 'Pf2eModel\.Model\.Base\.Entity') \ No newline at end of file diff --git a/Documentation/Pf2eModel/LegacyRemaster.RemasterId.md b/Documentation/Pf2eModel/LegacyRemaster.RemasterId.md new file mode 100644 index 0000000..9d2faea --- /dev/null +++ b/Documentation/Pf2eModel/LegacyRemaster.RemasterId.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Base](Pf2eModel.Model.Base.md 'Pf2eModel\.Model\.Base').[LegacyRemaster](LegacyRemaster.md 'Pf2eModel\.Model\.Base\.LegacyRemaster') + +## LegacyRemaster\.RemasterId Property + +Идентификатор обновлённой сущности\. + +```csharp +public int RemasterId { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/LegacyRemaster.md b/Documentation/Pf2eModel/LegacyRemaster.md new file mode 100644 index 0000000..27b9217 --- /dev/null +++ b/Documentation/Pf2eModel/LegacyRemaster.md @@ -0,0 +1,19 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Base](Pf2eModel.Model.Base.md 'Pf2eModel\.Model\.Base') + +## LegacyRemaster Class + +Связь устаревших и обновлённых сущностей + +```csharp +public class LegacyRemaster +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 LegacyRemaster + +| Properties | | +| :--- | :--- | +| [LegacyEntity](LegacyRemaster.LegacyEntity.md 'Pf2eModel\.Model\.Base\.LegacyRemaster\.LegacyEntity') | Устаревшая сущность\. | +| [LegacyId](LegacyRemaster.LegacyId.md 'Pf2eModel\.Model\.Base\.LegacyRemaster\.LegacyId') | Идентификатор устаревшей сущности\. | +| [RemasterEntity](LegacyRemaster.RemasterEntity.md 'Pf2eModel\.Model\.Base\.LegacyRemaster\.RemasterEntity') | Обновлённая сущность\. | +| [RemasterId](LegacyRemaster.RemasterId.md 'Pf2eModel\.Model\.Base\.LegacyRemaster\.RemasterId') | Идентификатор обновлённой сущности\. | diff --git a/Documentation/Pf2eModel/LocaleExtension.GetTypeByString(thisstring).md b/Documentation/Pf2eModel/LocaleExtension.GetTypeByString(thisstring).md new file mode 100644 index 0000000..fac1469 --- /dev/null +++ b/Documentation/Pf2eModel/LocaleExtension.GetTypeByString(thisstring).md @@ -0,0 +1,26 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Common\.I18n](Pf2eModel.Model.Common.I18n.md 'Pf2eModel\.Model\.Common\.I18n').[LocaleExtension](LocaleExtension.md 'Pf2eModel\.Model\.Common\.I18n\.LocaleExtension') + +## LocaleExtension\.GetTypeByString\(this string\) Method + +Получение типа локализации по строковому представлению типа локализации\. + +```csharp +public static Pf2eModel.Model.Common.I18n.LocaleType GetTypeByString(this string localeTypeString); +``` +#### Parameters + + + +`localeTypeString` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +Строковое представление типа локализации\. + +#### Returns +[LocaleType](LocaleType.md 'Pf2eModel\.Model\.Common\.I18n\.LocaleType') +Тип локализации\. + +#### Exceptions + +[System\.ComponentModel\.InvalidEnumArgumentException](https://docs.microsoft.com/en-us/dotnet/api/System.ComponentModel.InvalidEnumArgumentException 'System\.ComponentModel\.InvalidEnumArgumentException') +Исключение, если строковое представление не соответсвует ни одному типу локализации\. \ No newline at end of file diff --git a/Documentation/Pf2eModel/LocaleExtension.GetTypeString(thisLocaleType).md b/Documentation/Pf2eModel/LocaleExtension.GetTypeString(thisLocaleType).md new file mode 100644 index 0000000..ff6ee1a --- /dev/null +++ b/Documentation/Pf2eModel/LocaleExtension.GetTypeString(thisLocaleType).md @@ -0,0 +1,21 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Common\.I18n](Pf2eModel.Model.Common.I18n.md 'Pf2eModel\.Model\.Common\.I18n').[LocaleExtension](LocaleExtension.md 'Pf2eModel\.Model\.Common\.I18n\.LocaleExtension') + +## LocaleExtension\.GetTypeString\(this LocaleType\) Method + +Получение строкового представления типа локализации\. + +```csharp +public static string GetTypeString(this Pf2eModel.Model.Common.I18n.LocaleType localeType); +``` +#### Parameters + + + +`localeType` [LocaleType](LocaleType.md 'Pf2eModel\.Model\.Common\.I18n\.LocaleType') + +Тип локализации\. + +#### Returns +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') +Строковое представление типа локализации\. \ No newline at end of file diff --git a/Documentation/Pf2eModel/LocaleExtension.md b/Documentation/Pf2eModel/LocaleExtension.md new file mode 100644 index 0000000..ead6a57 --- /dev/null +++ b/Documentation/Pf2eModel/LocaleExtension.md @@ -0,0 +1,17 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Common\.I18n](Pf2eModel.Model.Common.I18n.md 'Pf2eModel\.Model\.Common\.I18n') + +## LocaleExtension Class + +Расширения для работы с локализацией\. + +```csharp +public static class LocaleExtension +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 LocaleExtension + +| Methods | | +| :--- | :--- | +| [GetTypeByString\(this string\)](LocaleExtension.GetTypeByString(thisstring).md 'Pf2eModel\.Model\.Common\.I18n\.LocaleExtension\.GetTypeByString\(this string\)') | Получение типа локализации по строковому представлению типа локализации\. | +| [GetTypeString\(this LocaleType\)](LocaleExtension.GetTypeString(thisLocaleType).md 'Pf2eModel\.Model\.Common\.I18n\.LocaleExtension\.GetTypeString\(this Pf2eModel\.Model\.Common\.I18n\.LocaleType\)') | Получение строкового представления типа локализации\. | diff --git a/Documentation/Pf2eModel/LocaleItem.Locale.md b/Documentation/Pf2eModel/LocaleItem.Locale.md new file mode 100644 index 0000000..25c242e --- /dev/null +++ b/Documentation/Pf2eModel/LocaleItem.Locale.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Common\.I18n](Pf2eModel.Model.Common.I18n.md 'Pf2eModel\.Model\.Common\.I18n').[LocaleItem](LocaleItem.md 'Pf2eModel\.Model\.Common\.I18n\.LocaleItem') + +## LocaleItem\.Locale Property + +Тип локализации\. + +```csharp +public Pf2eModel.Model.Common.I18n.LocaleType Locale { get; set; } +``` + +#### Property Value +[LocaleType](LocaleType.md 'Pf2eModel\.Model\.Common\.I18n\.LocaleType') \ No newline at end of file diff --git a/Documentation/Pf2eModel/LocaleItem.LocaleItem.md b/Documentation/Pf2eModel/LocaleItem.LocaleItem.md new file mode 100644 index 0000000..74b25f8 --- /dev/null +++ b/Documentation/Pf2eModel/LocaleItem.LocaleItem.md @@ -0,0 +1,49 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Common\.I18n](Pf2eModel.Model.Common.I18n.md 'Pf2eModel\.Model\.Common\.I18n').[LocaleItem](LocaleItem.md 'Pf2eModel\.Model\.Common\.I18n\.LocaleItem') + +## LocaleItem Constructors + +| Overloads | | +| :--- | :--- | +| [LocaleItem\(LocaleType, string\)](LocaleItem.LocaleItem.md#Pf2eModel.Model.Common.I18n.LocaleItem.LocaleItem(Pf2eModel.Model.Common.I18n.LocaleType,string) 'Pf2eModel\.Model\.Common\.I18n\.LocaleItem\.LocaleItem\(Pf2eModel\.Model\.Common\.I18n\.LocaleType, string\)') | Элемент локализации\. | +| [LocaleItem\(KeyValuePair<string,string>\)](LocaleItem.LocaleItem.md#Pf2eModel.Model.Common.I18n.LocaleItem.LocaleItem(System.Collections.Generic.KeyValuePair_string,string_) 'Pf2eModel\.Model\.Common\.I18n\.LocaleItem\.LocaleItem\(System\.Collections\.Generic\.KeyValuePair\\)') | Конструктор класса [LocaleItem](LocaleItem.md 'Pf2eModel\.Model\.Common\.I18n\.LocaleItem') по паре ключ\-значение\. | + + + +## LocaleItem\(LocaleType, string\) Constructor + +Элемент локализации\. + +```csharp +public LocaleItem(Pf2eModel.Model.Common.I18n.LocaleType type, string value); +``` +#### Parameters + + + +`type` [LocaleType](LocaleType.md 'Pf2eModel\.Model\.Common\.I18n\.LocaleType') + +Тип локализации\. + + + +`value` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +Значение локализации\. + + + +## LocaleItem\(KeyValuePair\\) Constructor + +Конструктор класса [LocaleItem](LocaleItem.md 'Pf2eModel\.Model\.Common\.I18n\.LocaleItem') по паре ключ\-значение\. + +```csharp +public LocaleItem(System.Collections.Generic.KeyValuePair item); +``` +#### Parameters + + + +`item` [System\.Collections\.Generic\.KeyValuePair<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.KeyValuePair-2 'System\.Collections\.Generic\.KeyValuePair\`2')[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.KeyValuePair-2 'System\.Collections\.Generic\.KeyValuePair\`2')[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.KeyValuePair-2 'System\.Collections\.Generic\.KeyValuePair\`2') + +Пара ключ\-значение по строковому представлению типа\. \ No newline at end of file diff --git a/Documentation/Pf2eModel/LocaleItem.Value.md b/Documentation/Pf2eModel/LocaleItem.Value.md new file mode 100644 index 0000000..dfce591 --- /dev/null +++ b/Documentation/Pf2eModel/LocaleItem.Value.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Common\.I18n](Pf2eModel.Model.Common.I18n.md 'Pf2eModel\.Model\.Common\.I18n').[LocaleItem](LocaleItem.md 'Pf2eModel\.Model\.Common\.I18n\.LocaleItem') + +## LocaleItem\.Value Property + +Значение локализации\. + +```csharp +public string Value { get; set; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eModel/LocaleItem.md b/Documentation/Pf2eModel/LocaleItem.md new file mode 100644 index 0000000..0512819 --- /dev/null +++ b/Documentation/Pf2eModel/LocaleItem.md @@ -0,0 +1,22 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Common\.I18n](Pf2eModel.Model.Common.I18n.md 'Pf2eModel\.Model\.Common\.I18n') + +## LocaleItem Class + +Элемент локализации\. + +```csharp +public class LocaleItem +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 LocaleItem + +| Constructors | | +| :--- | :--- | +| [LocaleItem\(LocaleType, string\)](LocaleItem.LocaleItem.md#Pf2eModel.Model.Common.I18n.LocaleItem.LocaleItem(Pf2eModel.Model.Common.I18n.LocaleType,string) 'Pf2eModel\.Model\.Common\.I18n\.LocaleItem\.LocaleItem\(Pf2eModel\.Model\.Common\.I18n\.LocaleType, string\)') | Элемент локализации\. | +| [LocaleItem\(KeyValuePair<string,string>\)](LocaleItem.LocaleItem.md#Pf2eModel.Model.Common.I18n.LocaleItem.LocaleItem(System.Collections.Generic.KeyValuePair_string,string_) 'Pf2eModel\.Model\.Common\.I18n\.LocaleItem\.LocaleItem\(System\.Collections\.Generic\.KeyValuePair\\)') | Конструктор класса [LocaleItem](LocaleItem.md 'Pf2eModel\.Model\.Common\.I18n\.LocaleItem') по паре ключ\-значение\. | + +| Properties | | +| :--- | :--- | +| [Locale](LocaleItem.Locale.md 'Pf2eModel\.Model\.Common\.I18n\.LocaleItem\.Locale') | Тип локализации\. | +| [Value](LocaleItem.Value.md 'Pf2eModel\.Model\.Common\.I18n\.LocaleItem\.Value') | Значение локализации\. | diff --git a/Documentation/Pf2eModel/LocaleString.Add.md b/Documentation/Pf2eModel/LocaleString.Add.md new file mode 100644 index 0000000..197bc84 --- /dev/null +++ b/Documentation/Pf2eModel/LocaleString.Add.md @@ -0,0 +1,49 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Common\.I18n](Pf2eModel.Model.Common.I18n.md 'Pf2eModel\.Model\.Common\.I18n').[LocaleString](LocaleString.md 'Pf2eModel\.Model\.Common\.I18n\.LocaleString') + +## LocaleString\.Add Method + +| Overloads | | +| :--- | :--- | +| [Add\(LocaleItem\)](LocaleString.Add.md#Pf2eModel.Model.Common.I18n.LocaleString.Add(Pf2eModel.Model.Common.I18n.LocaleItem) 'Pf2eModel\.Model\.Common\.I18n\.LocaleString\.Add\(Pf2eModel\.Model\.Common\.I18n\.LocaleItem\)') | Добавление объекта локализованной строки в коллекцию\. | +| [Add\(LocaleType, string\)](LocaleString.Add.md#Pf2eModel.Model.Common.I18n.LocaleString.Add(Pf2eModel.Model.Common.I18n.LocaleType,string) 'Pf2eModel\.Model\.Common\.I18n\.LocaleString\.Add\(Pf2eModel\.Model\.Common\.I18n\.LocaleType, string\)') | Добавление локализованной строки в коллекцию\. | + + + +## LocaleString\.Add\(LocaleItem\) Method + +Добавление объекта локализованной строки в коллекцию\. + +```csharp +public void Add(Pf2eModel.Model.Common.I18n.LocaleItem item); +``` +#### Parameters + + + +`item` [LocaleItem](LocaleItem.md 'Pf2eModel\.Model\.Common\.I18n\.LocaleItem') + +Объект локализированной строки\. + + + +## LocaleString\.Add\(LocaleType, string\) Method + +Добавление локализованной строки в коллекцию\. + +```csharp +public void Add(Pf2eModel.Model.Common.I18n.LocaleType locale, string value); +``` +#### Parameters + + + +`locale` [LocaleType](LocaleType.md 'Pf2eModel\.Model\.Common\.I18n\.LocaleType') + +Тип локализации\. + + + +`value` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +Строка локазации\. \ No newline at end of file diff --git a/Documentation/Pf2eModel/LocaleString.AssureDefault().md b/Documentation/Pf2eModel/LocaleString.AssureDefault().md new file mode 100644 index 0000000..b2ca634 --- /dev/null +++ b/Documentation/Pf2eModel/LocaleString.AssureDefault().md @@ -0,0 +1,10 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Common\.I18n](Pf2eModel.Model.Common.I18n.md 'Pf2eModel\.Model\.Common\.I18n').[LocaleString](LocaleString.md 'Pf2eModel\.Model\.Common\.I18n\.LocaleString') + +## LocaleString\.AssureDefault\(\) Method + +Проверяет наличие хотя бы одной локализации\. + +```csharp +private void AssureDefault(); +``` \ No newline at end of file diff --git a/Documentation/Pf2eModel/LocaleString.Clear().md b/Documentation/Pf2eModel/LocaleString.Clear().md new file mode 100644 index 0000000..511ec93 --- /dev/null +++ b/Documentation/Pf2eModel/LocaleString.Clear().md @@ -0,0 +1,12 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Common\.I18n](Pf2eModel.Model.Common.I18n.md 'Pf2eModel\.Model\.Common\.I18n').[LocaleString](LocaleString.md 'Pf2eModel\.Model\.Common\.I18n\.LocaleString') + +## LocaleString\.Clear\(\) Method + +Отчистка коллекции локализованных строк\. + +```csharp +public void Clear(); +``` + +Implements [Clear\(\)](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1.Clear 'System\.Collections\.Generic\.ICollection\`1\.Clear') \ No newline at end of file diff --git a/Documentation/Pf2eModel/LocaleString.Contains.md b/Documentation/Pf2eModel/LocaleString.Contains.md new file mode 100644 index 0000000..4916b2e --- /dev/null +++ b/Documentation/Pf2eModel/LocaleString.Contains.md @@ -0,0 +1,73 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Common\.I18n](Pf2eModel.Model.Common.I18n.md 'Pf2eModel\.Model\.Common\.I18n').[LocaleString](LocaleString.md 'Pf2eModel\.Model\.Common\.I18n\.LocaleString') + +## LocaleString\.Contains Method + +| Overloads | | +| :--- | :--- | +| [Contains\(LocaleItem\)](LocaleString.Contains.md#Pf2eModel.Model.Common.I18n.LocaleString.Contains(Pf2eModel.Model.Common.I18n.LocaleItem) 'Pf2eModel\.Model\.Common\.I18n\.LocaleString\.Contains\(Pf2eModel\.Model\.Common\.I18n\.LocaleItem\)') | Проверка наличия объекта локализованной строки в коллекции\. | +| [Contains\(LocaleType\)](LocaleString.Contains.md#Pf2eModel.Model.Common.I18n.LocaleString.Contains(Pf2eModel.Model.Common.I18n.LocaleType) 'Pf2eModel\.Model\.Common\.I18n\.LocaleString\.Contains\(Pf2eModel\.Model\.Common\.I18n\.LocaleType\)') | Проверка наличия локализованной строки в коллекции по типу локализации\. | +| [Contains\(string\)](LocaleString.Contains.md#Pf2eModel.Model.Common.I18n.LocaleString.Contains(string) 'Pf2eModel\.Model\.Common\.I18n\.LocaleString\.Contains\(string\)') | Проверка наличия локализованной строки в коллекции по строковому представлению типа локализации\. | + + + +## LocaleString\.Contains\(LocaleItem\) Method + +Проверка наличия объекта локализованной строки в коллекции\. + +```csharp +public bool Contains(Pf2eModel.Model.Common.I18n.LocaleItem item); +``` +#### Parameters + + + +`item` [LocaleItem](LocaleItem.md 'Pf2eModel\.Model\.Common\.I18n\.LocaleItem') + +Объект локализированной строки\. + +#### Returns +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') +\`true\`, если объект есть; \`false\`, если нет\. + + + +## LocaleString\.Contains\(LocaleType\) Method + +Проверка наличия локализованной строки в коллекции по типу локализации\. + +```csharp +public bool Contains(Pf2eModel.Model.Common.I18n.LocaleType locale); +``` +#### Parameters + + + +`locale` [LocaleType](LocaleType.md 'Pf2eModel\.Model\.Common\.I18n\.LocaleType') + +Тип локализации\. + +#### Returns +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') +\`true\`, если искомый тип локализации есть; \`false\`, если нет\. + + + +## LocaleString\.Contains\(string\) Method + +Проверка наличия локализованной строки в коллекции по строковому представлению типа локализации\. + +```csharp +public bool Contains(string localeString); +``` +#### Parameters + + + +`localeString` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +Строковое представление искомого типа локализации\. + +#### Returns +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') +\`true\`, если искомый тип локализации есть; \`false\`, если нет\. \ No newline at end of file diff --git a/Documentation/Pf2eModel/LocaleString.Count.md b/Documentation/Pf2eModel/LocaleString.Count.md new file mode 100644 index 0000000..d256998 --- /dev/null +++ b/Documentation/Pf2eModel/LocaleString.Count.md @@ -0,0 +1,15 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Common\.I18n](Pf2eModel.Model.Common.I18n.md 'Pf2eModel\.Model\.Common\.I18n').[LocaleString](LocaleString.md 'Pf2eModel\.Model\.Common\.I18n\.LocaleString') + +## LocaleString\.Count Property + +Количество локализаций\. + +```csharp +public int Count { get; } +``` + +Implements [Count](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1.Count 'System\.Collections\.Generic\.ICollection\`1\.Count') + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/LocaleString.Deserialize(string).md b/Documentation/Pf2eModel/LocaleString.Deserialize(string).md new file mode 100644 index 0000000..3eb26a5 --- /dev/null +++ b/Documentation/Pf2eModel/LocaleString.Deserialize(string).md @@ -0,0 +1,21 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Common\.I18n](Pf2eModel.Model.Common.I18n.md 'Pf2eModel\.Model\.Common\.I18n').[LocaleString](LocaleString.md 'Pf2eModel\.Model\.Common\.I18n\.LocaleString') + +## LocaleString\.Deserialize\(string\) Method + +Десериализация локализованной строки из JSON\-формата\. + +```csharp +public static Pf2eModel.Model.Common.I18n.LocaleString Deserialize(string input); +``` +#### Parameters + + + +`input` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +Строковое представление JSON\-представления\. + +#### Returns +[LocaleString](LocaleString.md 'Pf2eModel\.Model\.Common\.I18n\.LocaleString') +Объект локализованной строки\. \ No newline at end of file diff --git a/Documentation/Pf2eModel/LocaleString.GetEnumerator().md b/Documentation/Pf2eModel/LocaleString.GetEnumerator().md new file mode 100644 index 0000000..6bb6f39 --- /dev/null +++ b/Documentation/Pf2eModel/LocaleString.GetEnumerator().md @@ -0,0 +1,16 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Common\.I18n](Pf2eModel.Model.Common.I18n.md 'Pf2eModel\.Model\.Common\.I18n').[LocaleString](LocaleString.md 'Pf2eModel\.Model\.Common\.I18n\.LocaleString') + +## LocaleString\.GetEnumerator\(\) Method + +Возвращает перечислитель, выполняющий перебор элементов в коллекции\. + +```csharp +public System.Collections.Generic.IEnumerator GetEnumerator(); +``` + +Implements [GetEnumerator\(\)](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1.GetEnumerator 'System\.Collections\.Generic\.IEnumerable\`1\.GetEnumerator'), [GetEnumerator\(\)](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IEnumerable.GetEnumerator 'System\.Collections\.IEnumerable\.GetEnumerator') + +#### Returns +[System\.Collections\.Generic\.IEnumerator<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerator-1 'System\.Collections\.Generic\.IEnumerator\`1')[LocaleItem](LocaleItem.md 'Pf2eModel\.Model\.Common\.I18n\.LocaleItem')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerator-1 'System\.Collections\.Generic\.IEnumerator\`1') +Перечислитель, который можно использовать для итерации по коллекции\. \ No newline at end of file diff --git a/Documentation/Pf2eModel/LocaleString.GetItem.md b/Documentation/Pf2eModel/LocaleString.GetItem.md new file mode 100644 index 0000000..185736c --- /dev/null +++ b/Documentation/Pf2eModel/LocaleString.GetItem.md @@ -0,0 +1,51 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Common\.I18n](Pf2eModel.Model.Common.I18n.md 'Pf2eModel\.Model\.Common\.I18n').[LocaleString](LocaleString.md 'Pf2eModel\.Model\.Common\.I18n\.LocaleString') + +## LocaleString\.GetItem Method + +| Overloads | | +| :--- | :--- | +| [GetItem\(LocaleType\)](LocaleString.GetItem.md#Pf2eModel.Model.Common.I18n.LocaleString.GetItem(Pf2eModel.Model.Common.I18n.LocaleType) 'Pf2eModel\.Model\.Common\.I18n\.LocaleString\.GetItem\(Pf2eModel\.Model\.Common\.I18n\.LocaleType\)') | Получение объекта локализованной строки по типу локализации\. | +| [GetItem\(string\)](LocaleString.GetItem.md#Pf2eModel.Model.Common.I18n.LocaleString.GetItem(string) 'Pf2eModel\.Model\.Common\.I18n\.LocaleString\.GetItem\(string\)') | Получение объекта локализованной строки по строковому представлению типа локализации\. | + + + +## LocaleString\.GetItem\(LocaleType\) Method + +Получение объекта локализованной строки по типу локализации\. + +```csharp +public Pf2eModel.Model.Common.I18n.LocaleItem GetItem(Pf2eModel.Model.Common.I18n.LocaleType locale); +``` +#### Parameters + + + +`locale` [LocaleType](LocaleType.md 'Pf2eModel\.Model\.Common\.I18n\.LocaleType') + +Искомый тип локализации\. + +#### Returns +[LocaleItem](LocaleItem.md 'Pf2eModel\.Model\.Common\.I18n\.LocaleItem') +Объект локализованной строки\. + + + +## LocaleString\.GetItem\(string\) Method + +Получение объекта локализованной строки по строковому представлению типа локализации\. + +```csharp +public Pf2eModel.Model.Common.I18n.LocaleItem GetItem(string localeString); +``` +#### Parameters + + + +`localeString` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +Строковое представление искомого типа локализации\. + +#### Returns +[LocaleItem](LocaleItem.md 'Pf2eModel\.Model\.Common\.I18n\.LocaleItem') +Объект локализованной строки\. \ No newline at end of file diff --git a/Documentation/Pf2eModel/LocaleString.IsReadOnly.md b/Documentation/Pf2eModel/LocaleString.IsReadOnly.md new file mode 100644 index 0000000..36d775f --- /dev/null +++ b/Documentation/Pf2eModel/LocaleString.IsReadOnly.md @@ -0,0 +1,15 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Common\.I18n](Pf2eModel.Model.Common.I18n.md 'Pf2eModel\.Model\.Common\.I18n').[LocaleString](LocaleString.md 'Pf2eModel\.Model\.Common\.I18n\.LocaleString') + +## LocaleString\.IsReadOnly Property + +Получает значение, указывающее, является ли объект [System\.Collections\.Generic\.ICollection<>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1') доступным только для чтения\. + +```csharp +public bool IsReadOnly { get; } +``` + +Implements [IsReadOnly](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1.IsReadOnly 'System\.Collections\.Generic\.ICollection\`1\.IsReadOnly') + +#### Property Value +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') \ No newline at end of file diff --git a/Documentation/Pf2eModel/LocaleString.LocaleString().md b/Documentation/Pf2eModel/LocaleString.LocaleString().md new file mode 100644 index 0000000..df235da --- /dev/null +++ b/Documentation/Pf2eModel/LocaleString.LocaleString().md @@ -0,0 +1,10 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Common\.I18n](Pf2eModel.Model.Common.I18n.md 'Pf2eModel\.Model\.Common\.I18n').[LocaleString](LocaleString.md 'Pf2eModel\.Model\.Common\.I18n\.LocaleString') + +## LocaleString\(\) Constructor + +Конструктор класса [LocaleString](LocaleString.md 'Pf2eModel\.Model\.Common\.I18n\.LocaleString')\. + +```csharp +public LocaleString(); +``` \ No newline at end of file diff --git a/Documentation/Pf2eModel/LocaleString.RealLocale.md b/Documentation/Pf2eModel/LocaleString.RealLocale.md new file mode 100644 index 0000000..9f204d7 --- /dev/null +++ b/Documentation/Pf2eModel/LocaleString.RealLocale.md @@ -0,0 +1,51 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Common\.I18n](Pf2eModel.Model.Common.I18n.md 'Pf2eModel\.Model\.Common\.I18n').[LocaleString](LocaleString.md 'Pf2eModel\.Model\.Common\.I18n\.LocaleString') + +## LocaleString\.RealLocale Method + +| Overloads | | +| :--- | :--- | +| [RealLocale\(LocaleType\)](LocaleString.RealLocale.md#Pf2eModel.Model.Common.I18n.LocaleString.RealLocale(Pf2eModel.Model.Common.I18n.LocaleType) 'Pf2eModel\.Model\.Common\.I18n\.LocaleString\.RealLocale\(Pf2eModel\.Model\.Common\.I18n\.LocaleType\)') | Получение типа локализации с учётом её наличия в коллекции\. | +| [RealLocale\(string\)](LocaleString.RealLocale.md#Pf2eModel.Model.Common.I18n.LocaleString.RealLocale(string) 'Pf2eModel\.Model\.Common\.I18n\.LocaleString\.RealLocale\(string\)') | Получение типа локализации по строковому представлению с учётом её наличия в коллекции\. | + + + +## LocaleString\.RealLocale\(LocaleType\) Method + +Получение типа локализации с учётом её наличия в коллекции\. + +```csharp +private Pf2eModel.Model.Common.I18n.LocaleType RealLocale(Pf2eModel.Model.Common.I18n.LocaleType locale); +``` +#### Parameters + + + +`locale` [LocaleType](LocaleType.md 'Pf2eModel\.Model\.Common\.I18n\.LocaleType') + +Искомый тип локализации\. + +#### Returns +[LocaleType](LocaleType.md 'Pf2eModel\.Model\.Common\.I18n\.LocaleType') +Реальный тип локализации\. + + + +## LocaleString\.RealLocale\(string\) Method + +Получение типа локализации по строковому представлению с учётом её наличия в коллекции\. + +```csharp +private Pf2eModel.Model.Common.I18n.LocaleType RealLocale(string localeString); +``` +#### Parameters + + + +`localeString` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +Строковое представление искомого типа локализации\. + +#### Returns +[LocaleType](LocaleType.md 'Pf2eModel\.Model\.Common\.I18n\.LocaleType') +Реальный тип локализации\. \ No newline at end of file diff --git a/Documentation/Pf2eModel/LocaleString.Serialize().md b/Documentation/Pf2eModel/LocaleString.Serialize().md new file mode 100644 index 0000000..3db73d1 --- /dev/null +++ b/Documentation/Pf2eModel/LocaleString.Serialize().md @@ -0,0 +1,14 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Common\.I18n](Pf2eModel.Model.Common.I18n.md 'Pf2eModel\.Model\.Common\.I18n').[LocaleString](LocaleString.md 'Pf2eModel\.Model\.Common\.I18n\.LocaleString') + +## LocaleString\.Serialize\(\) Method + +Сериализация локализованной строки в JSON\-формат\. + +```csharp +public string Serialize(); +``` + +#### Returns +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') +Строковое представление JSON\-представления\. \ No newline at end of file diff --git a/Documentation/Pf2eModel/LocaleString.System.Collections.IEnumerable.GetEnumerator().md b/Documentation/Pf2eModel/LocaleString.System.Collections.IEnumerable.GetEnumerator().md new file mode 100644 index 0000000..aa8d043 --- /dev/null +++ b/Documentation/Pf2eModel/LocaleString.System.Collections.IEnumerable.GetEnumerator().md @@ -0,0 +1,12 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Common\.I18n](Pf2eModel.Model.Common.I18n.md 'Pf2eModel\.Model\.Common\.I18n').[LocaleString](LocaleString.md 'Pf2eModel\.Model\.Common\.I18n\.LocaleString') + +## System\.Collections\.IEnumerable\.GetEnumerator\(\) Method + +Возвращает перечислитель, который осуществляет итерацию по коллекции\. + +```csharp +System.Collections.IEnumerator System.Collections.IEnumerable.GetEnumerator(); +``` + +Implements [GetEnumerator\(\)](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IEnumerable.GetEnumerator 'System\.Collections\.IEnumerable\.GetEnumerator') \ No newline at end of file diff --git a/Documentation/Pf2eModel/LocaleString.ToString().md b/Documentation/Pf2eModel/LocaleString.ToString().md new file mode 100644 index 0000000..53ce1d0 --- /dev/null +++ b/Documentation/Pf2eModel/LocaleString.ToString().md @@ -0,0 +1,14 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Common\.I18n](Pf2eModel.Model.Common.I18n.md 'Pf2eModel\.Model\.Common\.I18n').[LocaleString](LocaleString.md 'Pf2eModel\.Model\.Common\.I18n\.LocaleString') + +## LocaleString\.ToString\(\) Method + +Возвращает строку, представляющую текущий объект\. + +```csharp +public override string ToString(); +``` + +#### Returns +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') +Строка, представляющая текущий объект\. \ No newline at end of file diff --git a/Documentation/Pf2eModel/LocaleString.Types.md b/Documentation/Pf2eModel/LocaleString.Types.md new file mode 100644 index 0000000..e5efa8b --- /dev/null +++ b/Documentation/Pf2eModel/LocaleString.Types.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Common\.I18n](Pf2eModel.Model.Common.I18n.md 'Pf2eModel\.Model\.Common\.I18n').[LocaleString](LocaleString.md 'Pf2eModel\.Model\.Common\.I18n\.LocaleString') + +## LocaleString\.Types Property + +Коллекция реализованных типов локализаций\. + +```csharp +public System.Collections.Generic.ICollection Types { get; } +``` + +#### Property Value +[System\.Collections\.Generic\.ICollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1')[LocaleType](LocaleType.md 'Pf2eModel\.Model\.Common\.I18n\.LocaleType')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1') \ No newline at end of file diff --git a/Documentation/Pf2eModel/LocaleString._E(string).md b/Documentation/Pf2eModel/LocaleString._E(string).md new file mode 100644 index 0000000..7603603 --- /dev/null +++ b/Documentation/Pf2eModel/LocaleString._E(string).md @@ -0,0 +1,21 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Common\.I18n](Pf2eModel.Model.Common.I18n.md 'Pf2eModel\.Model\.Common\.I18n').[LocaleString](LocaleString.md 'Pf2eModel\.Model\.Common\.I18n\.LocaleString') + +## LocaleString\.\_E\(string\) Method + +Получение типа локализации по строковому представлению\. + +```csharp +private Pf2eModel.Model.Common.I18n.LocaleType _E(string localeString); +``` +#### Parameters + + + +`localeString` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +Строковое представление\. + +#### Returns +[LocaleType](LocaleType.md 'Pf2eModel\.Model\.Common\.I18n\.LocaleType') +Тип локализации\. \ No newline at end of file diff --git a/Documentation/Pf2eModel/LocaleString._items.md b/Documentation/Pf2eModel/LocaleString._items.md new file mode 100644 index 0000000..5ed1072 --- /dev/null +++ b/Documentation/Pf2eModel/LocaleString._items.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Common\.I18n](Pf2eModel.Model.Common.I18n.md 'Pf2eModel\.Model\.Common\.I18n').[LocaleString](LocaleString.md 'Pf2eModel\.Model\.Common\.I18n\.LocaleString') + +## LocaleString\.\_items Field + +Список локализаций строк\. + +```csharp +private readonly List _items; +``` + +#### Field Value +[System\.Collections\.Generic\.List<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.List-1 'System\.Collections\.Generic\.List\`1')[LocaleItem](LocaleItem.md 'Pf2eModel\.Model\.Common\.I18n\.LocaleItem')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.List-1 'System\.Collections\.Generic\.List\`1') \ No newline at end of file diff --git a/Documentation/Pf2eModel/LocaleString.md b/Documentation/Pf2eModel/LocaleString.md new file mode 100644 index 0000000..2de5e6f --- /dev/null +++ b/Documentation/Pf2eModel/LocaleString.md @@ -0,0 +1,53 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Common\.I18n](Pf2eModel.Model.Common.I18n.md 'Pf2eModel\.Model\.Common\.I18n') + +## LocaleString Class + +Локализованная строка\. + +```csharp +public class LocaleString : System.Collections.Generic.ICollection, System.Collections.Generic.IEnumerable, System.Collections.IEnumerable +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 LocaleString + +Implements [System\.Collections\.Generic\.ICollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1')[LocaleItem](LocaleItem.md 'Pf2eModel\.Model\.Common\.I18n\.LocaleItem')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1'), [System\.Collections\.Generic\.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System\.Collections\.Generic\.IEnumerable\`1')[LocaleItem](LocaleItem.md 'Pf2eModel\.Model\.Common\.I18n\.LocaleItem')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System\.Collections\.Generic\.IEnumerable\`1'), [System\.Collections\.IEnumerable](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.IEnumerable 'System\.Collections\.IEnumerable') + +| Constructors | | +| :--- | :--- | +| [LocaleString\(\)](LocaleString.LocaleString().md 'Pf2eModel\.Model\.Common\.I18n\.LocaleString\.LocaleString\(\)') | Конструктор класса [LocaleString](LocaleString.md 'Pf2eModel\.Model\.Common\.I18n\.LocaleString')\. | + +| Fields | | +| :--- | :--- | +| [\_items](LocaleString._items.md 'Pf2eModel\.Model\.Common\.I18n\.LocaleString\.\_items') | Список локализаций строк\. | + +| Properties | | +| :--- | :--- | +| [Count](LocaleString.Count.md 'Pf2eModel\.Model\.Common\.I18n\.LocaleString\.Count') | Количество локализаций\. | +| [IsReadOnly](LocaleString.IsReadOnly.md 'Pf2eModel\.Model\.Common\.I18n\.LocaleString\.IsReadOnly') | Получает значение, указывающее, является ли объект [System\.Collections\.Generic\.ICollection<>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1') доступным только для чтения\. | +| [this\[LocaleType\]](LocaleString.this[LocaleType].md 'Pf2eModel\.Model\.Common\.I18n\.LocaleString\.this\[Pf2eModel\.Model\.Common\.I18n\.LocaleType\]') | Получение локализованной строки по типу локализации\. | +| [this\[string\]](LocaleString.this[string].md 'Pf2eModel\.Model\.Common\.I18n\.LocaleString\.this\[string\]') | Получение локализованной строки по типу локализации\. | +| [Types](LocaleString.Types.md 'Pf2eModel\.Model\.Common\.I18n\.LocaleString\.Types') | Коллекция реализованных типов локализаций\. | + +| Methods | | +| :--- | :--- | +| [\_E\(string\)](LocaleString._E(string).md 'Pf2eModel\.Model\.Common\.I18n\.LocaleString\.\_E\(string\)') | Получение типа локализации по строковому представлению\. | +| [Add\(LocaleItem\)](LocaleString.Add.md#Pf2eModel.Model.Common.I18n.LocaleString.Add(Pf2eModel.Model.Common.I18n.LocaleItem) 'Pf2eModel\.Model\.Common\.I18n\.LocaleString\.Add\(Pf2eModel\.Model\.Common\.I18n\.LocaleItem\)') | Добавление объекта локализованной строки в коллекцию\. | +| [Add\(LocaleType, string\)](LocaleString.Add.md#Pf2eModel.Model.Common.I18n.LocaleString.Add(Pf2eModel.Model.Common.I18n.LocaleType,string) 'Pf2eModel\.Model\.Common\.I18n\.LocaleString\.Add\(Pf2eModel\.Model\.Common\.I18n\.LocaleType, string\)') | Добавление локализованной строки в коллекцию\. | +| [AssureDefault\(\)](LocaleString.AssureDefault().md 'Pf2eModel\.Model\.Common\.I18n\.LocaleString\.AssureDefault\(\)') | Проверяет наличие хотя бы одной локализации\. | +| [Clear\(\)](LocaleString.Clear().md 'Pf2eModel\.Model\.Common\.I18n\.LocaleString\.Clear\(\)') | Отчистка коллекции локализованных строк\. | +| [Contains\(LocaleItem\)](LocaleString.Contains.md#Pf2eModel.Model.Common.I18n.LocaleString.Contains(Pf2eModel.Model.Common.I18n.LocaleItem) 'Pf2eModel\.Model\.Common\.I18n\.LocaleString\.Contains\(Pf2eModel\.Model\.Common\.I18n\.LocaleItem\)') | Проверка наличия объекта локализованной строки в коллекции\. | +| [Contains\(LocaleType\)](LocaleString.Contains.md#Pf2eModel.Model.Common.I18n.LocaleString.Contains(Pf2eModel.Model.Common.I18n.LocaleType) 'Pf2eModel\.Model\.Common\.I18n\.LocaleString\.Contains\(Pf2eModel\.Model\.Common\.I18n\.LocaleType\)') | Проверка наличия локализованной строки в коллекции по типу локализации\. | +| [Contains\(string\)](LocaleString.Contains.md#Pf2eModel.Model.Common.I18n.LocaleString.Contains(string) 'Pf2eModel\.Model\.Common\.I18n\.LocaleString\.Contains\(string\)') | Проверка наличия локализованной строки в коллекции по строковому представлению типа локализации\. | +| [Deserialize\(string\)](LocaleString.Deserialize(string).md 'Pf2eModel\.Model\.Common\.I18n\.LocaleString\.Deserialize\(string\)') | Десериализация локализованной строки из JSON\-формата\. | +| [GetEnumerator\(\)](LocaleString.GetEnumerator().md 'Pf2eModel\.Model\.Common\.I18n\.LocaleString\.GetEnumerator\(\)') | Возвращает перечислитель, выполняющий перебор элементов в коллекции\. | +| [GetItem\(LocaleType\)](LocaleString.GetItem.md#Pf2eModel.Model.Common.I18n.LocaleString.GetItem(Pf2eModel.Model.Common.I18n.LocaleType) 'Pf2eModel\.Model\.Common\.I18n\.LocaleString\.GetItem\(Pf2eModel\.Model\.Common\.I18n\.LocaleType\)') | Получение объекта локализованной строки по типу локализации\. | +| [GetItem\(string\)](LocaleString.GetItem.md#Pf2eModel.Model.Common.I18n.LocaleString.GetItem(string) 'Pf2eModel\.Model\.Common\.I18n\.LocaleString\.GetItem\(string\)') | Получение объекта локализованной строки по строковому представлению типа локализации\. | +| [RealLocale\(LocaleType\)](LocaleString.RealLocale.md#Pf2eModel.Model.Common.I18n.LocaleString.RealLocale(Pf2eModel.Model.Common.I18n.LocaleType) 'Pf2eModel\.Model\.Common\.I18n\.LocaleString\.RealLocale\(Pf2eModel\.Model\.Common\.I18n\.LocaleType\)') | Получение типа локализации с учётом её наличия в коллекции\. | +| [RealLocale\(string\)](LocaleString.RealLocale.md#Pf2eModel.Model.Common.I18n.LocaleString.RealLocale(string) 'Pf2eModel\.Model\.Common\.I18n\.LocaleString\.RealLocale\(string\)') | Получение типа локализации по строковому представлению с учётом её наличия в коллекции\. | +| [Serialize\(\)](LocaleString.Serialize().md 'Pf2eModel\.Model\.Common\.I18n\.LocaleString\.Serialize\(\)') | Сериализация локализованной строки в JSON\-формат\. | +| [ToString\(\)](LocaleString.ToString().md 'Pf2eModel\.Model\.Common\.I18n\.LocaleString\.ToString\(\)') | Возвращает строку, представляющую текущий объект\. | + +| Explicit Interface Implementations | | +| :--- | :--- | +| [System\.Collections\.IEnumerable\.GetEnumerator\(\)](LocaleString.System.Collections.IEnumerable.GetEnumerator().md 'Pf2eModel\.Model\.Common\.I18n\.LocaleString\.System\.Collections\.IEnumerable\.GetEnumerator\(\)') | Возвращает перечислитель, который осуществляет итерацию по коллекции\. | diff --git a/Documentation/Pf2eModel/LocaleString.this[LocaleType].md b/Documentation/Pf2eModel/LocaleString.this[LocaleType].md new file mode 100644 index 0000000..fd7bafd --- /dev/null +++ b/Documentation/Pf2eModel/LocaleString.this[LocaleType].md @@ -0,0 +1,20 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Common\.I18n](Pf2eModel.Model.Common.I18n.md 'Pf2eModel\.Model\.Common\.I18n').[LocaleString](LocaleString.md 'Pf2eModel\.Model\.Common\.I18n\.LocaleString') + +## LocaleString\.this\[LocaleType\] Property + +Получение локализованной строки по типу локализации\. + +```csharp +public string this[Pf2eModel.Model.Common.I18n.LocaleType locale] { get; set; } +``` +#### Parameters + + + +`locale` [LocaleType](LocaleType.md 'Pf2eModel\.Model\.Common\.I18n\.LocaleType') + +Искомый тип локализации\. + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eModel/LocaleString.this[string].md b/Documentation/Pf2eModel/LocaleString.this[string].md new file mode 100644 index 0000000..fcbf7c1 --- /dev/null +++ b/Documentation/Pf2eModel/LocaleString.this[string].md @@ -0,0 +1,20 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Common\.I18n](Pf2eModel.Model.Common.I18n.md 'Pf2eModel\.Model\.Common\.I18n').[LocaleString](LocaleString.md 'Pf2eModel\.Model\.Common\.I18n\.LocaleString') + +## LocaleString\.this\[string\] Property + +Получение локализованной строки по типу локализации\. + +```csharp +public string this[string localeString] { get; set; } +``` +#### Parameters + + + +`localeString` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +Строковое представление искомого типа локализации\. + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eModel/LocaleType.md b/Documentation/Pf2eModel/LocaleType.md new file mode 100644 index 0000000..179e457 --- /dev/null +++ b/Documentation/Pf2eModel/LocaleType.md @@ -0,0 +1,35 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Common\.I18n](Pf2eModel.Model.Common.I18n.md 'Pf2eModel\.Model\.Common\.I18n') + +## LocaleType Enum + +Тип локализации\. + +```csharp +public enum LocaleType +``` +### Fields + + + +`English` 0 + +Английский язык \(основной\)\. + + + +`Russian` 1 + +Русский язык\. + + + +`Hobby` 2 + +Русский язык \(вариант HobbyGames\)\. + + + +`Other` 3 + +Другой язык\. \ No newline at end of file diff --git a/Documentation/Pf2eModel/Pf2eDbContext.BindEntity_T_(EntityTypeBuilder_T_).md b/Documentation/Pf2eModel/Pf2eDbContext.BindEntity_T_(EntityTypeBuilder_T_).md new file mode 100644 index 0000000..035eff1 --- /dev/null +++ b/Documentation/Pf2eModel/Pf2eDbContext.BindEntity_T_(EntityTypeBuilder_T_).md @@ -0,0 +1,25 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel](Pf2eModel.md 'Pf2eModel').[Pf2eDbContext](Pf2eDbContext.md 'Pf2eModel\.Pf2eDbContext') + +## Pf2eDbContext\.BindEntity\\(EntityTypeBuilder\\) Method + +Устанавливает связь между сущностью и её корневой сущностью\. + +```csharp +private void BindEntity(Microsoft.EntityFrameworkCore.Metadata.Builders.EntityTypeBuilder entity) + where T : class, Pf2eModel.Model.IEntity; +``` +#### Type parameters + + + +`T` + +Тип сущности\. +#### Parameters + + + +`entity` [Microsoft\.EntityFrameworkCore\.Metadata\.Builders\.EntityTypeBuilder<](https://docs.microsoft.com/en-us/dotnet/api/Microsoft.EntityFrameworkCore.Metadata.Builders.EntityTypeBuilder-1 'Microsoft\.EntityFrameworkCore\.Metadata\.Builders\.EntityTypeBuilder\`1')[T](Pf2eDbContext.BindEntity_T_(EntityTypeBuilder_T_).md#Pf2eModel.Pf2eDbContext.BindEntity_T_(Microsoft.EntityFrameworkCore.Metadata.Builders.EntityTypeBuilder_T_).T 'Pf2eModel\.Pf2eDbContext\.BindEntity\\(Microsoft\.EntityFrameworkCore\.Metadata\.Builders\.EntityTypeBuilder\\)\.T')[>](https://docs.microsoft.com/en-us/dotnet/api/Microsoft.EntityFrameworkCore.Metadata.Builders.EntityTypeBuilder-1 'Microsoft\.EntityFrameworkCore\.Metadata\.Builders\.EntityTypeBuilder\`1') + +Генератор настроек таблицы сущности\. \ No newline at end of file diff --git a/Documentation/Pf2eModel/Pf2eDbContext.BindLocaleString_T_(EntityTypeBuilder_T_,Expression_Func_T,LocaleString__,bool).md b/Documentation/Pf2eModel/Pf2eDbContext.BindLocaleString_T_(EntityTypeBuilder_T_,Expression_Func_T,LocaleString__,bool).md new file mode 100644 index 0000000..2ca4cfc --- /dev/null +++ b/Documentation/Pf2eModel/Pf2eDbContext.BindLocaleString_T_(EntityTypeBuilder_T_,Expression_Func_T,LocaleString__,bool).md @@ -0,0 +1,37 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel](Pf2eModel.md 'Pf2eModel').[Pf2eDbContext](Pf2eDbContext.md 'Pf2eModel\.Pf2eDbContext') + +## Pf2eDbContext\.BindLocaleString\\(EntityTypeBuilder\, Expression\\>, bool\) Method + +Устанавливает связь между сущностью и локализованной строкой\. + +```csharp +private void BindLocaleString(Microsoft.EntityFrameworkCore.Metadata.Builders.EntityTypeBuilder entity, System.Linq.Expressions.Expression> func, bool required=true) + where T : class; +``` +#### Type parameters + + + +`T` + +Тип сущности\. +#### Parameters + + + +`entity` [Microsoft\.EntityFrameworkCore\.Metadata\.Builders\.EntityTypeBuilder<](https://docs.microsoft.com/en-us/dotnet/api/Microsoft.EntityFrameworkCore.Metadata.Builders.EntityTypeBuilder-1 'Microsoft\.EntityFrameworkCore\.Metadata\.Builders\.EntityTypeBuilder\`1')[T](Pf2eDbContext.BindLocaleString_T_(EntityTypeBuilder_T_,Expression_Func_T,LocaleString__,bool).md#Pf2eModel.Pf2eDbContext.BindLocaleString_T_(Microsoft.EntityFrameworkCore.Metadata.Builders.EntityTypeBuilder_T_,System.Linq.Expressions.Expression_System.Func_T,Pf2eModel.Model.Common.I18n.LocaleString__,bool).T 'Pf2eModel\.Pf2eDbContext\.BindLocaleString\\(Microsoft\.EntityFrameworkCore\.Metadata\.Builders\.EntityTypeBuilder\, System\.Linq\.Expressions\.Expression\\>, bool\)\.T')[>](https://docs.microsoft.com/en-us/dotnet/api/Microsoft.EntityFrameworkCore.Metadata.Builders.EntityTypeBuilder-1 'Microsoft\.EntityFrameworkCore\.Metadata\.Builders\.EntityTypeBuilder\`1') + +Генератор настроек таблицы сущности\. + + + +`func` [System\.Linq\.Expressions\.Expression<](https://docs.microsoft.com/en-us/dotnet/api/System.Linq.Expressions.Expression-1 'System\.Linq\.Expressions\.Expression\`1')[System\.Func<](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System\.Func\`2')[T](Pf2eDbContext.BindLocaleString_T_(EntityTypeBuilder_T_,Expression_Func_T,LocaleString__,bool).md#Pf2eModel.Pf2eDbContext.BindLocaleString_T_(Microsoft.EntityFrameworkCore.Metadata.Builders.EntityTypeBuilder_T_,System.Linq.Expressions.Expression_System.Func_T,Pf2eModel.Model.Common.I18n.LocaleString__,bool).T 'Pf2eModel\.Pf2eDbContext\.BindLocaleString\\(Microsoft\.EntityFrameworkCore\.Metadata\.Builders\.EntityTypeBuilder\, System\.Linq\.Expressions\.Expression\\>, bool\)\.T')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System\.Func\`2')[LocaleString](LocaleString.md 'Pf2eModel\.Model\.Common\.I18n\.LocaleString')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Func-2 'System\.Func\`2')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Linq.Expressions.Expression-1 'System\.Linq\.Expressions\.Expression\`1') + +Функция, выбирающая поле сущности\. + + + +`required` [System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') + +Флаг, указывающий, что локализованная строка не может быть \`null\`\. \ No newline at end of file diff --git a/Documentation/Pf2eModel/Pf2eDbContext.DefineBase(ModelBuilder).md b/Documentation/Pf2eModel/Pf2eDbContext.DefineBase(ModelBuilder).md new file mode 100644 index 0000000..5230c62 --- /dev/null +++ b/Documentation/Pf2eModel/Pf2eDbContext.DefineBase(ModelBuilder).md @@ -0,0 +1,17 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel](Pf2eModel.md 'Pf2eModel').[Pf2eDbContext](Pf2eDbContext.md 'Pf2eModel\.Pf2eDbContext') + +## Pf2eDbContext\.DefineBase\(ModelBuilder\) Method + +Определяет базовые сущности и их связи\. + +```csharp +private void DefineBase(Microsoft.EntityFrameworkCore.ModelBuilder modelBuilder); +``` +#### Parameters + + + +`modelBuilder` [Microsoft\.EntityFrameworkCore\.ModelBuilder](https://docs.microsoft.com/en-us/dotnet/api/Microsoft.EntityFrameworkCore.ModelBuilder 'Microsoft\.EntityFrameworkCore\.ModelBuilder') + +Построитель модели\. \ No newline at end of file diff --git a/Documentation/Pf2eModel/Pf2eDbContext.DefineCommon(ModelBuilder).md b/Documentation/Pf2eModel/Pf2eDbContext.DefineCommon(ModelBuilder).md new file mode 100644 index 0000000..c05ac4e --- /dev/null +++ b/Documentation/Pf2eModel/Pf2eDbContext.DefineCommon(ModelBuilder).md @@ -0,0 +1,17 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel](Pf2eModel.md 'Pf2eModel').[Pf2eDbContext](Pf2eDbContext.md 'Pf2eModel\.Pf2eDbContext') + +## Pf2eDbContext\.DefineCommon\(ModelBuilder\) Method + +Определяет общие сущности и их связи\. + +```csharp +private void DefineCommon(Microsoft.EntityFrameworkCore.ModelBuilder modelBuilder); +``` +#### Parameters + + + +`modelBuilder` [Microsoft\.EntityFrameworkCore\.ModelBuilder](https://docs.microsoft.com/en-us/dotnet/api/Microsoft.EntityFrameworkCore.ModelBuilder 'Microsoft\.EntityFrameworkCore\.ModelBuilder') + +Построитель модели\. \ No newline at end of file diff --git a/Documentation/Pf2eModel/Pf2eDbContext.DefineMethods(ModelBuilder).md b/Documentation/Pf2eModel/Pf2eDbContext.DefineMethods(ModelBuilder).md new file mode 100644 index 0000000..fd4bc14 --- /dev/null +++ b/Documentation/Pf2eModel/Pf2eDbContext.DefineMethods(ModelBuilder).md @@ -0,0 +1,17 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel](Pf2eModel.md 'Pf2eModel').[Pf2eDbContext](Pf2eDbContext.md 'Pf2eModel\.Pf2eDbContext') + +## Pf2eDbContext\.DefineMethods\(ModelBuilder\) Method + +Определяет методы, которые будут использоваться в запросах LINQ\. + +```csharp +private void DefineMethods(Microsoft.EntityFrameworkCore.ModelBuilder modelBuilder); +``` +#### Parameters + + + +`modelBuilder` [Microsoft\.EntityFrameworkCore\.ModelBuilder](https://docs.microsoft.com/en-us/dotnet/api/Microsoft.EntityFrameworkCore.ModelBuilder 'Microsoft\.EntityFrameworkCore\.ModelBuilder') + +Построитель модели\. \ No newline at end of file diff --git a/Documentation/Pf2eModel/Pf2eDbContext.DefineStructure(ModelBuilder).md b/Documentation/Pf2eModel/Pf2eDbContext.DefineStructure(ModelBuilder).md new file mode 100644 index 0000000..b7f2929 --- /dev/null +++ b/Documentation/Pf2eModel/Pf2eDbContext.DefineStructure(ModelBuilder).md @@ -0,0 +1,17 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel](Pf2eModel.md 'Pf2eModel').[Pf2eDbContext](Pf2eDbContext.md 'Pf2eModel\.Pf2eDbContext') + +## Pf2eDbContext\.DefineStructure\(ModelBuilder\) Method + +Определяет структуру сущностей и их связи\. + +```csharp +private void DefineStructure(Microsoft.EntityFrameworkCore.ModelBuilder modelBuilder); +``` +#### Parameters + + + +`modelBuilder` [Microsoft\.EntityFrameworkCore\.ModelBuilder](https://docs.microsoft.com/en-us/dotnet/api/Microsoft.EntityFrameworkCore.ModelBuilder 'Microsoft\.EntityFrameworkCore\.ModelBuilder') + +Построитель модели\. \ No newline at end of file diff --git a/Documentation/Pf2eModel/Pf2eDbContext.LocaleSearch(LocaleString,string).md b/Documentation/Pf2eModel/Pf2eDbContext.LocaleSearch(LocaleString,string).md new file mode 100644 index 0000000..d1368c5 --- /dev/null +++ b/Documentation/Pf2eModel/Pf2eDbContext.LocaleSearch(LocaleString,string).md @@ -0,0 +1,27 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel](Pf2eModel.md 'Pf2eModel').[Pf2eDbContext](Pf2eDbContext.md 'Pf2eModel\.Pf2eDbContext') + +## Pf2eDbContext\.LocaleSearch\(LocaleString, string\) Method + +CLR\-представление функции поиска в локализованной строке\. + +```csharp +public static bool LocaleSearch(Pf2eModel.Model.Common.I18n.LocaleString data, string search_value); +``` +#### Parameters + + + +`data` [LocaleString](LocaleString.md 'Pf2eModel\.Model\.Common\.I18n\.LocaleString') + +Локализованная строка, в которой будет осуществляться поиск\. + + + +`search_value` [System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') + +Искомое значение для поиска\. + +#### Returns +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') +Флаг, указывающий, найдено ли искомое значение в локализованной строке\. \ No newline at end of file diff --git a/Documentation/Pf2eModel/Pf2eDbContext.LocaleSearchArray(LocaleString,IEnumerable_string_).md b/Documentation/Pf2eModel/Pf2eDbContext.LocaleSearchArray(LocaleString,IEnumerable_string_).md new file mode 100644 index 0000000..890ae27 --- /dev/null +++ b/Documentation/Pf2eModel/Pf2eDbContext.LocaleSearchArray(LocaleString,IEnumerable_string_).md @@ -0,0 +1,27 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel](Pf2eModel.md 'Pf2eModel').[Pf2eDbContext](Pf2eDbContext.md 'Pf2eModel\.Pf2eDbContext') + +## Pf2eDbContext\.LocaleSearchArray\(LocaleString, IEnumerable\\) Method + +CLR\-представление функции поиска в локализованной строке с массивом значений для поиска\. + +```csharp +public static bool LocaleSearchArray(Pf2eModel.Model.Common.I18n.LocaleString data, System.Collections.Generic.IEnumerable search_values); +``` +#### Parameters + + + +`data` [LocaleString](LocaleString.md 'Pf2eModel\.Model\.Common\.I18n\.LocaleString') + +Локализованная строка, в которой будет осуществляться поиск\. + + + +`search_values` [System\.Collections\.Generic\.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System\.Collections\.Generic\.IEnumerable\`1')[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System\.Collections\.Generic\.IEnumerable\`1') + +Массив искомых значений для поиска\. + +#### Returns +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') +Флаг, указывающий, найдено ли хотя бы одно искомое значение в локализованной строке\. \ No newline at end of file diff --git a/Documentation/Pf2eModel/Pf2eDbContext.NameLength.md b/Documentation/Pf2eModel/Pf2eDbContext.NameLength.md new file mode 100644 index 0000000..f5cbc73 --- /dev/null +++ b/Documentation/Pf2eModel/Pf2eDbContext.NameLength.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel](Pf2eModel.md 'Pf2eModel').[Pf2eDbContext](Pf2eDbContext.md 'Pf2eModel\.Pf2eDbContext') + +## Pf2eDbContext\.NameLength Field + +Длина названия сущности\. + +```csharp +public const int NameLength = 255; +``` + +#### Field Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Pf2eDbContext.OnConfiguring(DbContextOptionsBuilder).md b/Documentation/Pf2eModel/Pf2eDbContext.OnConfiguring(DbContextOptionsBuilder).md new file mode 100644 index 0000000..7befe65 --- /dev/null +++ b/Documentation/Pf2eModel/Pf2eDbContext.OnConfiguring(DbContextOptionsBuilder).md @@ -0,0 +1,30 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel](Pf2eModel.md 'Pf2eModel').[Pf2eDbContext](Pf2eDbContext.md 'Pf2eModel\.Pf2eDbContext') + +## Pf2eDbContext\.OnConfiguring\(DbContextOptionsBuilder\) Method + +Override this method to configure the database \(and other options\) to be used for this context\. +This method is called for each instance of the context that is created\. +The base implementation does nothing\. + +```csharp +protected override void OnConfiguring(Microsoft.EntityFrameworkCore.DbContextOptionsBuilder optionsBuilder); +``` +#### Parameters + + + +`optionsBuilder` [Microsoft\.EntityFrameworkCore\.DbContextOptionsBuilder](https://docs.microsoft.com/en-us/dotnet/api/Microsoft.EntityFrameworkCore.DbContextOptionsBuilder 'Microsoft\.EntityFrameworkCore\.DbContextOptionsBuilder') + +A builder used to create or modify options for this context\. Databases \(and other extensions\) +typically define extension methods on this object that allow you to configure the context\. + +### Remarks + +In situations where an instance of [Microsoft\.EntityFrameworkCore\.DbContextOptions](https://docs.microsoft.com/en-us/dotnet/api/Microsoft.EntityFrameworkCore.DbContextOptions 'Microsoft\.EntityFrameworkCore\.DbContextOptions') may or may not have been passed +to the constructor, you can use [Microsoft\.EntityFrameworkCore\.DbContextOptionsBuilder\.IsConfigured](https://docs.microsoft.com/en-us/dotnet/api/Microsoft.EntityFrameworkCore.DbContextOptionsBuilder.IsConfigured 'Microsoft\.EntityFrameworkCore\.DbContextOptionsBuilder\.IsConfigured') to determine if +the options have already been set, and skip some or all of the logic in +[Microsoft\.EntityFrameworkCore\.DbContext\.OnConfiguring\(Microsoft\.EntityFrameworkCore\.DbContextOptionsBuilder\)](https://docs.microsoft.com/en-us/dotnet/api/Microsoft.EntityFrameworkCore.DbContext.OnConfiguring#Microsoft_EntityFrameworkCore_DbContext_OnConfiguring_Microsoft_EntityFrameworkCore_DbContextOptionsBuilder_ 'Microsoft\.EntityFrameworkCore\.DbContext\.OnConfiguring\(Microsoft\.EntityFrameworkCore\.DbContextOptionsBuilder\)'). + +See [DbContext lifetime, configuration, and initialization](https://aka.ms/efcore-docs-dbcontext 'https://aka\.ms/efcore\-docs\-dbcontext') +for more information and examples. \ No newline at end of file diff --git a/Documentation/Pf2eModel/Pf2eDbContext.OnModelCreating(ModelBuilder).md b/Documentation/Pf2eModel/Pf2eDbContext.OnModelCreating(ModelBuilder).md new file mode 100644 index 0000000..4ad3005 --- /dev/null +++ b/Documentation/Pf2eModel/Pf2eDbContext.OnModelCreating(ModelBuilder).md @@ -0,0 +1,29 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel](Pf2eModel.md 'Pf2eModel').[Pf2eDbContext](Pf2eDbContext.md 'Pf2eModel\.Pf2eDbContext') + +## Pf2eDbContext\.OnModelCreating\(ModelBuilder\) Method + +Override this method to further configure the model that was discovered by convention from the entity types +exposed in [Microsoft\.EntityFrameworkCore\.DbSet<>](https://docs.microsoft.com/en-us/dotnet/api/Microsoft.EntityFrameworkCore.DbSet-1 'Microsoft\.EntityFrameworkCore\.DbSet\`1') properties on your derived context\. The resulting model may be cached +and re\-used for subsequent instances of your derived context\. + +```csharp +protected override void OnModelCreating(Microsoft.EntityFrameworkCore.ModelBuilder modelBuilder); +``` +#### Parameters + + + +`modelBuilder` [Microsoft\.EntityFrameworkCore\.ModelBuilder](https://docs.microsoft.com/en-us/dotnet/api/Microsoft.EntityFrameworkCore.ModelBuilder 'Microsoft\.EntityFrameworkCore\.ModelBuilder') + +The builder being used to construct the model for this context\. Databases \(and other extensions\) typically +define extension methods on this object that allow you to configure aspects of the model that are specific +to a given database\. + +### Remarks + +If a model is explicitly set on the options for this context (via [Microsoft\.EntityFrameworkCore\.DbContextOptionsBuilder\.UseModel\(Microsoft\.EntityFrameworkCore\.Metadata\.IModel\)](https://docs.microsoft.com/en-us/dotnet/api/Microsoft.EntityFrameworkCore.DbContextOptionsBuilder.UseModel#Microsoft_EntityFrameworkCore_DbContextOptionsBuilder_UseModel_Microsoft_EntityFrameworkCore_Metadata_IModel_ 'Microsoft\.EntityFrameworkCore\.DbContextOptionsBuilder\.UseModel\(Microsoft\.EntityFrameworkCore\.Metadata\.IModel\)')) +then this method will not be run. However, it will still run when creating a compiled model. + +See [Modeling entity types and relationships](https://aka.ms/efcore-docs-modeling 'https://aka\.ms/efcore\-docs\-modeling') for more information and +examples. \ No newline at end of file diff --git a/Documentation/Pf2eModel/Pf2eDbContext.Pf2eDbContext.md b/Documentation/Pf2eModel/Pf2eDbContext.Pf2eDbContext.md new file mode 100644 index 0000000..9c1cc8d --- /dev/null +++ b/Documentation/Pf2eModel/Pf2eDbContext.Pf2eDbContext.md @@ -0,0 +1,36 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel](Pf2eModel.md 'Pf2eModel').[Pf2eDbContext](Pf2eDbContext.md 'Pf2eModel\.Pf2eDbContext') + +## Pf2eDbContext Constructors + +| Overloads | | +| :--- | :--- | +| [Pf2eDbContext\(\)](Pf2eDbContext.Pf2eDbContext.md#Pf2eModel.Pf2eDbContext.Pf2eDbContext() 'Pf2eModel\.Pf2eDbContext\.Pf2eDbContext\(\)') | Инициализирует новый экземпляр класса [Pf2eDbContext](Pf2eDbContext.md 'Pf2eModel\.Pf2eDbContext') без параметров\. | +| [Pf2eDbContext\(DbContextOptions<Pf2eDbContext>\)](Pf2eDbContext.Pf2eDbContext.md#Pf2eModel.Pf2eDbContext.Pf2eDbContext(Microsoft.EntityFrameworkCore.DbContextOptions_Pf2eModel.Pf2eDbContext_) 'Pf2eModel\.Pf2eDbContext\.Pf2eDbContext\(Microsoft\.EntityFrameworkCore\.DbContextOptions\\)') | Инициализирует новый экземпляр класса [Pf2eDbContext](Pf2eDbContext.md 'Pf2eModel\.Pf2eDbContext') с указанными параметрами конфигурации базы данных\. | + + + +## Pf2eDbContext\(\) Constructor + +Инициализирует новый экземпляр класса [Pf2eDbContext](Pf2eDbContext.md 'Pf2eModel\.Pf2eDbContext') без параметров\. + +```csharp +public Pf2eDbContext(); +``` + + + +## Pf2eDbContext\(DbContextOptions\\) Constructor + +Инициализирует новый экземпляр класса [Pf2eDbContext](Pf2eDbContext.md 'Pf2eModel\.Pf2eDbContext') с указанными параметрами конфигурации базы данных\. + +```csharp +public Pf2eDbContext(Microsoft.EntityFrameworkCore.DbContextOptions options); +``` +#### Parameters + + + +`options` [Microsoft\.EntityFrameworkCore\.DbContextOptions<](https://docs.microsoft.com/en-us/dotnet/api/Microsoft.EntityFrameworkCore.DbContextOptions-1 'Microsoft\.EntityFrameworkCore\.DbContextOptions\`1')[Pf2eDbContext](Pf2eDbContext.md 'Pf2eModel\.Pf2eDbContext')[>](https://docs.microsoft.com/en-us/dotnet/api/Microsoft.EntityFrameworkCore.DbContextOptions-1 'Microsoft\.EntityFrameworkCore\.DbContextOptions\`1') + +Конфигурация базы данных\. \ No newline at end of file diff --git a/Documentation/Pf2eModel/Pf2eDbContext.md b/Documentation/Pf2eModel/Pf2eDbContext.md new file mode 100644 index 0000000..80d8bea --- /dev/null +++ b/Documentation/Pf2eModel/Pf2eDbContext.md @@ -0,0 +1,62 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel](Pf2eModel.md 'Pf2eModel') + +## Pf2eDbContext Class + +A DbContext instance represents a session with the database and can be used to query and save +instances of your entities\. DbContext is a combination of the Unit Of Work and Repository patterns\. + +```csharp +public class Pf2eDbContext : Microsoft.EntityFrameworkCore.DbContext +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 [Microsoft\.EntityFrameworkCore\.DbContext](https://docs.microsoft.com/en-us/dotnet/api/Microsoft.EntityFrameworkCore.DbContext 'Microsoft\.EntityFrameworkCore\.DbContext') 🡒 Pf2eDbContext + +### Remarks + +Entity Framework Core does not support multiple parallel operations being run on the same DbContext instance. This +includes both parallel execution of async queries and any explicit concurrent use from multiple threads. +Therefore, always await async calls immediately, or use separate DbContext instances for operations that execute +in parallel. See [Avoiding DbContext threading issues](https://aka.ms/efcore-docs-threading 'https://aka\.ms/efcore\-docs\-threading') for more information +and examples. + +Typically you create a class that derives from DbContext and contains [Microsoft\.EntityFrameworkCore\.DbSet<>](https://docs.microsoft.com/en-us/dotnet/api/Microsoft.EntityFrameworkCore.DbSet-1 'Microsoft\.EntityFrameworkCore\.DbSet\`1') +properties for each entity in the model. If the [Microsoft\.EntityFrameworkCore\.DbSet<>](https://docs.microsoft.com/en-us/dotnet/api/Microsoft.EntityFrameworkCore.DbSet-1 'Microsoft\.EntityFrameworkCore\.DbSet\`1') properties have a public setter, +they are automatically initialized when the instance of the derived context is created. + +Override the [Microsoft\.EntityFrameworkCore\.DbContext\.OnConfiguring\(Microsoft\.EntityFrameworkCore\.DbContextOptionsBuilder\)](https://docs.microsoft.com/en-us/dotnet/api/Microsoft.EntityFrameworkCore.DbContext.OnConfiguring#Microsoft_EntityFrameworkCore_DbContext_OnConfiguring_Microsoft_EntityFrameworkCore_DbContextOptionsBuilder_ 'Microsoft\.EntityFrameworkCore\.DbContext\.OnConfiguring\(Microsoft\.EntityFrameworkCore\.DbContextOptionsBuilder\)') method to configure the database (and +other options) to be used for the context. Alternatively, if you would rather perform configuration externally +instead of inline in your context, you can use [Microsoft\.EntityFrameworkCore\.DbContextOptionsBuilder<>](https://docs.microsoft.com/en-us/dotnet/api/Microsoft.EntityFrameworkCore.DbContextOptionsBuilder-1 'Microsoft\.EntityFrameworkCore\.DbContextOptionsBuilder\`1') +(or [Microsoft\.EntityFrameworkCore\.DbContextOptionsBuilder](https://docs.microsoft.com/en-us/dotnet/api/Microsoft.EntityFrameworkCore.DbContextOptionsBuilder 'Microsoft\.EntityFrameworkCore\.DbContextOptionsBuilder')) to externally create an instance of [Microsoft\.EntityFrameworkCore\.DbContextOptions<>](https://docs.microsoft.com/en-us/dotnet/api/Microsoft.EntityFrameworkCore.DbContextOptions-1 'Microsoft\.EntityFrameworkCore\.DbContextOptions\`1') +(or [Microsoft\.EntityFrameworkCore\.DbContextOptions](https://docs.microsoft.com/en-us/dotnet/api/Microsoft.EntityFrameworkCore.DbContextOptions 'Microsoft\.EntityFrameworkCore\.DbContextOptions')) and pass it to a base constructor of [Microsoft\.EntityFrameworkCore\.DbContext](https://docs.microsoft.com/en-us/dotnet/api/Microsoft.EntityFrameworkCore.DbContext 'Microsoft\.EntityFrameworkCore\.DbContext'). + +The model is discovered by running a set of conventions over the entity classes found in the +[Microsoft\.EntityFrameworkCore\.DbSet<>](https://docs.microsoft.com/en-us/dotnet/api/Microsoft.EntityFrameworkCore.DbSet-1 'Microsoft\.EntityFrameworkCore\.DbSet\`1') properties on the derived context. To further configure the model that +is discovered by convention, you can override the [Microsoft\.EntityFrameworkCore\.DbContext\.OnModelCreating\(Microsoft\.EntityFrameworkCore\.ModelBuilder\)](https://docs.microsoft.com/en-us/dotnet/api/Microsoft.EntityFrameworkCore.DbContext.OnModelCreating#Microsoft_EntityFrameworkCore_DbContext_OnModelCreating_Microsoft_EntityFrameworkCore_ModelBuilder_ 'Microsoft\.EntityFrameworkCore\.DbContext\.OnModelCreating\(Microsoft\.EntityFrameworkCore\.ModelBuilder\)') method. + +See [DbContext lifetime, configuration, and initialization](https://aka.ms/efcore-docs-dbcontext 'https://aka\.ms/efcore\-docs\-dbcontext'), +[Querying data with EF Core](https://aka.ms/efcore-docs-query 'https://aka\.ms/efcore\-docs\-query'), +[Changing tracking](https://aka.ms/efcore-docs-change-tracking 'https://aka\.ms/efcore\-docs\-change\-tracking'), and +[Saving data with EF Core](https://aka.ms/efcore-docs-saving-data 'https://aka\.ms/efcore\-docs\-saving\-data') for more information and examples. + +| Constructors | | +| :--- | :--- | +| [Pf2eDbContext\(\)](Pf2eDbContext.Pf2eDbContext.md#Pf2eModel.Pf2eDbContext.Pf2eDbContext() 'Pf2eModel\.Pf2eDbContext\.Pf2eDbContext\(\)') | Инициализирует новый экземпляр класса [Pf2eDbContext](Pf2eDbContext.md 'Pf2eModel\.Pf2eDbContext') без параметров\. | +| [Pf2eDbContext\(DbContextOptions<Pf2eDbContext>\)](Pf2eDbContext.Pf2eDbContext.md#Pf2eModel.Pf2eDbContext.Pf2eDbContext(Microsoft.EntityFrameworkCore.DbContextOptions_Pf2eModel.Pf2eDbContext_) 'Pf2eModel\.Pf2eDbContext\.Pf2eDbContext\(Microsoft\.EntityFrameworkCore\.DbContextOptions\\)') | Инициализирует новый экземпляр класса [Pf2eDbContext](Pf2eDbContext.md 'Pf2eModel\.Pf2eDbContext') с указанными параметрами конфигурации базы данных\. | + +| Fields | | +| :--- | :--- | +| [NameLength](Pf2eDbContext.NameLength.md 'Pf2eModel\.Pf2eDbContext\.NameLength') | Длина названия сущности\. | + +| Methods | | +| :--- | :--- | +| [BindEntity<T>\(EntityTypeBuilder<T>\)](Pf2eDbContext.BindEntity_T_(EntityTypeBuilder_T_).md 'Pf2eModel\.Pf2eDbContext\.BindEntity\\(Microsoft\.EntityFrameworkCore\.Metadata\.Builders\.EntityTypeBuilder\\)') | Устанавливает связь между сущностью и её корневой сущностью\. | +| [BindLocaleString<T>\(EntityTypeBuilder<T>, Expression<Func<T,LocaleString>>, bool\)](Pf2eDbContext.BindLocaleString_T_(EntityTypeBuilder_T_,Expression_Func_T,LocaleString__,bool).md 'Pf2eModel\.Pf2eDbContext\.BindLocaleString\\(Microsoft\.EntityFrameworkCore\.Metadata\.Builders\.EntityTypeBuilder\, System\.Linq\.Expressions\.Expression\\>, bool\)') | Устанавливает связь между сущностью и локализованной строкой\. | +| [DefineBase\(ModelBuilder\)](Pf2eDbContext.DefineBase(ModelBuilder).md 'Pf2eModel\.Pf2eDbContext\.DefineBase\(Microsoft\.EntityFrameworkCore\.ModelBuilder\)') | Определяет базовые сущности и их связи\. | +| [DefineCommon\(ModelBuilder\)](Pf2eDbContext.DefineCommon(ModelBuilder).md 'Pf2eModel\.Pf2eDbContext\.DefineCommon\(Microsoft\.EntityFrameworkCore\.ModelBuilder\)') | Определяет общие сущности и их связи\. | +| [DefineMethods\(ModelBuilder\)](Pf2eDbContext.DefineMethods(ModelBuilder).md 'Pf2eModel\.Pf2eDbContext\.DefineMethods\(Microsoft\.EntityFrameworkCore\.ModelBuilder\)') | Определяет методы, которые будут использоваться в запросах LINQ\. | +| [DefineStructure\(ModelBuilder\)](Pf2eDbContext.DefineStructure(ModelBuilder).md 'Pf2eModel\.Pf2eDbContext\.DefineStructure\(Microsoft\.EntityFrameworkCore\.ModelBuilder\)') | Определяет структуру сущностей и их связи\. | +| [LocaleSearch\(LocaleString, string\)](Pf2eDbContext.LocaleSearch(LocaleString,string).md 'Pf2eModel\.Pf2eDbContext\.LocaleSearch\(Pf2eModel\.Model\.Common\.I18n\.LocaleString, string\)') | CLR\-представление функции поиска в локализованной строке\. | +| [LocaleSearchArray\(LocaleString, IEnumerable<string>\)](Pf2eDbContext.LocaleSearchArray(LocaleString,IEnumerable_string_).md 'Pf2eModel\.Pf2eDbContext\.LocaleSearchArray\(Pf2eModel\.Model\.Common\.I18n\.LocaleString, System\.Collections\.Generic\.IEnumerable\\)') | CLR\-представление функции поиска в локализованной строке с массивом значений для поиска\. | +| [OnConfiguring\(DbContextOptionsBuilder\)](Pf2eDbContext.OnConfiguring(DbContextOptionsBuilder).md 'Pf2eModel\.Pf2eDbContext\.OnConfiguring\(Microsoft\.EntityFrameworkCore\.DbContextOptionsBuilder\)') | Override this method to configure the database \(and other options\) to be used for this context\. This method is called for each instance of the context that is created\. The base implementation does nothing\. | +| [OnModelCreating\(ModelBuilder\)](Pf2eDbContext.OnModelCreating(ModelBuilder).md 'Pf2eModel\.Pf2eDbContext\.OnModelCreating\(Microsoft\.EntityFrameworkCore\.ModelBuilder\)') | Override this method to further configure the model that was discovered by convention from the entity types exposed in [Microsoft\.EntityFrameworkCore\.DbSet<>](https://docs.microsoft.com/en-us/dotnet/api/Microsoft.EntityFrameworkCore.DbSet-1 'Microsoft\.EntityFrameworkCore\.DbSet\`1') properties on your derived context\. The resulting model may be cached and re\-used for subsequent instances of your derived context\. | diff --git a/Documentation/Pf2eModel/Pf2eModel.Model.Base.Keywords.md b/Documentation/Pf2eModel/Pf2eModel.Model.Base.Keywords.md new file mode 100644 index 0000000..d94c869 --- /dev/null +++ b/Documentation/Pf2eModel/Pf2eModel.Model.Base.Keywords.md @@ -0,0 +1,10 @@ +#### [Pf2eModel](index.md 'index') + +## Pf2eModel\.Model\.Base\.Keywords Namespace + +Классы, связанные с ключевыми словами, которые могут использоваться в разных типах сущностей\. + +| Classes | | +| :--- | :--- | +| [Keyword](Keyword.md 'Pf2eModel\.Model\.Base\.Keywords\.Keyword') | Ключевое слово\. | +| [KeywordAlias](KeywordAlias.md 'Pf2eModel\.Model\.Base\.Keywords\.KeywordAlias') | Синоним ключевого слова\. | diff --git a/Documentation/Pf2eModel/Pf2eModel.Model.Base.Source.md b/Documentation/Pf2eModel/Pf2eModel.Model.Base.Source.md new file mode 100644 index 0000000..3efaa69 --- /dev/null +++ b/Documentation/Pf2eModel/Pf2eModel.Model.Base.Source.md @@ -0,0 +1,10 @@ +#### [Pf2eModel](index.md 'index') + +## Pf2eModel\.Model\.Base\.Source Namespace + +Классы, связанные с источниками, которые могут использоваться в разных типах сущностей\. + +| Classes | | +| :--- | :--- | +| [EntitySource](EntitySource.md 'Pf2eModel\.Model\.Base\.Source\.EntitySource') | Связь между сущностью и источником\. | +| [Source](Source.md 'Pf2eModel\.Model\.Base\.Source\.Source') | Источник сущности\. | diff --git a/Documentation/Pf2eModel/Pf2eModel.Model.Base.Targets.md b/Documentation/Pf2eModel/Pf2eModel.Model.Base.Targets.md new file mode 100644 index 0000000..dec68e5 --- /dev/null +++ b/Documentation/Pf2eModel/Pf2eModel.Model.Base.Targets.md @@ -0,0 +1,10 @@ +#### [Pf2eModel](index.md 'index') + +## Pf2eModel\.Model\.Base\.Targets Namespace + +Классы, связанные с целями внешних ссылок, которые могут использоваться в разных типах сущностей\. + +| Classes | | +| :--- | :--- | +| [EntityExternal](EntityExternal.md 'Pf2eModel\.Model\.Base\.Targets\.EntityExternal') | Внешняя ссылка сущности\. | +| [ExternalTarget](ExternalTarget.md 'Pf2eModel\.Model\.Base\.Targets\.ExternalTarget') | Цель внешней ссылки\. | diff --git a/Documentation/Pf2eModel/Pf2eModel.Model.Base.md b/Documentation/Pf2eModel/Pf2eModel.Model.Base.md new file mode 100644 index 0000000..1fe05fb --- /dev/null +++ b/Documentation/Pf2eModel/Pf2eModel.Model.Base.md @@ -0,0 +1,11 @@ +#### [Pf2eModel](index.md 'index') + +## Pf2eModel\.Model\.Base Namespace + +Описание корневой сущности модели: класса [Entity](Entity.md 'Pf2eModel\.Model\.Base\.Entity') и его прямых связей\. + +| Classes | | +| :--- | :--- | +| [Entity](Entity.md 'Pf2eModel\.Model\.Base\.Entity') | Корневая сущность\. | +| [EntityAlias](EntityAlias.md 'Pf2eModel\.Model\.Base\.EntityAlias') | Алиас сущности\. | +| [LegacyRemaster](LegacyRemaster.md 'Pf2eModel\.Model\.Base\.LegacyRemaster') | Связь устаревших и обновлённых сущностей | diff --git a/Documentation/Pf2eModel/Pf2eModel.Model.Common.I18n.md b/Documentation/Pf2eModel/Pf2eModel.Model.Common.I18n.md new file mode 100644 index 0000000..90742fb --- /dev/null +++ b/Documentation/Pf2eModel/Pf2eModel.Model.Common.I18n.md @@ -0,0 +1,15 @@ +#### [Pf2eModel](index.md 'index') + +## Pf2eModel\.Model\.Common\.I18n Namespace + +Классы, связанные с интернационализацией \(i18n\) модели\. + +| Classes | | +| :--- | :--- | +| [LocaleExtension](LocaleExtension.md 'Pf2eModel\.Model\.Common\.I18n\.LocaleExtension') | Расширения для работы с локализацией\. | +| [LocaleItem](LocaleItem.md 'Pf2eModel\.Model\.Common\.I18n\.LocaleItem') | Элемент локализации\. | +| [LocaleString](LocaleString.md 'Pf2eModel\.Model\.Common\.I18n\.LocaleString') | Локализованная строка\. | + +| Enums | | +| :--- | :--- | +| [LocaleType](LocaleType.md 'Pf2eModel\.Model\.Common\.I18n\.LocaleType') | Тип локализации\. | diff --git a/Documentation/Pf2eModel/Pf2eModel.Model.Common.md b/Documentation/Pf2eModel/Pf2eModel.Model.Common.md new file mode 100644 index 0000000..8c5dc99 --- /dev/null +++ b/Documentation/Pf2eModel/Pf2eModel.Model.Common.md @@ -0,0 +1,10 @@ +#### [Pf2eModel](index.md 'index') + +## Pf2eModel\.Model\.Common Namespace + +Общее классы на которые могут ссылаться разные типа\. + +| Classes | | +| :--- | :--- | +| [Frequency](Frequency.md 'Pf2eModel\.Model\.Common\.Frequency') | Частота использования\. | +| [Training](Training.md 'Pf2eModel\.Model\.Common\.Training') | Изучаемая способность\. | diff --git a/Documentation/Pf2eModel/Pf2eModel.Model.Enum.md b/Documentation/Pf2eModel/Pf2eModel.Model.Enum.md new file mode 100644 index 0000000..45bce0b --- /dev/null +++ b/Documentation/Pf2eModel/Pf2eModel.Model.Enum.md @@ -0,0 +1,30 @@ +#### [Pf2eModel](index.md 'index') + +## Pf2eModel\.Model\.Enum Namespace + +Описание всех перечислений, использующихся в модели\. + +| Enums | | +| :--- | :--- | +| [ActionCategory](ActionCategory.md 'Pf2eModel\.Model\.Enum\.ActionCategory') | Тип действия\. | +| [ActionEnum](ActionEnum.md 'Pf2eModel\.Model\.Enum\.ActionEnum') | Перечиленение количества действий\. | +| [AttributeValues](AttributeValues.md 'Pf2eModel\.Model\.Enum\.AttributeValues') | Перечисление значений атрибутов\. | +| [ClassProgressionType](ClassProgressionType.md 'Pf2eModel\.Model\.Enum\.ClassProgressionType') | Тип элемента прогрессии класса\. | +| [ConditionGroup](ConditionGroup.md 'Pf2eModel\.Model\.Enum\.ConditionGroup') | Тип состояния | +| [DeityCategory](DeityCategory.md 'Pf2eModel\.Model\.Enum\.DeityCategory') | Тип божества\. | +| [DeityFonts](DeityFonts.md 'Pf2eModel\.Model\.Enum\.DeityFonts') | Тип божественной силы\. | +| [DeitySanctification](DeitySanctification.md 'Pf2eModel\.Model\.Enum\.DeitySanctification') | Тип освящения божества\. | +| [ElementEnum](ElementEnum.md 'Pf2eModel\.Model\.Enum\.ElementEnum') | Перечисление элементов\. | +| [EntityRarity](EntityRarity.md 'Pf2eModel\.Model\.Enum\.EntityRarity') | Перечисление редкости сущности\. | +| [EntityType](EntityType.md 'Pf2eModel\.Model\.Enum\.EntityType') | Тип сущности\. | +| [FeatCategory](FeatCategory.md 'Pf2eModel\.Model\.Enum\.FeatCategory') | Категория черты\. | +| [SizeEnum](SizeEnum.md 'Pf2eModel\.Model\.Enum\.SizeEnum') | Размер\. | +| [SourceCategory](SourceCategory.md 'Pf2eModel\.Model\.Enum\.SourceCategory') | Перечисление категорий источников\. | +| [SpellAreaType](SpellAreaType.md 'Pf2eModel\.Model\.Enum\.SpellAreaType') | Тип области заклинания\. | +| [SpellDamageCategory](SpellDamageCategory.md 'Pf2eModel\.Model\.Enum\.SpellDamageCategory') | Тип урона заклинания\. | +| [SpellDamageKinds](SpellDamageKinds.md 'Pf2eModel\.Model\.Enum\.SpellDamageKinds') | Тип урона заклинания\. | +| [SpellTradition](SpellTradition.md 'Pf2eModel\.Model\.Enum\.SpellTradition') | Традиция заклинания\. | +| [TrainingRank](TrainingRank.md 'Pf2eModel\.Model\.Enum\.TrainingRank') | Ранг тренировки\. | +| [TrainingType](TrainingType.md 'Pf2eModel\.Model\.Enum\.TrainingType') | Тип тренировки\. | +| [TraitType](TraitType.md 'Pf2eModel\.Model\.Enum\.TraitType') | Тип признака\. | +| [VisionEnum](VisionEnum.md 'Pf2eModel\.Model\.Enum\.VisionEnum') | Перечисление типов зрения\. | diff --git a/Documentation/Pf2eModel/Pf2eModel.Model.Structure.AncestryRelation.md b/Documentation/Pf2eModel/Pf2eModel.Model.Structure.AncestryRelation.md new file mode 100644 index 0000000..8dc63d0 --- /dev/null +++ b/Documentation/Pf2eModel/Pf2eModel.Model.Structure.AncestryRelation.md @@ -0,0 +1,11 @@ +#### [Pf2eModel](index.md 'index') + +## Pf2eModel\.Model\.Structure\.AncestryRelation Namespace + +Классы, описывающие связи класса [Ancestry](Ancestry.md 'Pf2eModel\.Model\.Structure\.Ancestry')\. + +| Classes | | +| :--- | :--- | +| [AncestryBoost](AncestryBoost.md 'Pf2eModel\.Model\.Structure\.AncestryRelation\.AncestryBoost') | Элемент набора повышений атрибутов для родословной\. | +| [AncestryItem](AncestryItem.md 'Pf2eModel\.Model\.Structure\.AncestryRelation\.AncestryItem') | Связь между родословной и сущностью\. | +| [AncestryLanguage](AncestryLanguage.md 'Pf2eModel\.Model\.Structure\.AncestryRelation\.AncestryLanguage') | Связь между родословной и языком\. | diff --git a/Documentation/Pf2eModel/Pf2eModel.Model.Structure.ArchetypeRelation.md b/Documentation/Pf2eModel/Pf2eModel.Model.Structure.ArchetypeRelation.md new file mode 100644 index 0000000..910e91e --- /dev/null +++ b/Documentation/Pf2eModel/Pf2eModel.Model.Structure.ArchetypeRelation.md @@ -0,0 +1,9 @@ +#### [Pf2eModel](index.md 'index') + +## Pf2eModel\.Model\.Structure\.ArchetypeRelation Namespace + +Классы, описывающие связи класса [Archetype](Archetype.md 'Pf2eModel\.Model\.Structure\.Archetype')\. + +| Classes | | +| :--- | :--- | +| [ArchetypeFeats](ArchetypeFeats.md 'Pf2eModel\.Model\.Structure\.ArchetypeRelation\.ArchetypeFeats') | Связь между архетипом и его чертами\. | diff --git a/Documentation/Pf2eModel/Pf2eModel.Model.Structure.BackgroundRelation.md b/Documentation/Pf2eModel/Pf2eModel.Model.Structure.BackgroundRelation.md new file mode 100644 index 0000000..6dcfcec --- /dev/null +++ b/Documentation/Pf2eModel/Pf2eModel.Model.Structure.BackgroundRelation.md @@ -0,0 +1,11 @@ +#### [Pf2eModel](index.md 'index') + +## Pf2eModel\.Model\.Structure\.BackgroundRelation Namespace + +Классы, описывающие связи класса [Background](Background.md 'Pf2eModel\.Model\.Structure\.Background')\. + +| Classes | | +| :--- | :--- | +| [BackgroundBoost](BackgroundBoost.md 'Pf2eModel\.Model\.Structure\.BackgroundRelation\.BackgroundBoost') | Элемент набора атрибутов для предыстории\. | +| [BackgroundItem](BackgroundItem.md 'Pf2eModel\.Model\.Structure\.BackgroundRelation\.BackgroundItem') | Элемент предыстории, который может быть способностью, навыком или другим элементом, связанным с предысторией\. | +| [BackgroundTraining](BackgroundTraining.md 'Pf2eModel\.Model\.Structure\.BackgroundRelation\.BackgroundTraining') | Элемент набора связей между предысторией и тренируемым навыком\. | diff --git a/Documentation/Pf2eModel/Pf2eModel.Model.Structure.ClassRelation.md b/Documentation/Pf2eModel/Pf2eModel.Model.Structure.ClassRelation.md new file mode 100644 index 0000000..b22deff --- /dev/null +++ b/Documentation/Pf2eModel/Pf2eModel.Model.Structure.ClassRelation.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') + +## Pf2eModel\.Model\.Structure\.ClassRelation Namespace + +Классы, описывающие связи класса [Class](Class.md 'Pf2eModel\.Model\.Structure\.Class')\. + +| Classes | | +| :--- | :--- | +| [ClassKeyAttribute](ClassKeyAttribute.md 'Pf2eModel\.Model\.Structure\.ClassRelation\.ClassKeyAttribute') | Набор ключевых атрибутов класса\. | +| [ClassProgression](ClassProgression.md 'Pf2eModel\.Model\.Structure\.ClassRelation\.ClassProgression') | Элемент прогрессии класса\. | +| [ClassTraining](ClassTraining.md 'Pf2eModel\.Model\.Structure\.ClassRelation\.ClassTraining') | Набор элементов, связывающий класс и тренируемый навык\. | +| [SubclassProvidedEntities](SubclassProvidedEntities.md 'Pf2eModel\.Model\.Structure\.ClassRelation\.SubclassProvidedEntities') | Элемент, связывающий сущность с подклассом\. | +| [SubclassTrainings](SubclassTrainings.md 'Pf2eModel\.Model\.Structure\.ClassRelation\.SubclassTrainings') | Связь между подклассами и тренировками\. | diff --git a/Documentation/Pf2eModel/Pf2eModel.Model.Structure.DeityRelation.md b/Documentation/Pf2eModel/Pf2eModel.Model.Structure.DeityRelation.md new file mode 100644 index 0000000..9ed2bc7 --- /dev/null +++ b/Documentation/Pf2eModel/Pf2eModel.Model.Structure.DeityRelation.md @@ -0,0 +1,12 @@ +#### [Pf2eModel](index.md 'index') + +## Pf2eModel\.Model\.Structure\.DeityRelation Namespace + +Классы, описывающие связи класса [Deity](Deity.md 'Pf2eModel\.Model\.Structure\.Deity')\. + +| Classes | | +| :--- | :--- | +| [DeityAttribute](DeityAttribute.md 'Pf2eModel\.Model\.Structure\.DeityRelation\.DeityAttribute') | Элемент отношения божества и атрибута\. | +| [DeityDomain](DeityDomain.md 'Pf2eModel\.Model\.Structure\.DeityRelation\.DeityDomain') | Элемент отношения божества и домена\. | +| [DeitySpell](DeitySpell.md 'Pf2eModel\.Model\.Structure\.DeityRelation\.DeitySpell') | Связь божества и заклинания\. | +| [DeityWeapon](DeityWeapon.md 'Pf2eModel\.Model\.Structure\.DeityRelation\.DeityWeapon') | Связь божества с оружием\. | diff --git a/Documentation/Pf2eModel/Pf2eModel.Model.Structure.FeatRelation.md b/Documentation/Pf2eModel/Pf2eModel.Model.Structure.FeatRelation.md new file mode 100644 index 0000000..3af1f3e --- /dev/null +++ b/Documentation/Pf2eModel/Pf2eModel.Model.Structure.FeatRelation.md @@ -0,0 +1,9 @@ +#### [Pf2eModel](index.md 'index') + +## Pf2eModel\.Model\.Structure\.FeatRelation Namespace + +Классы, описывающие связи класса [Feat](Feat.md 'Pf2eModel\.Model\.Structure\.Feat')\. + +| Classes | | +| :--- | :--- | +| [FeatPrerequisite](FeatPrerequisite.md 'Pf2eModel\.Model\.Structure\.FeatRelation\.FeatPrerequisite') | Предварительное требование для черты\. | diff --git a/Documentation/Pf2eModel/Pf2eModel.Model.Structure.RitualRelation.md b/Documentation/Pf2eModel/Pf2eModel.Model.Structure.RitualRelation.md new file mode 100644 index 0000000..299dc72 --- /dev/null +++ b/Documentation/Pf2eModel/Pf2eModel.Model.Structure.RitualRelation.md @@ -0,0 +1,10 @@ +#### [Pf2eModel](index.md 'index') + +## Pf2eModel\.Model\.Structure\.RitualRelation Namespace + +Классы, описывающие связи класса [Ritual](Ritual.md 'Pf2eModel\.Model\.Structure\.Ritual')\. + +| Classes | | +| :--- | :--- | +| [RitualArea](RitualArea.md 'Pf2eModel\.Model\.Structure\.RitualRelation\.RitualArea') | Область действия ритуала\. | +| [RitualCheck](RitualCheck.md 'Pf2eModel\.Model\.Structure\.RitualRelation\.RitualCheck') | Проверка для ритуала\. | diff --git a/Documentation/Pf2eModel/Pf2eModel.Model.Structure.SpellRelation.md b/Documentation/Pf2eModel/Pf2eModel.Model.Structure.SpellRelation.md new file mode 100644 index 0000000..8d37ad4 --- /dev/null +++ b/Documentation/Pf2eModel/Pf2eModel.Model.Structure.SpellRelation.md @@ -0,0 +1,11 @@ +#### [Pf2eModel](index.md 'index') + +## Pf2eModel\.Model\.Structure\.SpellRelation Namespace + +Классы, описывающие связи класса [Spell](Spell.md 'Pf2eModel\.Model\.Structure\.Spell')\. + +| Classes | | +| :--- | :--- | +| [SpellArea](SpellArea.md 'Pf2eModel\.Model\.Structure\.SpellRelation\.SpellArea') | Область заклинания\. | +| [SpellDamage](SpellDamage.md 'Pf2eModel\.Model\.Structure\.SpellRelation\.SpellDamage') | Урон заклинания\. | +| [SpellDefense](SpellDefense.md 'Pf2eModel\.Model\.Structure\.SpellRelation\.SpellDefense') | Защита от заклинания\. | diff --git a/Documentation/Pf2eModel/Pf2eModel.Model.Structure.md b/Documentation/Pf2eModel/Pf2eModel.Model.Structure.md new file mode 100644 index 0000000..cb0d2ca --- /dev/null +++ b/Documentation/Pf2eModel/Pf2eModel.Model.Structure.md @@ -0,0 +1,25 @@ +#### [Pf2eModel](index.md 'index') + +## Pf2eModel\.Model\.Structure Namespace + +Основные типы, которые связаны 1\-к\-1 с [Entity](Entity.md 'Pf2eModel\.Model\.Base\.Entity')\. +Для указания этой связи используется интерфейс [IEntity](IEntity.md 'Pf2eModel\.Model\.IEntity')\. + +| Classes | | +| :--- | :--- | +| [Action](Action.md 'Pf2eModel\.Model\.Structure\.Action') | Действие\. | +| [Ancestry](Ancestry.md 'Pf2eModel\.Model\.Structure\.Ancestry') | Родословная\. | +| [Archetype](Archetype.md 'Pf2eModel\.Model\.Structure\.Archetype') | Архетип\. | +| [Background](Background.md 'Pf2eModel\.Model\.Structure\.Background') | Предыстория\. | +| [Class](Class.md 'Pf2eModel\.Model\.Structure\.Class') | Класс\. | +| [Condition](Condition.md 'Pf2eModel\.Model\.Structure\.Condition') | Состояние\. | +| [Deity](Deity.md 'Pf2eModel\.Model\.Structure\.Deity') | Божество\. | +| [Feat](Feat.md 'Pf2eModel\.Model\.Structure\.Feat') | Способность\. | +| [Heritage](Heritage.md 'Pf2eModel\.Model\.Structure\.Heritage') | Наследие\. | +| [Language](Language.md 'Pf2eModel\.Model\.Structure\.Language') | Язык\. | +| [Ritual](Ritual.md 'Pf2eModel\.Model\.Structure\.Ritual') | Ритуал\. | +| [Rule](Rule.md 'Pf2eModel\.Model\.Structure\.Rule') | Правило\. | +| [Spell](Spell.md 'Pf2eModel\.Model\.Structure\.Spell') | Заклинание\. | +| [Subclass](Subclass.md 'Pf2eModel\.Model\.Structure\.Subclass') | Подкласс\. | +| [SubclassGroup](SubclassGroup.md 'Pf2eModel\.Model\.Structure\.SubclassGroup') | Группа подклассов\. | +| [Trait](Trait.md 'Pf2eModel\.Model\.Structure\.Trait') | Признак\. | diff --git a/Documentation/Pf2eModel/Pf2eModel.Model.md b/Documentation/Pf2eModel/Pf2eModel.Model.md new file mode 100644 index 0000000..e637d93 --- /dev/null +++ b/Documentation/Pf2eModel/Pf2eModel.Model.md @@ -0,0 +1,9 @@ +#### [Pf2eModel](index.md 'index') + +## Pf2eModel\.Model Namespace + +Модель классов ORM EntityFramework\. + +| Interfaces | | +| :--- | :--- | +| [IEntity](IEntity.md 'Pf2eModel\.Model\.IEntity') | Интерфейс сущностей структуры\. | diff --git a/Documentation/Pf2eModel/Pf2eModel.md b/Documentation/Pf2eModel/Pf2eModel.md new file mode 100644 index 0000000..421dc64 --- /dev/null +++ b/Documentation/Pf2eModel/Pf2eModel.md @@ -0,0 +1,11 @@ +#### [Pf2eModel](index.md 'index') + +## Pf2eModel Namespace + +Набор классов модели ORM EntityFramework\. + +| Classes | | +| :--- | :--- | +| [EfCleanHelper](EfCleanHelper.md 'Pf2eModel\.EfCleanHelper') | Класс, обеспецивающий общий способ для отчистки данных таблиц\. Источник: https://www\.codeproject\.com/Articles/5339402/Delete\-All\-Rows\-in\-Entity\-Framework\-Core\-6 | +| [EntityOfTypeAttribute](EntityOfTypeAttribute.md 'Pf2eModel\.EntityOfTypeAttribute') | Аттрибут, указывающий тип сущности\. | +| [Pf2eDbContext](Pf2eDbContext.md 'Pf2eModel\.Pf2eDbContext') | A DbContext instance represents a session with the database and can be used to query and save instances of your entities\. DbContext is a combination of the Unit Of Work and Repository patterns\. | diff --git a/Documentation/Pf2eModel/Ritual.Area.md b/Documentation/Pf2eModel/Ritual.Area.md new file mode 100644 index 0000000..acda4c7 --- /dev/null +++ b/Documentation/Pf2eModel/Ritual.Area.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Ritual](Ritual.md 'Pf2eModel\.Model\.Structure\.Ritual') + +## Ritual\.Area Property + +Коллекция областей ритуала\. + +```csharp +public Pf2eModel.Model.Structure.RitualRelation.RitualArea? Area { get; set; } +``` + +#### Property Value +[RitualArea](RitualArea.md 'Pf2eModel\.Model\.Structure\.RitualRelation\.RitualArea') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Ritual.CastTime.md b/Documentation/Pf2eModel/Ritual.CastTime.md new file mode 100644 index 0000000..2e28c6c --- /dev/null +++ b/Documentation/Pf2eModel/Ritual.CastTime.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Ritual](Ritual.md 'Pf2eModel\.Model\.Structure\.Ritual') + +## Ritual\.CastTime Property + +Продолжительность ритуала в секундах\. + +```csharp +public int CastTime { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Ritual.Checks.md b/Documentation/Pf2eModel/Ritual.Checks.md new file mode 100644 index 0000000..71b783f --- /dev/null +++ b/Documentation/Pf2eModel/Ritual.Checks.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Ritual](Ritual.md 'Pf2eModel\.Model\.Structure\.Ritual') + +## Ritual\.Checks Property + +Коллекция проверок ритуала\. + +```csharp +public System.Collections.Generic.ICollection Checks { get; set; } +``` + +#### Property Value +[System\.Collections\.Generic\.ICollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1')[RitualCheck](RitualCheck.md 'Pf2eModel\.Model\.Structure\.RitualRelation\.RitualCheck')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Ritual.Cost.md b/Documentation/Pf2eModel/Ritual.Cost.md new file mode 100644 index 0000000..575cc67 --- /dev/null +++ b/Documentation/Pf2eModel/Ritual.Cost.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Ritual](Ritual.md 'Pf2eModel\.Model\.Structure\.Ritual') + +## Ritual\.Cost Property + +Строка, описывающая стоимость ритуала\. + +```csharp +public Pf2eModel.Model.Common.I18n.LocaleString? Cost { get; set; } +``` + +#### Property Value +[LocaleString](LocaleString.md 'Pf2eModel\.Model\.Common\.I18n\.LocaleString') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Ritual.Duration.md b/Documentation/Pf2eModel/Ritual.Duration.md new file mode 100644 index 0000000..8056276 --- /dev/null +++ b/Documentation/Pf2eModel/Ritual.Duration.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Ritual](Ritual.md 'Pf2eModel\.Model\.Structure\.Ritual') + +## Ritual\.Duration Property + +Время действия эффекта ритуала в секундах\. + +```csharp +public int Duration { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Ritual.Elements.md b/Documentation/Pf2eModel/Ritual.Elements.md new file mode 100644 index 0000000..8fae9dc --- /dev/null +++ b/Documentation/Pf2eModel/Ritual.Elements.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Ritual](Ritual.md 'Pf2eModel\.Model\.Structure\.Ritual') + +## Ritual\.Elements Property + +Элементы ритуала\. + +```csharp +public Pf2eModel.Model.Enum.ElementEnum[] Elements { get; set; } +``` + +#### Property Value +[ElementEnum](ElementEnum.md 'Pf2eModel\.Model\.Enum\.ElementEnum')[\[\]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System\.Array') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Ritual.Entity.md b/Documentation/Pf2eModel/Ritual.Entity.md new file mode 100644 index 0000000..240c4a3 --- /dev/null +++ b/Documentation/Pf2eModel/Ritual.Entity.md @@ -0,0 +1,15 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Ritual](Ritual.md 'Pf2eModel\.Model\.Structure\.Ritual') + +## Ritual\.Entity Property + +Корневая сущность\. + +```csharp +public Pf2eModel.Model.Base.Entity Entity { get; set; } +``` + +Implements [Entity](IEntity.Entity.md 'Pf2eModel\.Model\.IEntity\.Entity') + +#### Property Value +[Entity](Entity.md 'Pf2eModel\.Model\.Base\.Entity') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Ritual.Id.md b/Documentation/Pf2eModel/Ritual.Id.md new file mode 100644 index 0000000..53cc7eb --- /dev/null +++ b/Documentation/Pf2eModel/Ritual.Id.md @@ -0,0 +1,15 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Ritual](Ritual.md 'Pf2eModel\.Model\.Structure\.Ritual') + +## Ritual\.Id Property + +Идентификатор сущности\. + +```csharp +public int Id { get; set; } +``` + +Implements [Id](IEntity.Id.md 'Pf2eModel\.Model\.IEntity\.Id') + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Ritual.Level.md b/Documentation/Pf2eModel/Ritual.Level.md new file mode 100644 index 0000000..48801a1 --- /dev/null +++ b/Documentation/Pf2eModel/Ritual.Level.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Ritual](Ritual.md 'Pf2eModel\.Model\.Structure\.Ritual') + +## Ritual\.Level Property + +Уровень ритуала\. + +```csharp +public int Level { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Ritual.PrimaryCheckRank.md b/Documentation/Pf2eModel/Ritual.PrimaryCheckRank.md new file mode 100644 index 0000000..d824965 --- /dev/null +++ b/Documentation/Pf2eModel/Ritual.PrimaryCheckRank.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Ritual](Ritual.md 'Pf2eModel\.Model\.Structure\.Ritual') + +## Ritual\.PrimaryCheckRank Property + +Ранг основной проверки\. + +```csharp +public Pf2eModel.Model.Enum.TrainingRank PrimaryCheckRank { get; set; } +``` + +#### Property Value +[TrainingRank](TrainingRank.md 'Pf2eModel\.Model\.Enum\.TrainingRank') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Ritual.PrimaryCheckSuffix.md b/Documentation/Pf2eModel/Ritual.PrimaryCheckSuffix.md new file mode 100644 index 0000000..10b7d2c --- /dev/null +++ b/Documentation/Pf2eModel/Ritual.PrimaryCheckSuffix.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Ritual](Ritual.md 'Pf2eModel\.Model\.Structure\.Ritual') + +## Ritual\.PrimaryCheckSuffix Property + +Дополнительная информация об основной проверки\. + +```csharp +public Pf2eModel.Model.Common.I18n.LocaleString? PrimaryCheckSuffix { get; set; } +``` + +#### Property Value +[LocaleString](LocaleString.md 'Pf2eModel\.Model\.Common\.I18n\.LocaleString') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Ritual.Range.md b/Documentation/Pf2eModel/Ritual.Range.md new file mode 100644 index 0000000..b1b31d1 --- /dev/null +++ b/Documentation/Pf2eModel/Ritual.Range.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Ritual](Ritual.md 'Pf2eModel\.Model\.Structure\.Ritual') + +## Ritual\.Range Property + +Дальнность ритуала в футах\. + +```csharp +public int Range { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Ritual.RangeString.md b/Documentation/Pf2eModel/Ritual.RangeString.md new file mode 100644 index 0000000..0e99385 --- /dev/null +++ b/Documentation/Pf2eModel/Ritual.RangeString.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Ritual](Ritual.md 'Pf2eModel\.Model\.Structure\.Ritual') + +## Ritual\.RangeString Property + +Строка, описывающая дальность ритуала\. + +```csharp +public Pf2eModel.Model.Common.I18n.LocaleString? RangeString { get; set; } +``` + +#### Property Value +[LocaleString](LocaleString.md 'Pf2eModel\.Model\.Common\.I18n\.LocaleString') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Ritual.Requirement.md b/Documentation/Pf2eModel/Ritual.Requirement.md new file mode 100644 index 0000000..2a0c4bc --- /dev/null +++ b/Documentation/Pf2eModel/Ritual.Requirement.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Ritual](Ritual.md 'Pf2eModel\.Model\.Structure\.Ritual') + +## Ritual\.Requirement Property + +Строка, описывающая требования к ритуалу\. + +```csharp +public Pf2eModel.Model.Common.I18n.LocaleString? Requirement { get; set; } +``` + +#### Property Value +[LocaleString](LocaleString.md 'Pf2eModel\.Model\.Common\.I18n\.LocaleString') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Ritual.SecondaryCasters.md b/Documentation/Pf2eModel/Ritual.SecondaryCasters.md new file mode 100644 index 0000000..3d2e297 --- /dev/null +++ b/Documentation/Pf2eModel/Ritual.SecondaryCasters.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Ritual](Ritual.md 'Pf2eModel\.Model\.Structure\.Ritual') + +## Ritual\.SecondaryCasters Property + +Количество дополнительных заклинателей, необходимых для ритуала\. + +```csharp +public int SecondaryCasters { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Ritual.SecondaryCastersMax.md b/Documentation/Pf2eModel/Ritual.SecondaryCastersMax.md new file mode 100644 index 0000000..904c629 --- /dev/null +++ b/Documentation/Pf2eModel/Ritual.SecondaryCastersMax.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Ritual](Ritual.md 'Pf2eModel\.Model\.Structure\.Ritual') + +## Ritual\.SecondaryCastersMax Property + +Максимальное количество дополнительных заклинателей, необходимых для ритуала\. + +```csharp +public int SecondaryCastersMax { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Ritual.SecondaryCastersSuffix.md b/Documentation/Pf2eModel/Ritual.SecondaryCastersSuffix.md new file mode 100644 index 0000000..ea8229d --- /dev/null +++ b/Documentation/Pf2eModel/Ritual.SecondaryCastersSuffix.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Ritual](Ritual.md 'Pf2eModel\.Model\.Structure\.Ritual') + +## Ritual\.SecondaryCastersSuffix Property + +Дополнительная информация о дополнительных заклинателях\. + +```csharp +public Pf2eModel.Model.Common.I18n.LocaleString? SecondaryCastersSuffix { get; set; } +``` + +#### Property Value +[LocaleString](LocaleString.md 'Pf2eModel\.Model\.Common\.I18n\.LocaleString') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Ritual.Target.md b/Documentation/Pf2eModel/Ritual.Target.md new file mode 100644 index 0000000..77e85bd --- /dev/null +++ b/Documentation/Pf2eModel/Ritual.Target.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Ritual](Ritual.md 'Pf2eModel\.Model\.Structure\.Ritual') + +## Ritual\.Target Property + +Строка, описывающая цель ритуала\. + +```csharp +public Pf2eModel.Model.Common.I18n.LocaleString? Target { get; set; } +``` + +#### Property Value +[LocaleString](LocaleString.md 'Pf2eModel\.Model\.Common\.I18n\.LocaleString') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Ritual.md b/Documentation/Pf2eModel/Ritual.md new file mode 100644 index 0000000..0b18dd7 --- /dev/null +++ b/Documentation/Pf2eModel/Ritual.md @@ -0,0 +1,35 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure') + +## Ritual Class + +Ритуал\. + +```csharp +public class Ritual : Pf2eModel.Model.IEntity +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 Ritual + +Implements [IEntity](IEntity.md 'Pf2eModel\.Model\.IEntity') + +| Properties | | +| :--- | :--- | +| [Area](Ritual.Area.md 'Pf2eModel\.Model\.Structure\.Ritual\.Area') | Коллекция областей ритуала\. | +| [CastTime](Ritual.CastTime.md 'Pf2eModel\.Model\.Structure\.Ritual\.CastTime') | Продолжительность ритуала в секундах\. | +| [Checks](Ritual.Checks.md 'Pf2eModel\.Model\.Structure\.Ritual\.Checks') | Коллекция проверок ритуала\. | +| [Cost](Ritual.Cost.md 'Pf2eModel\.Model\.Structure\.Ritual\.Cost') | Строка, описывающая стоимость ритуала\. | +| [Duration](Ritual.Duration.md 'Pf2eModel\.Model\.Structure\.Ritual\.Duration') | Время действия эффекта ритуала в секундах\. | +| [Elements](Ritual.Elements.md 'Pf2eModel\.Model\.Structure\.Ritual\.Elements') | Элементы ритуала\. | +| [Entity](Ritual.Entity.md 'Pf2eModel\.Model\.Structure\.Ritual\.Entity') | Корневая сущность\. | +| [Id](Ritual.Id.md 'Pf2eModel\.Model\.Structure\.Ritual\.Id') | Идентификатор сущности\. | +| [Level](Ritual.Level.md 'Pf2eModel\.Model\.Structure\.Ritual\.Level') | Уровень ритуала\. | +| [PrimaryCheckRank](Ritual.PrimaryCheckRank.md 'Pf2eModel\.Model\.Structure\.Ritual\.PrimaryCheckRank') | Ранг основной проверки\. | +| [PrimaryCheckSuffix](Ritual.PrimaryCheckSuffix.md 'Pf2eModel\.Model\.Structure\.Ritual\.PrimaryCheckSuffix') | Дополнительная информация об основной проверки\. | +| [Range](Ritual.Range.md 'Pf2eModel\.Model\.Structure\.Ritual\.Range') | Дальнность ритуала в футах\. | +| [RangeString](Ritual.RangeString.md 'Pf2eModel\.Model\.Structure\.Ritual\.RangeString') | Строка, описывающая дальность ритуала\. | +| [Requirement](Ritual.Requirement.md 'Pf2eModel\.Model\.Structure\.Ritual\.Requirement') | Строка, описывающая требования к ритуалу\. | +| [SecondaryCasters](Ritual.SecondaryCasters.md 'Pf2eModel\.Model\.Structure\.Ritual\.SecondaryCasters') | Количество дополнительных заклинателей, необходимых для ритуала\. | +| [SecondaryCastersMax](Ritual.SecondaryCastersMax.md 'Pf2eModel\.Model\.Structure\.Ritual\.SecondaryCastersMax') | Максимальное количество дополнительных заклинателей, необходимых для ритуала\. | +| [SecondaryCastersSuffix](Ritual.SecondaryCastersSuffix.md 'Pf2eModel\.Model\.Structure\.Ritual\.SecondaryCastersSuffix') | Дополнительная информация о дополнительных заклинателях\. | +| [Target](Ritual.Target.md 'Pf2eModel\.Model\.Structure\.Ritual\.Target') | Строка, описывающая цель ритуала\. | diff --git a/Documentation/Pf2eModel/RitualArea.Details.md b/Documentation/Pf2eModel/RitualArea.Details.md new file mode 100644 index 0000000..2496938 --- /dev/null +++ b/Documentation/Pf2eModel/RitualArea.Details.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.RitualRelation](Pf2eModel.Model.Structure.RitualRelation.md 'Pf2eModel\.Model\.Structure\.RitualRelation').[RitualArea](RitualArea.md 'Pf2eModel\.Model\.Structure\.RitualRelation\.RitualArea') + +## RitualArea\.Details Property + +Описание области действия ритуала\. + +```csharp +public Pf2eModel.Model.Common.I18n.LocaleString? Details { get; set; } +``` + +#### Property Value +[LocaleString](LocaleString.md 'Pf2eModel\.Model\.Common\.I18n\.LocaleString') \ No newline at end of file diff --git a/Documentation/Pf2eModel/RitualArea.Ritual.md b/Documentation/Pf2eModel/RitualArea.Ritual.md new file mode 100644 index 0000000..5c6ed4c --- /dev/null +++ b/Documentation/Pf2eModel/RitualArea.Ritual.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.RitualRelation](Pf2eModel.Model.Structure.RitualRelation.md 'Pf2eModel\.Model\.Structure\.RitualRelation').[RitualArea](RitualArea.md 'Pf2eModel\.Model\.Structure\.RitualRelation\.RitualArea') + +## RitualArea\.Ritual Property + +Ритуал, к которому относится область действия\. + +```csharp +public virtual Pf2eModel.Model.Structure.Ritual Ritual { get; set; } +``` + +#### Property Value +[Ritual](Ritual.md 'Pf2eModel\.Model\.Structure\.Ritual') \ No newline at end of file diff --git a/Documentation/Pf2eModel/RitualArea.RitualId.md b/Documentation/Pf2eModel/RitualArea.RitualId.md new file mode 100644 index 0000000..46a0bf7 --- /dev/null +++ b/Documentation/Pf2eModel/RitualArea.RitualId.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.RitualRelation](Pf2eModel.Model.Structure.RitualRelation.md 'Pf2eModel\.Model\.Structure\.RitualRelation').[RitualArea](RitualArea.md 'Pf2eModel\.Model\.Structure\.RitualRelation\.RitualArea') + +## RitualArea\.RitualId Property + +Идентификатор ритуала, к которому относится область действия\. + +```csharp +public int RitualId { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/RitualArea.Type.md b/Documentation/Pf2eModel/RitualArea.Type.md new file mode 100644 index 0000000..71fcc32 --- /dev/null +++ b/Documentation/Pf2eModel/RitualArea.Type.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.RitualRelation](Pf2eModel.Model.Structure.RitualRelation.md 'Pf2eModel\.Model\.Structure\.RitualRelation').[RitualArea](RitualArea.md 'Pf2eModel\.Model\.Structure\.RitualRelation\.RitualArea') + +## RitualArea\.Type Property + +Тип области действия ритуала\. + +```csharp +public Pf2eModel.Model.Enum.SpellAreaType Type { get; set; } +``` + +#### Property Value +[SpellAreaType](SpellAreaType.md 'Pf2eModel\.Model\.Enum\.SpellAreaType') \ No newline at end of file diff --git a/Documentation/Pf2eModel/RitualArea.md b/Documentation/Pf2eModel/RitualArea.md new file mode 100644 index 0000000..29de941 --- /dev/null +++ b/Documentation/Pf2eModel/RitualArea.md @@ -0,0 +1,19 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.RitualRelation](Pf2eModel.Model.Structure.RitualRelation.md 'Pf2eModel\.Model\.Structure\.RitualRelation') + +## RitualArea Class + +Область действия ритуала\. + +```csharp +public class RitualArea +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 RitualArea + +| Properties | | +| :--- | :--- | +| [Details](RitualArea.Details.md 'Pf2eModel\.Model\.Structure\.RitualRelation\.RitualArea\.Details') | Описание области действия ритуала\. | +| [Ritual](RitualArea.Ritual.md 'Pf2eModel\.Model\.Structure\.RitualRelation\.RitualArea\.Ritual') | Ритуал, к которому относится область действия\. | +| [RitualId](RitualArea.RitualId.md 'Pf2eModel\.Model\.Structure\.RitualRelation\.RitualArea\.RitualId') | Идентификатор ритуала, к которому относится область действия\. | +| [Type](RitualArea.Type.md 'Pf2eModel\.Model\.Structure\.RitualRelation\.RitualArea\.Type') | Тип области действия ритуала\. | diff --git a/Documentation/Pf2eModel/RitualCheck.Id.md b/Documentation/Pf2eModel/RitualCheck.Id.md new file mode 100644 index 0000000..245a748 --- /dev/null +++ b/Documentation/Pf2eModel/RitualCheck.Id.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.RitualRelation](Pf2eModel.Model.Structure.RitualRelation.md 'Pf2eModel\.Model\.Structure\.RitualRelation').[RitualCheck](RitualCheck.md 'Pf2eModel\.Model\.Structure\.RitualRelation\.RitualCheck') + +## RitualCheck\.Id Property + +Идентификатор проверки ритуала\. + +```csharp +public int Id { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/RitualCheck.IsPrimary.md b/Documentation/Pf2eModel/RitualCheck.IsPrimary.md new file mode 100644 index 0000000..3950a40 --- /dev/null +++ b/Documentation/Pf2eModel/RitualCheck.IsPrimary.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.RitualRelation](Pf2eModel.Model.Structure.RitualRelation.md 'Pf2eModel\.Model\.Structure\.RitualRelation').[RitualCheck](RitualCheck.md 'Pf2eModel\.Model\.Structure\.RitualRelation\.RitualCheck') + +## RitualCheck\.IsPrimary Property + +Флаг, указывающий, является ли проверка основной для ритуала\. + +```csharp +public bool IsPrimary { get; set; } +``` + +#### Property Value +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') \ No newline at end of file diff --git a/Documentation/Pf2eModel/RitualCheck.Rank.md b/Documentation/Pf2eModel/RitualCheck.Rank.md new file mode 100644 index 0000000..8ca9ee1 --- /dev/null +++ b/Documentation/Pf2eModel/RitualCheck.Rank.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.RitualRelation](Pf2eModel.Model.Structure.RitualRelation.md 'Pf2eModel\.Model\.Structure\.RitualRelation').[RitualCheck](RitualCheck.md 'Pf2eModel\.Model\.Structure\.RitualRelation\.RitualCheck') + +## RitualCheck\.Rank Property + +Ранг тренировки, связанной с проверкой ритуала\. + +```csharp +public Pf2eModel.Model.Enum.TrainingRank Rank { get; set; } +``` + +#### Property Value +[TrainingRank](TrainingRank.md 'Pf2eModel\.Model\.Enum\.TrainingRank') \ No newline at end of file diff --git a/Documentation/Pf2eModel/RitualCheck.Ritual.md b/Documentation/Pf2eModel/RitualCheck.Ritual.md new file mode 100644 index 0000000..696e55f --- /dev/null +++ b/Documentation/Pf2eModel/RitualCheck.Ritual.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.RitualRelation](Pf2eModel.Model.Structure.RitualRelation.md 'Pf2eModel\.Model\.Structure\.RitualRelation').[RitualCheck](RitualCheck.md 'Pf2eModel\.Model\.Structure\.RitualRelation\.RitualCheck') + +## RitualCheck\.Ritual Property + +Ритуал, к которому относится проверка\. + +```csharp +public Pf2eModel.Model.Structure.Ritual Ritual { get; set; } +``` + +#### Property Value +[Ritual](Ritual.md 'Pf2eModel\.Model\.Structure\.Ritual') \ No newline at end of file diff --git a/Documentation/Pf2eModel/RitualCheck.RitualId.md b/Documentation/Pf2eModel/RitualCheck.RitualId.md new file mode 100644 index 0000000..55f8cb2 --- /dev/null +++ b/Documentation/Pf2eModel/RitualCheck.RitualId.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.RitualRelation](Pf2eModel.Model.Structure.RitualRelation.md 'Pf2eModel\.Model\.Structure\.RitualRelation').[RitualCheck](RitualCheck.md 'Pf2eModel\.Model\.Structure\.RitualRelation\.RitualCheck') + +## RitualCheck\.RitualId Property + +Идентификатор ритуала, к которому относится проверка\. + +```csharp +public int RitualId { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/RitualCheck.Training.md b/Documentation/Pf2eModel/RitualCheck.Training.md new file mode 100644 index 0000000..04c7f5b --- /dev/null +++ b/Documentation/Pf2eModel/RitualCheck.Training.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.RitualRelation](Pf2eModel.Model.Structure.RitualRelation.md 'Pf2eModel\.Model\.Structure\.RitualRelation').[RitualCheck](RitualCheck.md 'Pf2eModel\.Model\.Structure\.RitualRelation\.RitualCheck') + +## RitualCheck\.Training Property + +Тренировка, связанная с проверкой ритуала\. + +```csharp +public Pf2eModel.Model.Common.Training? Training { get; set; } +``` + +#### Property Value +[Training](Training.md 'Pf2eModel\.Model\.Common\.Training') \ No newline at end of file diff --git a/Documentation/Pf2eModel/RitualCheck.TrainingId.md b/Documentation/Pf2eModel/RitualCheck.TrainingId.md new file mode 100644 index 0000000..5123558 --- /dev/null +++ b/Documentation/Pf2eModel/RitualCheck.TrainingId.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.RitualRelation](Pf2eModel.Model.Structure.RitualRelation.md 'Pf2eModel\.Model\.Structure\.RitualRelation').[RitualCheck](RitualCheck.md 'Pf2eModel\.Model\.Structure\.RitualRelation\.RitualCheck') + +## RitualCheck\.TrainingId Property + +Идентификатор тренировки, связанной с проверкой ритуала\. + +```csharp +public System.Nullable TrainingId { get; set; } +``` + +#### Property Value +[System\.Nullable<](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System\.Nullable\`1')[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System\.Nullable\`1') \ No newline at end of file diff --git a/Documentation/Pf2eModel/RitualCheck.TrainingString.md b/Documentation/Pf2eModel/RitualCheck.TrainingString.md new file mode 100644 index 0000000..6337dde --- /dev/null +++ b/Documentation/Pf2eModel/RitualCheck.TrainingString.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.RitualRelation](Pf2eModel.Model.Structure.RitualRelation.md 'Pf2eModel\.Model\.Structure\.RitualRelation').[RitualCheck](RitualCheck.md 'Pf2eModel\.Model\.Structure\.RitualRelation\.RitualCheck') + +## RitualCheck\.TrainingString Property + +Дополнение к проверке\. + +```csharp +public Pf2eModel.Model.Common.I18n.LocaleString? TrainingString { get; set; } +``` + +#### Property Value +[LocaleString](LocaleString.md 'Pf2eModel\.Model\.Common\.I18n\.LocaleString') \ No newline at end of file diff --git a/Documentation/Pf2eModel/RitualCheck.md b/Documentation/Pf2eModel/RitualCheck.md new file mode 100644 index 0000000..d6ae34e --- /dev/null +++ b/Documentation/Pf2eModel/RitualCheck.md @@ -0,0 +1,23 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.RitualRelation](Pf2eModel.Model.Structure.RitualRelation.md 'Pf2eModel\.Model\.Structure\.RitualRelation') + +## RitualCheck Class + +Проверка для ритуала\. + +```csharp +public class RitualCheck +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 RitualCheck + +| Properties | | +| :--- | :--- | +| [Id](RitualCheck.Id.md 'Pf2eModel\.Model\.Structure\.RitualRelation\.RitualCheck\.Id') | Идентификатор проверки ритуала\. | +| [IsPrimary](RitualCheck.IsPrimary.md 'Pf2eModel\.Model\.Structure\.RitualRelation\.RitualCheck\.IsPrimary') | Флаг, указывающий, является ли проверка основной для ритуала\. | +| [Rank](RitualCheck.Rank.md 'Pf2eModel\.Model\.Structure\.RitualRelation\.RitualCheck\.Rank') | Ранг тренировки, связанной с проверкой ритуала\. | +| [Ritual](RitualCheck.Ritual.md 'Pf2eModel\.Model\.Structure\.RitualRelation\.RitualCheck\.Ritual') | Ритуал, к которому относится проверка\. | +| [RitualId](RitualCheck.RitualId.md 'Pf2eModel\.Model\.Structure\.RitualRelation\.RitualCheck\.RitualId') | Идентификатор ритуала, к которому относится проверка\. | +| [Training](RitualCheck.Training.md 'Pf2eModel\.Model\.Structure\.RitualRelation\.RitualCheck\.Training') | Тренировка, связанная с проверкой ритуала\. | +| [TrainingId](RitualCheck.TrainingId.md 'Pf2eModel\.Model\.Structure\.RitualRelation\.RitualCheck\.TrainingId') | Идентификатор тренировки, связанной с проверкой ритуала\. | +| [TrainingString](RitualCheck.TrainingString.md 'Pf2eModel\.Model\.Structure\.RitualRelation\.RitualCheck\.TrainingString') | Дополнение к проверке\. | diff --git a/Documentation/Pf2eModel/Rule.Breadcrumbs.md b/Documentation/Pf2eModel/Rule.Breadcrumbs.md new file mode 100644 index 0000000..47c9c9a --- /dev/null +++ b/Documentation/Pf2eModel/Rule.Breadcrumbs.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Rule](Rule.md 'Pf2eModel\.Model\.Structure\.Rule') + +## Rule\.Breadcrumbs Property + +Хлебные крошки для отображения в интерфейсе\. + +```csharp +public string[] Breadcrumbs { get; set; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String')[\[\]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System\.Array') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Rule.Children.md b/Documentation/Pf2eModel/Rule.Children.md new file mode 100644 index 0000000..1b3e1a3 --- /dev/null +++ b/Documentation/Pf2eModel/Rule.Children.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Rule](Rule.md 'Pf2eModel\.Model\.Structure\.Rule') + +## Rule\.Children Property + +Дочерние правила\. + +```csharp +public System.Collections.Generic.ICollection Children { get; set; } +``` + +#### Property Value +[System\.Collections\.Generic\.ICollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1')[Rule](Rule.md 'Pf2eModel\.Model\.Structure\.Rule')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Rule.Entity.md b/Documentation/Pf2eModel/Rule.Entity.md new file mode 100644 index 0000000..c35f6f0 --- /dev/null +++ b/Documentation/Pf2eModel/Rule.Entity.md @@ -0,0 +1,15 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Rule](Rule.md 'Pf2eModel\.Model\.Structure\.Rule') + +## Rule\.Entity Property + +Корневая сущность\. + +```csharp +public Pf2eModel.Model.Base.Entity Entity { get; set; } +``` + +Implements [Entity](IEntity.Entity.md 'Pf2eModel\.Model\.IEntity\.Entity') + +#### Property Value +[Entity](Entity.md 'Pf2eModel\.Model\.Base\.Entity') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Rule.Id.md b/Documentation/Pf2eModel/Rule.Id.md new file mode 100644 index 0000000..5438079 --- /dev/null +++ b/Documentation/Pf2eModel/Rule.Id.md @@ -0,0 +1,15 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Rule](Rule.md 'Pf2eModel\.Model\.Structure\.Rule') + +## Rule\.Id Property + +Идентификатор сущности\. + +```csharp +public int Id { get; set; } +``` + +Implements [Id](IEntity.Id.md 'Pf2eModel\.Model\.IEntity\.Id') + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Rule.Order.md b/Documentation/Pf2eModel/Rule.Order.md new file mode 100644 index 0000000..6dcb144 --- /dev/null +++ b/Documentation/Pf2eModel/Rule.Order.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Rule](Rule.md 'Pf2eModel\.Model\.Structure\.Rule') + +## Rule\.Order Property + +Порядок отображения\. + +```csharp +public int Order { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Rule.Parent.md b/Documentation/Pf2eModel/Rule.Parent.md new file mode 100644 index 0000000..8a584f9 --- /dev/null +++ b/Documentation/Pf2eModel/Rule.Parent.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Rule](Rule.md 'Pf2eModel\.Model\.Structure\.Rule') + +## Rule\.Parent Property + +Родительское правило\. + +```csharp +public Pf2eModel.Model.Structure.Rule? Parent { get; set; } +``` + +#### Property Value +[Rule](Rule.md 'Pf2eModel\.Model\.Structure\.Rule') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Rule.ParentId.md b/Documentation/Pf2eModel/Rule.ParentId.md new file mode 100644 index 0000000..9405b83 --- /dev/null +++ b/Documentation/Pf2eModel/Rule.ParentId.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Rule](Rule.md 'Pf2eModel\.Model\.Structure\.Rule') + +## Rule\.ParentId Property + +Идентификатор родительского правила\. + +```csharp +public System.Nullable ParentId { get; set; } +``` + +#### Property Value +[System\.Nullable<](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System\.Nullable\`1')[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System\.Nullable\`1') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Rule.md b/Documentation/Pf2eModel/Rule.md new file mode 100644 index 0000000..49d32be --- /dev/null +++ b/Documentation/Pf2eModel/Rule.md @@ -0,0 +1,24 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure') + +## Rule Class + +Правило\. + +```csharp +public class Rule : Pf2eModel.Model.IEntity +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 Rule + +Implements [IEntity](IEntity.md 'Pf2eModel\.Model\.IEntity') + +| Properties | | +| :--- | :--- | +| [Breadcrumbs](Rule.Breadcrumbs.md 'Pf2eModel\.Model\.Structure\.Rule\.Breadcrumbs') | Хлебные крошки для отображения в интерфейсе\. | +| [Children](Rule.Children.md 'Pf2eModel\.Model\.Structure\.Rule\.Children') | Дочерние правила\. | +| [Entity](Rule.Entity.md 'Pf2eModel\.Model\.Structure\.Rule\.Entity') | Корневая сущность\. | +| [Id](Rule.Id.md 'Pf2eModel\.Model\.Structure\.Rule\.Id') | Идентификатор сущности\. | +| [Order](Rule.Order.md 'Pf2eModel\.Model\.Structure\.Rule\.Order') | Порядок отображения\. | +| [Parent](Rule.Parent.md 'Pf2eModel\.Model\.Structure\.Rule\.Parent') | Родительское правило\. | +| [ParentId](Rule.ParentId.md 'Pf2eModel\.Model\.Structure\.Rule\.ParentId') | Идентификатор родительского правила\. | diff --git a/Documentation/Pf2eModel/SizeEnum.md b/Documentation/Pf2eModel/SizeEnum.md new file mode 100644 index 0000000..0f0d8ce --- /dev/null +++ b/Documentation/Pf2eModel/SizeEnum.md @@ -0,0 +1,41 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Enum](Pf2eModel.Model.Enum.md 'Pf2eModel\.Model\.Enum') + +## SizeEnum Enum + +Размер\. + +```csharp +public enum SizeEnum +``` +### Fields + + + +`Tiny` 0 + +Крошечный размер\. + + + +`Small` 1 + +Маленький размер\. + + + +`Medium` 2 + +Средний размер\. + + + +`Large` 3 + +Большой размер\. + + + +`Huge` 4 + +Громадный размер\. \ No newline at end of file diff --git a/Documentation/Pf2eModel/Source.Category.md b/Documentation/Pf2eModel/Source.Category.md new file mode 100644 index 0000000..c5eec04 --- /dev/null +++ b/Documentation/Pf2eModel/Source.Category.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Base\.Source](Pf2eModel.Model.Base.Source.md 'Pf2eModel\.Model\.Base\.Source').[Source](Source.md 'Pf2eModel\.Model\.Base\.Source\.Source') + +## Source\.Category Property + +Категория источника\. + +```csharp +public Pf2eModel.Model.Enum.SourceCategory Category { get; set; } +``` + +#### Property Value +[SourceCategory](SourceCategory.md 'Pf2eModel\.Model\.Enum\.SourceCategory') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Source.EntitySources.md b/Documentation/Pf2eModel/Source.EntitySources.md new file mode 100644 index 0000000..902cb90 --- /dev/null +++ b/Documentation/Pf2eModel/Source.EntitySources.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Base\.Source](Pf2eModel.Model.Base.Source.md 'Pf2eModel\.Model\.Base\.Source').[Source](Source.md 'Pf2eModel\.Model\.Base\.Source\.Source') + +## Source\.EntitySources Property + +Связанные сущности\. + +```csharp +public System.Collections.Generic.ICollection EntitySources { get; set; } +``` + +#### Property Value +[System\.Collections\.Generic\.ICollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1')[EntitySource](EntitySource.md 'Pf2eModel\.Model\.Base\.Source\.EntitySource')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Source.Id.md b/Documentation/Pf2eModel/Source.Id.md new file mode 100644 index 0000000..934184a --- /dev/null +++ b/Documentation/Pf2eModel/Source.Id.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Base\.Source](Pf2eModel.Model.Base.Source.md 'Pf2eModel\.Model\.Base\.Source').[Source](Source.md 'Pf2eModel\.Model\.Base\.Source\.Source') + +## Source\.Id Property + +Идентификатор источника\. + +```csharp +public int Id { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Source.Name.md b/Documentation/Pf2eModel/Source.Name.md new file mode 100644 index 0000000..f923dc9 --- /dev/null +++ b/Documentation/Pf2eModel/Source.Name.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Base\.Source](Pf2eModel.Model.Base.Source.md 'Pf2eModel\.Model\.Base\.Source').[Source](Source.md 'Pf2eModel\.Model\.Base\.Source\.Source') + +## Source\.Name Property + +Отображаемое имя источника\. + +```csharp +public string Name { get; set; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Source.ReleaseDate.md b/Documentation/Pf2eModel/Source.ReleaseDate.md new file mode 100644 index 0000000..5dc5522 --- /dev/null +++ b/Documentation/Pf2eModel/Source.ReleaseDate.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Base\.Source](Pf2eModel.Model.Base.Source.md 'Pf2eModel\.Model\.Base\.Source').[Source](Source.md 'Pf2eModel\.Model\.Base\.Source\.Source') + +## Source\.ReleaseDate Property + +Дата выхода источника\. + +```csharp +public System.Nullable ReleaseDate { get; set; } +``` + +#### Property Value +[System\.Nullable<](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System\.Nullable\`1')[System\.DateOnly](https://docs.microsoft.com/en-us/dotnet/api/System.DateOnly 'System\.DateOnly')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System\.Nullable\`1') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Source.md b/Documentation/Pf2eModel/Source.md new file mode 100644 index 0000000..97a6478 --- /dev/null +++ b/Documentation/Pf2eModel/Source.md @@ -0,0 +1,20 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Base\.Source](Pf2eModel.Model.Base.Source.md 'Pf2eModel\.Model\.Base\.Source') + +## Source Class + +Источник сущности\. + +```csharp +public class Source +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 Source + +| Properties | | +| :--- | :--- | +| [Category](Source.Category.md 'Pf2eModel\.Model\.Base\.Source\.Source\.Category') | Категория источника\. | +| [EntitySources](Source.EntitySources.md 'Pf2eModel\.Model\.Base\.Source\.Source\.EntitySources') | Связанные сущности\. | +| [Id](Source.Id.md 'Pf2eModel\.Model\.Base\.Source\.Source\.Id') | Идентификатор источника\. | +| [Name](Source.Name.md 'Pf2eModel\.Model\.Base\.Source\.Source\.Name') | Отображаемое имя источника\. | +| [ReleaseDate](Source.ReleaseDate.md 'Pf2eModel\.Model\.Base\.Source\.Source\.ReleaseDate') | Дата выхода источника\. | diff --git a/Documentation/Pf2eModel/SourceCategory.md b/Documentation/Pf2eModel/SourceCategory.md new file mode 100644 index 0000000..f1f588a --- /dev/null +++ b/Documentation/Pf2eModel/SourceCategory.md @@ -0,0 +1,53 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Enum](Pf2eModel.Model.Enum.md 'Pf2eModel\.Model\.Enum') + +## SourceCategory Enum + +Перечисление категорий источников\. + +```csharp +public enum SourceCategory +``` +### Fields + + + +`Rulebooks` 0 + +Неизвестная категория источника\. + + + +`AdventurePaths` 1 + +Серия приключений\. + + + +`LostOmens` 2 + +Lost Omens + + + +`Adventures` 3 + +Приключение\. + + + +`Comics` 4 + +Комиксы\. + + + +`BlogPosts` 5 + +Блог\-посты\. + + + +`Society` 6 + +Сообщество\. \ No newline at end of file diff --git a/Documentation/Pf2eModel/Spell.Actions.md b/Documentation/Pf2eModel/Spell.Actions.md new file mode 100644 index 0000000..cd05e6f --- /dev/null +++ b/Documentation/Pf2eModel/Spell.Actions.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Spell](Spell.md 'Pf2eModel\.Model\.Structure\.Spell') + +## Spell\.Actions Property + +Количество действий, необходимых для применения заклинания\. + +```csharp +public Pf2eModel.Model.Enum.ActionEnum Actions { get; set; } +``` + +#### Property Value +[ActionEnum](ActionEnum.md 'Pf2eModel\.Model\.Enum\.ActionEnum') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Spell.Cost.md b/Documentation/Pf2eModel/Spell.Cost.md new file mode 100644 index 0000000..b3064f1 --- /dev/null +++ b/Documentation/Pf2eModel/Spell.Cost.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Spell](Spell.md 'Pf2eModel\.Model\.Structure\.Spell') + +## Spell\.Cost Property + +Стоимость заклинания\. + +```csharp +public Pf2eModel.Model.Common.I18n.LocaleString? Cost { get; set; } +``` + +#### Property Value +[LocaleString](LocaleString.md 'Pf2eModel\.Model\.Common\.I18n\.LocaleString') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Spell.Duration.md b/Documentation/Pf2eModel/Spell.Duration.md new file mode 100644 index 0000000..0d69139 --- /dev/null +++ b/Documentation/Pf2eModel/Spell.Duration.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Spell](Spell.md 'Pf2eModel\.Model\.Structure\.Spell') + +## Spell\.Duration Property + +Время длительности заклинания в секундах\. + +```csharp +public System.Nullable Duration { get; set; } +``` + +#### Property Value +[System\.Nullable<](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System\.Nullable\`1')[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System\.Nullable\`1') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Spell.Elements.md b/Documentation/Pf2eModel/Spell.Elements.md new file mode 100644 index 0000000..8bf3297 --- /dev/null +++ b/Documentation/Pf2eModel/Spell.Elements.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Spell](Spell.md 'Pf2eModel\.Model\.Structure\.Spell') + +## Spell\.Elements Property + +Элементы заклинания\. + +```csharp +public Pf2eModel.Model.Enum.ElementEnum[] Elements { get; set; } +``` + +#### Property Value +[ElementEnum](ElementEnum.md 'Pf2eModel\.Model\.Enum\.ElementEnum')[\[\]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System\.Array') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Spell.Entity.md b/Documentation/Pf2eModel/Spell.Entity.md new file mode 100644 index 0000000..2e84753 --- /dev/null +++ b/Documentation/Pf2eModel/Spell.Entity.md @@ -0,0 +1,15 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Spell](Spell.md 'Pf2eModel\.Model\.Structure\.Spell') + +## Spell\.Entity Property + +Корневая сущность\. + +```csharp +public Pf2eModel.Model.Base.Entity Entity { get; set; } +``` + +Implements [Entity](IEntity.Entity.md 'Pf2eModel\.Model\.IEntity\.Entity') + +#### Property Value +[Entity](Entity.md 'Pf2eModel\.Model\.Base\.Entity') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Spell.Id.md b/Documentation/Pf2eModel/Spell.Id.md new file mode 100644 index 0000000..df6b5bb --- /dev/null +++ b/Documentation/Pf2eModel/Spell.Id.md @@ -0,0 +1,15 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Spell](Spell.md 'Pf2eModel\.Model\.Structure\.Spell') + +## Spell\.Id Property + +Идентификатор сущности\. + +```csharp +public int Id { get; set; } +``` + +Implements [Id](IEntity.Id.md 'Pf2eModel\.Model\.IEntity\.Id') + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Spell.IsFocus.md b/Documentation/Pf2eModel/Spell.IsFocus.md new file mode 100644 index 0000000..6a51045 --- /dev/null +++ b/Documentation/Pf2eModel/Spell.IsFocus.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Spell](Spell.md 'Pf2eModel\.Model\.Structure\.Spell') + +## Spell\.IsFocus Property + +Является ли заклинание фокусом\. + +```csharp +public bool IsFocus { get; set; } +``` + +#### Property Value +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Spell.Level.md b/Documentation/Pf2eModel/Spell.Level.md new file mode 100644 index 0000000..1f8194b --- /dev/null +++ b/Documentation/Pf2eModel/Spell.Level.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Spell](Spell.md 'Pf2eModel\.Model\.Structure\.Spell') + +## Spell\.Level Property + +Уровень заклинания\. + +```csharp +public int Level { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Spell.Range.md b/Documentation/Pf2eModel/Spell.Range.md new file mode 100644 index 0000000..276afe8 --- /dev/null +++ b/Documentation/Pf2eModel/Spell.Range.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Spell](Spell.md 'Pf2eModel\.Model\.Structure\.Spell') + +## Spell\.Range Property + +Дальность заклинания в футах\. + +```csharp +public int Range { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Spell.Requirement.md b/Documentation/Pf2eModel/Spell.Requirement.md new file mode 100644 index 0000000..fbcc369 --- /dev/null +++ b/Documentation/Pf2eModel/Spell.Requirement.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Spell](Spell.md 'Pf2eModel\.Model\.Structure\.Spell') + +## Spell\.Requirement Property + +Требования к заклинанию\. + +```csharp +public Pf2eModel.Model.Common.I18n.LocaleString? Requirement { get; set; } +``` + +#### Property Value +[LocaleString](LocaleString.md 'Pf2eModel\.Model\.Common\.I18n\.LocaleString') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Spell.SpellAreas.md b/Documentation/Pf2eModel/Spell.SpellAreas.md new file mode 100644 index 0000000..bbedda1 --- /dev/null +++ b/Documentation/Pf2eModel/Spell.SpellAreas.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Spell](Spell.md 'Pf2eModel\.Model\.Structure\.Spell') + +## Spell\.SpellAreas Property + +Коллекция области заклинания\. + +```csharp +public System.Collections.Generic.ICollection SpellAreas { get; set; } +``` + +#### Property Value +[System\.Collections\.Generic\.ICollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1')[SpellArea](SpellArea.md 'Pf2eModel\.Model\.Structure\.SpellRelation\.SpellArea')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Spell.SpellDefenses.md b/Documentation/Pf2eModel/Spell.SpellDefenses.md new file mode 100644 index 0000000..4bfd836 --- /dev/null +++ b/Documentation/Pf2eModel/Spell.SpellDefenses.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Spell](Spell.md 'Pf2eModel\.Model\.Structure\.Spell') + +## Spell\.SpellDefenses Property + +Коллекция защиты от заклинания\. + +```csharp +public System.Collections.Generic.ICollection SpellDefenses { get; set; } +``` + +#### Property Value +[System\.Collections\.Generic\.ICollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1')[SpellDefense](SpellDefense.md 'Pf2eModel\.Model\.Structure\.SpellRelation\.SpellDefense')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Spell.Target.md b/Documentation/Pf2eModel/Spell.Target.md new file mode 100644 index 0000000..793b80c --- /dev/null +++ b/Documentation/Pf2eModel/Spell.Target.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Spell](Spell.md 'Pf2eModel\.Model\.Structure\.Spell') + +## Spell\.Target Property + +Цель заклинания\. + +```csharp +public Pf2eModel.Model.Common.I18n.LocaleString? Target { get; set; } +``` + +#### Property Value +[LocaleString](LocaleString.md 'Pf2eModel\.Model\.Common\.I18n\.LocaleString') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Spell.Traditions.md b/Documentation/Pf2eModel/Spell.Traditions.md new file mode 100644 index 0000000..1629242 --- /dev/null +++ b/Documentation/Pf2eModel/Spell.Traditions.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Spell](Spell.md 'Pf2eModel\.Model\.Structure\.Spell') + +## Spell\.Traditions Property + +Традиции заклинания\. + +```csharp +public Pf2eModel.Model.Enum.SpellTradition[] Traditions { get; set; } +``` + +#### Property Value +[SpellTradition](SpellTradition.md 'Pf2eModel\.Model\.Enum\.SpellTradition')[\[\]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System\.Array') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Spell.Trigger.md b/Documentation/Pf2eModel/Spell.Trigger.md new file mode 100644 index 0000000..4b96e00 --- /dev/null +++ b/Documentation/Pf2eModel/Spell.Trigger.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Spell](Spell.md 'Pf2eModel\.Model\.Structure\.Spell') + +## Spell\.Trigger Property + +Триггер заклинания\. + +```csharp +public Pf2eModel.Model.Common.I18n.LocaleString? Trigger { get; set; } +``` + +#### Property Value +[LocaleString](LocaleString.md 'Pf2eModel\.Model\.Common\.I18n\.LocaleString') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Spell.md b/Documentation/Pf2eModel/Spell.md new file mode 100644 index 0000000..a3a647a --- /dev/null +++ b/Documentation/Pf2eModel/Spell.md @@ -0,0 +1,32 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure') + +## Spell Class + +Заклинание\. + +```csharp +public class Spell : Pf2eModel.Model.IEntity +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 Spell + +Implements [IEntity](IEntity.md 'Pf2eModel\.Model\.IEntity') + +| Properties | | +| :--- | :--- | +| [Actions](Spell.Actions.md 'Pf2eModel\.Model\.Structure\.Spell\.Actions') | Количество действий, необходимых для применения заклинания\. | +| [Cost](Spell.Cost.md 'Pf2eModel\.Model\.Structure\.Spell\.Cost') | Стоимость заклинания\. | +| [Duration](Spell.Duration.md 'Pf2eModel\.Model\.Structure\.Spell\.Duration') | Время длительности заклинания в секундах\. | +| [Elements](Spell.Elements.md 'Pf2eModel\.Model\.Structure\.Spell\.Elements') | Элементы заклинания\. | +| [Entity](Spell.Entity.md 'Pf2eModel\.Model\.Structure\.Spell\.Entity') | Корневая сущность\. | +| [Id](Spell.Id.md 'Pf2eModel\.Model\.Structure\.Spell\.Id') | Идентификатор сущности\. | +| [IsFocus](Spell.IsFocus.md 'Pf2eModel\.Model\.Structure\.Spell\.IsFocus') | Является ли заклинание фокусом\. | +| [Level](Spell.Level.md 'Pf2eModel\.Model\.Structure\.Spell\.Level') | Уровень заклинания\. | +| [Range](Spell.Range.md 'Pf2eModel\.Model\.Structure\.Spell\.Range') | Дальность заклинания в футах\. | +| [Requirement](Spell.Requirement.md 'Pf2eModel\.Model\.Structure\.Spell\.Requirement') | Требования к заклинанию\. | +| [SpellAreas](Spell.SpellAreas.md 'Pf2eModel\.Model\.Structure\.Spell\.SpellAreas') | Коллекция области заклинания\. | +| [SpellDefenses](Spell.SpellDefenses.md 'Pf2eModel\.Model\.Structure\.Spell\.SpellDefenses') | Коллекция защиты от заклинания\. | +| [Target](Spell.Target.md 'Pf2eModel\.Model\.Structure\.Spell\.Target') | Цель заклинания\. | +| [Traditions](Spell.Traditions.md 'Pf2eModel\.Model\.Structure\.Spell\.Traditions') | Традиции заклинания\. | +| [Trigger](Spell.Trigger.md 'Pf2eModel\.Model\.Structure\.Spell\.Trigger') | Триггер заклинания\. | diff --git a/Documentation/Pf2eModel/SpellArea.Details.md b/Documentation/Pf2eModel/SpellArea.Details.md new file mode 100644 index 0000000..9b72e5e --- /dev/null +++ b/Documentation/Pf2eModel/SpellArea.Details.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.SpellRelation](Pf2eModel.Model.Structure.SpellRelation.md 'Pf2eModel\.Model\.Structure\.SpellRelation').[SpellArea](SpellArea.md 'Pf2eModel\.Model\.Structure\.SpellRelation\.SpellArea') + +## SpellArea\.Details Property + +Описание области заклинания\. + +```csharp +public Pf2eModel.Model.Common.I18n.LocaleString? Details { get; set; } +``` + +#### Property Value +[LocaleString](LocaleString.md 'Pf2eModel\.Model\.Common\.I18n\.LocaleString') \ No newline at end of file diff --git a/Documentation/Pf2eModel/SpellArea.Id.md b/Documentation/Pf2eModel/SpellArea.Id.md new file mode 100644 index 0000000..fc172fe --- /dev/null +++ b/Documentation/Pf2eModel/SpellArea.Id.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.SpellRelation](Pf2eModel.Model.Structure.SpellRelation.md 'Pf2eModel\.Model\.Structure\.SpellRelation').[SpellArea](SpellArea.md 'Pf2eModel\.Model\.Structure\.SpellRelation\.SpellArea') + +## SpellArea\.Id Property + +Идентификатор области заклинания\. + +```csharp +public int Id { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/SpellArea.Spell.md b/Documentation/Pf2eModel/SpellArea.Spell.md new file mode 100644 index 0000000..5e03374 --- /dev/null +++ b/Documentation/Pf2eModel/SpellArea.Spell.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.SpellRelation](Pf2eModel.Model.Structure.SpellRelation.md 'Pf2eModel\.Model\.Structure\.SpellRelation').[SpellArea](SpellArea.md 'Pf2eModel\.Model\.Structure\.SpellRelation\.SpellArea') + +## SpellArea\.Spell Property + +Заклинание, к которому относится область\. + +```csharp +public virtual Pf2eModel.Model.Structure.Spell Spell { get; set; } +``` + +#### Property Value +[Spell](Spell.md 'Pf2eModel\.Model\.Structure\.Spell') \ No newline at end of file diff --git a/Documentation/Pf2eModel/SpellArea.SpellId.md b/Documentation/Pf2eModel/SpellArea.SpellId.md new file mode 100644 index 0000000..6be8d78 --- /dev/null +++ b/Documentation/Pf2eModel/SpellArea.SpellId.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.SpellRelation](Pf2eModel.Model.Structure.SpellRelation.md 'Pf2eModel\.Model\.Structure\.SpellRelation').[SpellArea](SpellArea.md 'Pf2eModel\.Model\.Structure\.SpellRelation\.SpellArea') + +## SpellArea\.SpellId Property + +Идентификатор заклинания, к которому относится область\. + +```csharp +public int SpellId { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/SpellArea.Type.md b/Documentation/Pf2eModel/SpellArea.Type.md new file mode 100644 index 0000000..2f40e60 --- /dev/null +++ b/Documentation/Pf2eModel/SpellArea.Type.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.SpellRelation](Pf2eModel.Model.Structure.SpellRelation.md 'Pf2eModel\.Model\.Structure\.SpellRelation').[SpellArea](SpellArea.md 'Pf2eModel\.Model\.Structure\.SpellRelation\.SpellArea') + +## SpellArea\.Type Property + +Тип области заклинания\. + +```csharp +public Pf2eModel.Model.Enum.SpellAreaType Type { get; set; } +``` + +#### Property Value +[SpellAreaType](SpellAreaType.md 'Pf2eModel\.Model\.Enum\.SpellAreaType') \ No newline at end of file diff --git a/Documentation/Pf2eModel/SpellArea.md b/Documentation/Pf2eModel/SpellArea.md new file mode 100644 index 0000000..6f5fa18 --- /dev/null +++ b/Documentation/Pf2eModel/SpellArea.md @@ -0,0 +1,20 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.SpellRelation](Pf2eModel.Model.Structure.SpellRelation.md 'Pf2eModel\.Model\.Structure\.SpellRelation') + +## SpellArea Class + +Область заклинания\. + +```csharp +public class SpellArea +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 SpellArea + +| Properties | | +| :--- | :--- | +| [Details](SpellArea.Details.md 'Pf2eModel\.Model\.Structure\.SpellRelation\.SpellArea\.Details') | Описание области заклинания\. | +| [Id](SpellArea.Id.md 'Pf2eModel\.Model\.Structure\.SpellRelation\.SpellArea\.Id') | Идентификатор области заклинания\. | +| [Spell](SpellArea.Spell.md 'Pf2eModel\.Model\.Structure\.SpellRelation\.SpellArea\.Spell') | Заклинание, к которому относится область\. | +| [SpellId](SpellArea.SpellId.md 'Pf2eModel\.Model\.Structure\.SpellRelation\.SpellArea\.SpellId') | Идентификатор заклинания, к которому относится область\. | +| [Type](SpellArea.Type.md 'Pf2eModel\.Model\.Structure\.SpellRelation\.SpellArea\.Type') | Тип области заклинания\. | diff --git a/Documentation/Pf2eModel/SpellAreaType.md b/Documentation/Pf2eModel/SpellAreaType.md new file mode 100644 index 0000000..ff0cfc3 --- /dev/null +++ b/Documentation/Pf2eModel/SpellAreaType.md @@ -0,0 +1,77 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Enum](Pf2eModel.Model.Enum.md 'Pf2eModel\.Model\.Enum') + +## SpellAreaType Enum + +Тип области заклинания\. + +```csharp +public enum SpellAreaType +``` +### Fields + + + +`Burst` 0 + +Взрыв\. + + + +`Emanation` 1 + +Эманация\. + + + +`Cone` 2 + +Конус\. + + + +`Line` 3 + +Линия\. + + + +`Square` 4 + +Квадрат\. + + + +`Cube` 5 + +Куб\. + + + +`Cylinder` 6 + +Цилиндр\. + + + +`Varies` 7 + +Варьируемое\. + + + +`Cuboid` 8 + +Параллелипипед\. + + + +`Circle` 9 + +Круг\. + + + +`Other` 10 + +Иное\. \ No newline at end of file diff --git a/Documentation/Pf2eModel/SpellDamage.ApplyMod.md b/Documentation/Pf2eModel/SpellDamage.ApplyMod.md new file mode 100644 index 0000000..4a880b5 --- /dev/null +++ b/Documentation/Pf2eModel/SpellDamage.ApplyMod.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.SpellRelation](Pf2eModel.Model.Structure.SpellRelation.md 'Pf2eModel\.Model\.Structure\.SpellRelation').[SpellDamage](SpellDamage.md 'Pf2eModel\.Model\.Structure\.SpellRelation\.SpellDamage') + +## SpellDamage\.ApplyMod Property + +Применяется ли модификатор к урону заклинания\. + +```csharp +public System.Nullable ApplyMod { get; set; } +``` + +#### Property Value +[System\.Nullable<](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System\.Nullable\`1')[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System\.Nullable\`1') \ No newline at end of file diff --git a/Documentation/Pf2eModel/SpellDamage.Category.md b/Documentation/Pf2eModel/SpellDamage.Category.md new file mode 100644 index 0000000..d97cf06 --- /dev/null +++ b/Documentation/Pf2eModel/SpellDamage.Category.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.SpellRelation](Pf2eModel.Model.Structure.SpellRelation.md 'Pf2eModel\.Model\.Structure\.SpellRelation').[SpellDamage](SpellDamage.md 'Pf2eModel\.Model\.Structure\.SpellRelation\.SpellDamage') + +## SpellDamage\.Category Property + +Категория урона заклинания, если применимо\. + +```csharp +public System.Nullable Category { get; set; } +``` + +#### Property Value +[System\.Nullable<](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System\.Nullable\`1')[SpellDamageCategory](SpellDamageCategory.md 'Pf2eModel\.Model\.Enum\.SpellDamageCategory')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System\.Nullable\`1') \ No newline at end of file diff --git a/Documentation/Pf2eModel/SpellDamage.Formula.md b/Documentation/Pf2eModel/SpellDamage.Formula.md new file mode 100644 index 0000000..8bfd28e --- /dev/null +++ b/Documentation/Pf2eModel/SpellDamage.Formula.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.SpellRelation](Pf2eModel.Model.Structure.SpellRelation.md 'Pf2eModel\.Model\.Structure\.SpellRelation').[SpellDamage](SpellDamage.md 'Pf2eModel\.Model\.Structure\.SpellRelation\.SpellDamage') + +## SpellDamage\.Formula Property + +Формула урона заклинания\. + +```csharp +public string Formula { get; set; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eModel/SpellDamage.Id.md b/Documentation/Pf2eModel/SpellDamage.Id.md new file mode 100644 index 0000000..a957acc --- /dev/null +++ b/Documentation/Pf2eModel/SpellDamage.Id.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.SpellRelation](Pf2eModel.Model.Structure.SpellRelation.md 'Pf2eModel\.Model\.Structure\.SpellRelation').[SpellDamage](SpellDamage.md 'Pf2eModel\.Model\.Structure\.SpellRelation\.SpellDamage') + +## SpellDamage\.Id Property + +Идентификатор урона заклинания\. + +```csharp +public int Id { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/SpellDamage.Key.md b/Documentation/Pf2eModel/SpellDamage.Key.md new file mode 100644 index 0000000..04765cb --- /dev/null +++ b/Documentation/Pf2eModel/SpellDamage.Key.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.SpellRelation](Pf2eModel.Model.Structure.SpellRelation.md 'Pf2eModel\.Model\.Structure\.SpellRelation').[SpellDamage](SpellDamage.md 'Pf2eModel\.Model\.Structure\.SpellRelation\.SpellDamage') + +## SpellDamage\.Key Property + +Уровень заклинания, к которому относится урон\. + +```csharp +public string Key { get; set; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eModel/SpellDamage.Kinds.md b/Documentation/Pf2eModel/SpellDamage.Kinds.md new file mode 100644 index 0000000..72a6066 --- /dev/null +++ b/Documentation/Pf2eModel/SpellDamage.Kinds.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.SpellRelation](Pf2eModel.Model.Structure.SpellRelation.md 'Pf2eModel\.Model\.Structure\.SpellRelation').[SpellDamage](SpellDamage.md 'Pf2eModel\.Model\.Structure\.SpellRelation\.SpellDamage') + +## SpellDamage\.Kinds Property + +Тип урона заклинания\. + +```csharp +public Pf2eModel.Model.Enum.SpellDamageKinds Kinds { get; set; } +``` + +#### Property Value +[SpellDamageKinds](SpellDamageKinds.md 'Pf2eModel\.Model\.Enum\.SpellDamageKinds') \ No newline at end of file diff --git a/Documentation/Pf2eModel/SpellDamage.Materials.md b/Documentation/Pf2eModel/SpellDamage.Materials.md new file mode 100644 index 0000000..f5e6685 --- /dev/null +++ b/Documentation/Pf2eModel/SpellDamage.Materials.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.SpellRelation](Pf2eModel.Model.Structure.SpellRelation.md 'Pf2eModel\.Model\.Structure\.SpellRelation').[SpellDamage](SpellDamage.md 'Pf2eModel\.Model\.Structure\.SpellRelation\.SpellDamage') + +## SpellDamage\.Materials Property + +Материалы, необходимые для заклинания, если применимо\. + +```csharp +public string? Materials { get; set; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eModel/SpellDamage.Spell.md b/Documentation/Pf2eModel/SpellDamage.Spell.md new file mode 100644 index 0000000..c6ce39f --- /dev/null +++ b/Documentation/Pf2eModel/SpellDamage.Spell.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.SpellRelation](Pf2eModel.Model.Structure.SpellRelation.md 'Pf2eModel\.Model\.Structure\.SpellRelation').[SpellDamage](SpellDamage.md 'Pf2eModel\.Model\.Structure\.SpellRelation\.SpellDamage') + +## SpellDamage\.Spell Property + +Заклинание, к которому относится урон\. + +```csharp +public virtual Pf2eModel.Model.Structure.Spell Spell { get; set; } +``` + +#### Property Value +[Spell](Spell.md 'Pf2eModel\.Model\.Structure\.Spell') \ No newline at end of file diff --git a/Documentation/Pf2eModel/SpellDamage.SpellId.md b/Documentation/Pf2eModel/SpellDamage.SpellId.md new file mode 100644 index 0000000..441aa8c --- /dev/null +++ b/Documentation/Pf2eModel/SpellDamage.SpellId.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.SpellRelation](Pf2eModel.Model.Structure.SpellRelation.md 'Pf2eModel\.Model\.Structure\.SpellRelation').[SpellDamage](SpellDamage.md 'Pf2eModel\.Model\.Structure\.SpellRelation\.SpellDamage') + +## SpellDamage\.SpellId Property + +Идентификатор заклинания, к которому относится урон\. + +```csharp +public int SpellId { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/SpellDamage.Type.md b/Documentation/Pf2eModel/SpellDamage.Type.md new file mode 100644 index 0000000..8720c40 --- /dev/null +++ b/Documentation/Pf2eModel/SpellDamage.Type.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.SpellRelation](Pf2eModel.Model.Structure.SpellRelation.md 'Pf2eModel\.Model\.Structure\.SpellRelation').[SpellDamage](SpellDamage.md 'Pf2eModel\.Model\.Structure\.SpellRelation\.SpellDamage') + +## SpellDamage\.Type Property + +Тип урона заклинания, если применимо \(например, "fire", "cold" и т\.д\.\)\. + +```csharp +public string Type { get; set; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eModel/SpellDamage.md b/Documentation/Pf2eModel/SpellDamage.md new file mode 100644 index 0000000..8a72f0d --- /dev/null +++ b/Documentation/Pf2eModel/SpellDamage.md @@ -0,0 +1,25 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.SpellRelation](Pf2eModel.Model.Structure.SpellRelation.md 'Pf2eModel\.Model\.Structure\.SpellRelation') + +## SpellDamage Class + +Урон заклинания\. + +```csharp +public class SpellDamage +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 SpellDamage + +| Properties | | +| :--- | :--- | +| [ApplyMod](SpellDamage.ApplyMod.md 'Pf2eModel\.Model\.Structure\.SpellRelation\.SpellDamage\.ApplyMod') | Применяется ли модификатор к урону заклинания\. | +| [Category](SpellDamage.Category.md 'Pf2eModel\.Model\.Structure\.SpellRelation\.SpellDamage\.Category') | Категория урона заклинания, если применимо\. | +| [Formula](SpellDamage.Formula.md 'Pf2eModel\.Model\.Structure\.SpellRelation\.SpellDamage\.Formula') | Формула урона заклинания\. | +| [Id](SpellDamage.Id.md 'Pf2eModel\.Model\.Structure\.SpellRelation\.SpellDamage\.Id') | Идентификатор урона заклинания\. | +| [Key](SpellDamage.Key.md 'Pf2eModel\.Model\.Structure\.SpellRelation\.SpellDamage\.Key') | Уровень заклинания, к которому относится урон\. | +| [Kinds](SpellDamage.Kinds.md 'Pf2eModel\.Model\.Structure\.SpellRelation\.SpellDamage\.Kinds') | Тип урона заклинания\. | +| [Materials](SpellDamage.Materials.md 'Pf2eModel\.Model\.Structure\.SpellRelation\.SpellDamage\.Materials') | Материалы, необходимые для заклинания, если применимо\. | +| [Spell](SpellDamage.Spell.md 'Pf2eModel\.Model\.Structure\.SpellRelation\.SpellDamage\.Spell') | Заклинание, к которому относится урон\. | +| [SpellId](SpellDamage.SpellId.md 'Pf2eModel\.Model\.Structure\.SpellRelation\.SpellDamage\.SpellId') | Идентификатор заклинания, к которому относится урон\. | +| [Type](SpellDamage.Type.md 'Pf2eModel\.Model\.Structure\.SpellRelation\.SpellDamage\.Type') | Тип урона заклинания, если применимо \(например, "fire", "cold" и т\.д\.\)\. | diff --git a/Documentation/Pf2eModel/SpellDamageCategory.md b/Documentation/Pf2eModel/SpellDamageCategory.md new file mode 100644 index 0000000..db73bcc --- /dev/null +++ b/Documentation/Pf2eModel/SpellDamageCategory.md @@ -0,0 +1,29 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Enum](Pf2eModel.Model.Enum.md 'Pf2eModel\.Model\.Enum') + +## SpellDamageCategory Enum + +Тип урона заклинания\. + +```csharp +public enum SpellDamageCategory +``` +### Fields + + + +`Normal` 0 + +Обычный урон\. + + + +`Persistent` 1 + +Продолжительный урон\. + + + +`Splash` 2 + +Брызги\. \ No newline at end of file diff --git a/Documentation/Pf2eModel/SpellDamageKinds.md b/Documentation/Pf2eModel/SpellDamageKinds.md new file mode 100644 index 0000000..5453475 --- /dev/null +++ b/Documentation/Pf2eModel/SpellDamageKinds.md @@ -0,0 +1,29 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Enum](Pf2eModel.Model.Enum.md 'Pf2eModel\.Model\.Enum') + +## SpellDamageKinds Enum + +Тип урона заклинания\. + +```csharp +public enum SpellDamageKinds +``` +### Fields + + + +`Damage` 0 + +Урон\. + + + +`Healing` 1 + +Исцеление\. + + + +`Any` 2 + +Любое\. \ No newline at end of file diff --git a/Documentation/Pf2eModel/SpellDefense.Id.md b/Documentation/Pf2eModel/SpellDefense.Id.md new file mode 100644 index 0000000..90b797d --- /dev/null +++ b/Documentation/Pf2eModel/SpellDefense.Id.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.SpellRelation](Pf2eModel.Model.Structure.SpellRelation.md 'Pf2eModel\.Model\.Structure\.SpellRelation').[SpellDefense](SpellDefense.md 'Pf2eModel\.Model\.Structure\.SpellRelation\.SpellDefense') + +## SpellDefense\.Id Property + +Идентификатор защиты от заклинания\. + +```csharp +public int Id { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/SpellDefense.IsBasic.md b/Documentation/Pf2eModel/SpellDefense.IsBasic.md new file mode 100644 index 0000000..ead4225 --- /dev/null +++ b/Documentation/Pf2eModel/SpellDefense.IsBasic.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.SpellRelation](Pf2eModel.Model.Structure.SpellRelation.md 'Pf2eModel\.Model\.Structure\.SpellRelation').[SpellDefense](SpellDefense.md 'Pf2eModel\.Model\.Structure\.SpellRelation\.SpellDefense') + +## SpellDefense\.IsBasic Property + +Флаг, указывающий, является ли защита базовой\. + +```csharp +public System.Nullable IsBasic { get; set; } +``` + +#### Property Value +[System\.Nullable<](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System\.Nullable\`1')[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System\.Nullable\`1') \ No newline at end of file diff --git a/Documentation/Pf2eModel/SpellDefense.IsPassive.md b/Documentation/Pf2eModel/SpellDefense.IsPassive.md new file mode 100644 index 0000000..e4bdb60 --- /dev/null +++ b/Documentation/Pf2eModel/SpellDefense.IsPassive.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.SpellRelation](Pf2eModel.Model.Structure.SpellRelation.md 'Pf2eModel\.Model\.Structure\.SpellRelation').[SpellDefense](SpellDefense.md 'Pf2eModel\.Model\.Structure\.SpellRelation\.SpellDefense') + +## SpellDefense\.IsPassive Property + +Флаг, указывающий, является ли защита от заклинания пассивной \(например, для заклинаний, которые не требуют активного действия для защиты\)\. + +```csharp +public bool IsPassive { get; set; } +``` + +#### Property Value +[System\.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System\.Boolean') \ No newline at end of file diff --git a/Documentation/Pf2eModel/SpellDefense.Spell.md b/Documentation/Pf2eModel/SpellDefense.Spell.md new file mode 100644 index 0000000..fc1e116 --- /dev/null +++ b/Documentation/Pf2eModel/SpellDefense.Spell.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.SpellRelation](Pf2eModel.Model.Structure.SpellRelation.md 'Pf2eModel\.Model\.Structure\.SpellRelation').[SpellDefense](SpellDefense.md 'Pf2eModel\.Model\.Structure\.SpellRelation\.SpellDefense') + +## SpellDefense\.Spell Property + +Заклинание, к которому относится защита\. + +```csharp +public virtual Pf2eModel.Model.Structure.Spell Spell { get; set; } +``` + +#### Property Value +[Spell](Spell.md 'Pf2eModel\.Model\.Structure\.Spell') \ No newline at end of file diff --git a/Documentation/Pf2eModel/SpellDefense.SpellId.md b/Documentation/Pf2eModel/SpellDefense.SpellId.md new file mode 100644 index 0000000..49efb34 --- /dev/null +++ b/Documentation/Pf2eModel/SpellDefense.SpellId.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.SpellRelation](Pf2eModel.Model.Structure.SpellRelation.md 'Pf2eModel\.Model\.Structure\.SpellRelation').[SpellDefense](SpellDefense.md 'Pf2eModel\.Model\.Structure\.SpellRelation\.SpellDefense') + +## SpellDefense\.SpellId Property + +Идентификатор заклинания, к которому относится защита\. + +```csharp +public int SpellId { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/SpellDefense.Statistic.md b/Documentation/Pf2eModel/SpellDefense.Statistic.md new file mode 100644 index 0000000..582bf99 --- /dev/null +++ b/Documentation/Pf2eModel/SpellDefense.Statistic.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.SpellRelation](Pf2eModel.Model.Structure.SpellRelation.md 'Pf2eModel\.Model\.Structure\.SpellRelation').[SpellDefense](SpellDefense.md 'Pf2eModel\.Model\.Structure\.SpellRelation\.SpellDefense') + +## SpellDefense\.Statistic Property + +Статистика, используемая для защиты от заклинания \(например, "Fortitude", "Reflex", "Will"\)\. + +```csharp +public string Statistic { get; set; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eModel/SpellDefense.md b/Documentation/Pf2eModel/SpellDefense.md new file mode 100644 index 0000000..5b2ae37 --- /dev/null +++ b/Documentation/Pf2eModel/SpellDefense.md @@ -0,0 +1,21 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.SpellRelation](Pf2eModel.Model.Structure.SpellRelation.md 'Pf2eModel\.Model\.Structure\.SpellRelation') + +## SpellDefense Class + +Защита от заклинания\. + +```csharp +public class SpellDefense +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 SpellDefense + +| Properties | | +| :--- | :--- | +| [Id](SpellDefense.Id.md 'Pf2eModel\.Model\.Structure\.SpellRelation\.SpellDefense\.Id') | Идентификатор защиты от заклинания\. | +| [IsBasic](SpellDefense.IsBasic.md 'Pf2eModel\.Model\.Structure\.SpellRelation\.SpellDefense\.IsBasic') | Флаг, указывающий, является ли защита базовой\. | +| [IsPassive](SpellDefense.IsPassive.md 'Pf2eModel\.Model\.Structure\.SpellRelation\.SpellDefense\.IsPassive') | Флаг, указывающий, является ли защита от заклинания пассивной \(например, для заклинаний, которые не требуют активного действия для защиты\)\. | +| [Spell](SpellDefense.Spell.md 'Pf2eModel\.Model\.Structure\.SpellRelation\.SpellDefense\.Spell') | Заклинание, к которому относится защита\. | +| [SpellId](SpellDefense.SpellId.md 'Pf2eModel\.Model\.Structure\.SpellRelation\.SpellDefense\.SpellId') | Идентификатор заклинания, к которому относится защита\. | +| [Statistic](SpellDefense.Statistic.md 'Pf2eModel\.Model\.Structure\.SpellRelation\.SpellDefense\.Statistic') | Статистика, используемая для защиты от заклинания \(например, "Fortitude", "Reflex", "Will"\)\. | diff --git a/Documentation/Pf2eModel/SpellTradition.md b/Documentation/Pf2eModel/SpellTradition.md new file mode 100644 index 0000000..658c86f --- /dev/null +++ b/Documentation/Pf2eModel/SpellTradition.md @@ -0,0 +1,53 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Enum](Pf2eModel.Model.Enum.md 'Pf2eModel\.Model\.Enum') + +## SpellTradition Enum + +Традиция заклинания\. + +```csharp +public enum SpellTradition +``` +### Fields + + + +`None` 0 + +Без традиции\. + + + +`Divine` 1 + +Сакральная традиция\. + + + +`Occult` 2 + +Оккультная традиция\. + + + +`Arcane` 3 + +Арканная традиция\. + + + +`Primal` 4 + +Примальная традиция\. + + + +`Elemental` 5 + +Элементная традиция\. + + + +`All` 6 + +Все традиции\. \ No newline at end of file diff --git a/Documentation/Pf2eModel/Subclass.Additional.md b/Documentation/Pf2eModel/Subclass.Additional.md new file mode 100644 index 0000000..8e6dcce --- /dev/null +++ b/Documentation/Pf2eModel/Subclass.Additional.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Subclass](Subclass.md 'Pf2eModel\.Model\.Structure\.Subclass') + +## Subclass\.Additional Property + +Дополнительная информация\. + +```csharp +public Pf2eModel.Model.Common.I18n.LocaleString Additional { get; set; } +``` + +#### Property Value +[LocaleString](LocaleString.md 'Pf2eModel\.Model\.Common\.I18n\.LocaleString') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Subclass.Entities.md b/Documentation/Pf2eModel/Subclass.Entities.md new file mode 100644 index 0000000..dd6413b --- /dev/null +++ b/Documentation/Pf2eModel/Subclass.Entities.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Subclass](Subclass.md 'Pf2eModel\.Model\.Structure\.Subclass') + +## Subclass\.Entities Property + +Коллекция сущностей, связанных с подклассом\. + +```csharp +public System.Collections.Generic.ICollection Entities { get; set; } +``` + +#### Property Value +[System\.Collections\.Generic\.ICollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1')[Entity](Entity.md 'Pf2eModel\.Model\.Base\.Entity')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Subclass.Entity.md b/Documentation/Pf2eModel/Subclass.Entity.md new file mode 100644 index 0000000..a5decb0 --- /dev/null +++ b/Documentation/Pf2eModel/Subclass.Entity.md @@ -0,0 +1,15 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Subclass](Subclass.md 'Pf2eModel\.Model\.Structure\.Subclass') + +## Subclass\.Entity Property + +Корневая сущность\. + +```csharp +public Pf2eModel.Model.Base.Entity Entity { get; set; } +``` + +Implements [Entity](IEntity.Entity.md 'Pf2eModel\.Model\.IEntity\.Entity') + +#### Property Value +[Entity](Entity.md 'Pf2eModel\.Model\.Base\.Entity') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Subclass.Extra.md b/Documentation/Pf2eModel/Subclass.Extra.md new file mode 100644 index 0000000..046a0aa --- /dev/null +++ b/Documentation/Pf2eModel/Subclass.Extra.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Subclass](Subclass.md 'Pf2eModel\.Model\.Structure\.Subclass') + +## Subclass\.Extra Property + +Дополнительная информация в формате JSON\. + +```csharp +public string Extra { get; set; } +``` + +#### Property Value +[System\.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System\.String') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Subclass.Group.md b/Documentation/Pf2eModel/Subclass.Group.md new file mode 100644 index 0000000..50ab740 --- /dev/null +++ b/Documentation/Pf2eModel/Subclass.Group.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Subclass](Subclass.md 'Pf2eModel\.Model\.Structure\.Subclass') + +## Subclass\.Group Property + +Группа подклассов\. + +```csharp +public Pf2eModel.Model.Structure.SubclassGroup Group { get; set; } +``` + +#### Property Value +[SubclassGroup](SubclassGroup.md 'Pf2eModel\.Model\.Structure\.SubclassGroup') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Subclass.GroupId.md b/Documentation/Pf2eModel/Subclass.GroupId.md new file mode 100644 index 0000000..aa5da5d --- /dev/null +++ b/Documentation/Pf2eModel/Subclass.GroupId.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Subclass](Subclass.md 'Pf2eModel\.Model\.Structure\.Subclass') + +## Subclass\.GroupId Property + +Идетификатор группы подклассов\. + +```csharp +public int GroupId { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Subclass.Id.md b/Documentation/Pf2eModel/Subclass.Id.md new file mode 100644 index 0000000..6eebf05 --- /dev/null +++ b/Documentation/Pf2eModel/Subclass.Id.md @@ -0,0 +1,15 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Subclass](Subclass.md 'Pf2eModel\.Model\.Structure\.Subclass') + +## Subclass\.Id Property + +Идентификатор сущности\. + +```csharp +public int Id { get; set; } +``` + +Implements [Id](IEntity.Id.md 'Pf2eModel\.Model\.IEntity\.Id') + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Subclass.Trainings.md b/Documentation/Pf2eModel/Subclass.Trainings.md new file mode 100644 index 0000000..9e68981 --- /dev/null +++ b/Documentation/Pf2eModel/Subclass.Trainings.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Subclass](Subclass.md 'Pf2eModel\.Model\.Structure\.Subclass') + +## Subclass\.Trainings Property + +Коллекция тренировок, связанных с подклассом\. + +```csharp +public System.Collections.Generic.ICollection Trainings { get; set; } +``` + +#### Property Value +[System\.Collections\.Generic\.ICollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1')[SubclassTrainings](SubclassTrainings.md 'Pf2eModel\.Model\.Structure\.ClassRelation\.SubclassTrainings')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Subclass.md b/Documentation/Pf2eModel/Subclass.md new file mode 100644 index 0000000..b5f9ba3 --- /dev/null +++ b/Documentation/Pf2eModel/Subclass.md @@ -0,0 +1,25 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure') + +## Subclass Class + +Подкласс\. + +```csharp +public class Subclass : Pf2eModel.Model.IEntity +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 Subclass + +Implements [IEntity](IEntity.md 'Pf2eModel\.Model\.IEntity') + +| Properties | | +| :--- | :--- | +| [Additional](Subclass.Additional.md 'Pf2eModel\.Model\.Structure\.Subclass\.Additional') | Дополнительная информация\. | +| [Entities](Subclass.Entities.md 'Pf2eModel\.Model\.Structure\.Subclass\.Entities') | Коллекция сущностей, связанных с подклассом\. | +| [Entity](Subclass.Entity.md 'Pf2eModel\.Model\.Structure\.Subclass\.Entity') | Корневая сущность\. | +| [Extra](Subclass.Extra.md 'Pf2eModel\.Model\.Structure\.Subclass\.Extra') | Дополнительная информация в формате JSON\. | +| [Group](Subclass.Group.md 'Pf2eModel\.Model\.Structure\.Subclass\.Group') | Группа подклассов\. | +| [GroupId](Subclass.GroupId.md 'Pf2eModel\.Model\.Structure\.Subclass\.GroupId') | Идетификатор группы подклассов\. | +| [Id](Subclass.Id.md 'Pf2eModel\.Model\.Structure\.Subclass\.Id') | Идентификатор сущности\. | +| [Trainings](Subclass.Trainings.md 'Pf2eModel\.Model\.Structure\.Subclass\.Trainings') | Коллекция тренировок, связанных с подклассом\. | diff --git a/Documentation/Pf2eModel/SubclassGroup.Class.md b/Documentation/Pf2eModel/SubclassGroup.Class.md new file mode 100644 index 0000000..9f1da8c --- /dev/null +++ b/Documentation/Pf2eModel/SubclassGroup.Class.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[SubclassGroup](SubclassGroup.md 'Pf2eModel\.Model\.Structure\.SubclassGroup') + +## SubclassGroup\.Class Property + +Класс, к которому относится группа подклассов\. + +```csharp +public Pf2eModel.Model.Structure.Class? Class { get; set; } +``` + +#### Property Value +[Class](Class.md 'Pf2eModel\.Model\.Structure\.Class') \ No newline at end of file diff --git a/Documentation/Pf2eModel/SubclassGroup.ClassId.md b/Documentation/Pf2eModel/SubclassGroup.ClassId.md new file mode 100644 index 0000000..bf9a2f6 --- /dev/null +++ b/Documentation/Pf2eModel/SubclassGroup.ClassId.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[SubclassGroup](SubclassGroup.md 'Pf2eModel\.Model\.Structure\.SubclassGroup') + +## SubclassGroup\.ClassId Property + +Идентификатор класса\. + +```csharp +public System.Nullable ClassId { get; set; } +``` + +#### Property Value +[System\.Nullable<](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System\.Nullable\`1')[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System\.Nullable\`1') \ No newline at end of file diff --git a/Documentation/Pf2eModel/SubclassGroup.Entity.md b/Documentation/Pf2eModel/SubclassGroup.Entity.md new file mode 100644 index 0000000..7e9cb6a --- /dev/null +++ b/Documentation/Pf2eModel/SubclassGroup.Entity.md @@ -0,0 +1,15 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[SubclassGroup](SubclassGroup.md 'Pf2eModel\.Model\.Structure\.SubclassGroup') + +## SubclassGroup\.Entity Property + +Корневая сущность\. + +```csharp +public Pf2eModel.Model.Base.Entity Entity { get; set; } +``` + +Implements [Entity](IEntity.Entity.md 'Pf2eModel\.Model\.IEntity\.Entity') + +#### Property Value +[Entity](Entity.md 'Pf2eModel\.Model\.Base\.Entity') \ No newline at end of file diff --git a/Documentation/Pf2eModel/SubclassGroup.Id.md b/Documentation/Pf2eModel/SubclassGroup.Id.md new file mode 100644 index 0000000..6e6a4da --- /dev/null +++ b/Documentation/Pf2eModel/SubclassGroup.Id.md @@ -0,0 +1,15 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[SubclassGroup](SubclassGroup.md 'Pf2eModel\.Model\.Structure\.SubclassGroup') + +## SubclassGroup\.Id Property + +Идентификатор сущности\. + +```csharp +public int Id { get; set; } +``` + +Implements [Id](IEntity.Id.md 'Pf2eModel\.Model\.IEntity\.Id') + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/SubclassGroup.Subclasses.md b/Documentation/Pf2eModel/SubclassGroup.Subclasses.md new file mode 100644 index 0000000..b8175b0 --- /dev/null +++ b/Documentation/Pf2eModel/SubclassGroup.Subclasses.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[SubclassGroup](SubclassGroup.md 'Pf2eModel\.Model\.Structure\.SubclassGroup') + +## SubclassGroup\.Subclasses Property + +Коллекция подклассов, относящихся к этой группе\. + +```csharp +public System.Collections.Generic.ICollection Subclasses { get; set; } +``` + +#### Property Value +[System\.Collections\.Generic\.ICollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1')[Subclass](Subclass.md 'Pf2eModel\.Model\.Structure\.Subclass')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1') \ No newline at end of file diff --git a/Documentation/Pf2eModel/SubclassGroup.md b/Documentation/Pf2eModel/SubclassGroup.md new file mode 100644 index 0000000..e381014 --- /dev/null +++ b/Documentation/Pf2eModel/SubclassGroup.md @@ -0,0 +1,22 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure') + +## SubclassGroup Class + +Группа подклассов\. + +```csharp +public class SubclassGroup : Pf2eModel.Model.IEntity +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 SubclassGroup + +Implements [IEntity](IEntity.md 'Pf2eModel\.Model\.IEntity') + +| Properties | | +| :--- | :--- | +| [Class](SubclassGroup.Class.md 'Pf2eModel\.Model\.Structure\.SubclassGroup\.Class') | Класс, к которому относится группа подклассов\. | +| [ClassId](SubclassGroup.ClassId.md 'Pf2eModel\.Model\.Structure\.SubclassGroup\.ClassId') | Идентификатор класса\. | +| [Entity](SubclassGroup.Entity.md 'Pf2eModel\.Model\.Structure\.SubclassGroup\.Entity') | Корневая сущность\. | +| [Id](SubclassGroup.Id.md 'Pf2eModel\.Model\.Structure\.SubclassGroup\.Id') | Идентификатор сущности\. | +| [Subclasses](SubclassGroup.Subclasses.md 'Pf2eModel\.Model\.Structure\.SubclassGroup\.Subclasses') | Коллекция подклассов, относящихся к этой группе\. | diff --git a/Documentation/Pf2eModel/SubclassProvidedEntities.EntityId.md b/Documentation/Pf2eModel/SubclassProvidedEntities.EntityId.md new file mode 100644 index 0000000..a684d45 --- /dev/null +++ b/Documentation/Pf2eModel/SubclassProvidedEntities.EntityId.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.ClassRelation](Pf2eModel.Model.Structure.ClassRelation.md 'Pf2eModel\.Model\.Structure\.ClassRelation').[SubclassProvidedEntities](SubclassProvidedEntities.md 'Pf2eModel\.Model\.Structure\.ClassRelation\.SubclassProvidedEntities') + +## SubclassProvidedEntities\.EntityId Property + +Идентификатор сущности, предоставляемой подклассом\. + +```csharp +public int EntityId { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/SubclassProvidedEntities.SubclassId.md b/Documentation/Pf2eModel/SubclassProvidedEntities.SubclassId.md new file mode 100644 index 0000000..9c565f5 --- /dev/null +++ b/Documentation/Pf2eModel/SubclassProvidedEntities.SubclassId.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.ClassRelation](Pf2eModel.Model.Structure.ClassRelation.md 'Pf2eModel\.Model\.Structure\.ClassRelation').[SubclassProvidedEntities](SubclassProvidedEntities.md 'Pf2eModel\.Model\.Structure\.ClassRelation\.SubclassProvidedEntities') + +## SubclassProvidedEntities\.SubclassId Property + +Идентификатор подкласса, к которому относится сущность\. + +```csharp +public int SubclassId { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/SubclassProvidedEntities.md b/Documentation/Pf2eModel/SubclassProvidedEntities.md new file mode 100644 index 0000000..7e05241 --- /dev/null +++ b/Documentation/Pf2eModel/SubclassProvidedEntities.md @@ -0,0 +1,17 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.ClassRelation](Pf2eModel.Model.Structure.ClassRelation.md 'Pf2eModel\.Model\.Structure\.ClassRelation') + +## SubclassProvidedEntities Class + +Элемент, связывающий сущность с подклассом\. + +```csharp +public class SubclassProvidedEntities +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 SubclassProvidedEntities + +| Properties | | +| :--- | :--- | +| [EntityId](SubclassProvidedEntities.EntityId.md 'Pf2eModel\.Model\.Structure\.ClassRelation\.SubclassProvidedEntities\.EntityId') | Идентификатор сущности, предоставляемой подклассом\. | +| [SubclassId](SubclassProvidedEntities.SubclassId.md 'Pf2eModel\.Model\.Structure\.ClassRelation\.SubclassProvidedEntities\.SubclassId') | Идентификатор подкласса, к которому относится сущность\. | diff --git a/Documentation/Pf2eModel/SubclassTrainings.Id.md b/Documentation/Pf2eModel/SubclassTrainings.Id.md new file mode 100644 index 0000000..503ee6f --- /dev/null +++ b/Documentation/Pf2eModel/SubclassTrainings.Id.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.ClassRelation](Pf2eModel.Model.Structure.ClassRelation.md 'Pf2eModel\.Model\.Structure\.ClassRelation').[SubclassTrainings](SubclassTrainings.md 'Pf2eModel\.Model\.Structure\.ClassRelation\.SubclassTrainings') + +## SubclassTrainings\.Id Property + +Идентификатор связи между подклассом и тренировкой\. + +```csharp +public int Id { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/SubclassTrainings.Rank.md b/Documentation/Pf2eModel/SubclassTrainings.Rank.md new file mode 100644 index 0000000..fb46b9c --- /dev/null +++ b/Documentation/Pf2eModel/SubclassTrainings.Rank.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.ClassRelation](Pf2eModel.Model.Structure.ClassRelation.md 'Pf2eModel\.Model\.Structure\.ClassRelation').[SubclassTrainings](SubclassTrainings.md 'Pf2eModel\.Model\.Structure\.ClassRelation\.SubclassTrainings') + +## SubclassTrainings\.Rank Property + +Ранг тренировки для данного подкласса\. + +```csharp +public Pf2eModel.Model.Enum.TrainingRank Rank { get; set; } +``` + +#### Property Value +[TrainingRank](TrainingRank.md 'Pf2eModel\.Model\.Enum\.TrainingRank') \ No newline at end of file diff --git a/Documentation/Pf2eModel/SubclassTrainings.Subclass.md b/Documentation/Pf2eModel/SubclassTrainings.Subclass.md new file mode 100644 index 0000000..440aede --- /dev/null +++ b/Documentation/Pf2eModel/SubclassTrainings.Subclass.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.ClassRelation](Pf2eModel.Model.Structure.ClassRelation.md 'Pf2eModel\.Model\.Structure\.ClassRelation').[SubclassTrainings](SubclassTrainings.md 'Pf2eModel\.Model\.Structure\.ClassRelation\.SubclassTrainings') + +## SubclassTrainings\.Subclass Property + +Подкласс, к которому относится тренировка\. + +```csharp +public Pf2eModel.Model.Structure.Subclass Subclass { get; set; } +``` + +#### Property Value +[Subclass](Subclass.md 'Pf2eModel\.Model\.Structure\.Subclass') \ No newline at end of file diff --git a/Documentation/Pf2eModel/SubclassTrainings.SubclassId.md b/Documentation/Pf2eModel/SubclassTrainings.SubclassId.md new file mode 100644 index 0000000..ffbb377 --- /dev/null +++ b/Documentation/Pf2eModel/SubclassTrainings.SubclassId.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.ClassRelation](Pf2eModel.Model.Structure.ClassRelation.md 'Pf2eModel\.Model\.Structure\.ClassRelation').[SubclassTrainings](SubclassTrainings.md 'Pf2eModel\.Model\.Structure\.ClassRelation\.SubclassTrainings') + +## SubclassTrainings\.SubclassId Property + +Идентификатор подкласса, к которому относится тренировка\. + +```csharp +public int SubclassId { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/SubclassTrainings.Training.md b/Documentation/Pf2eModel/SubclassTrainings.Training.md new file mode 100644 index 0000000..c20c8ea --- /dev/null +++ b/Documentation/Pf2eModel/SubclassTrainings.Training.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.ClassRelation](Pf2eModel.Model.Structure.ClassRelation.md 'Pf2eModel\.Model\.Structure\.ClassRelation').[SubclassTrainings](SubclassTrainings.md 'Pf2eModel\.Model\.Structure\.ClassRelation\.SubclassTrainings') + +## SubclassTrainings\.Training Property + +Тренировка, связанная с подклассом\. + +```csharp +public Pf2eModel.Model.Common.Training Training { get; set; } +``` + +#### Property Value +[Training](Training.md 'Pf2eModel\.Model\.Common\.Training') \ No newline at end of file diff --git a/Documentation/Pf2eModel/SubclassTrainings.TrainingId.md b/Documentation/Pf2eModel/SubclassTrainings.TrainingId.md new file mode 100644 index 0000000..dae99cf --- /dev/null +++ b/Documentation/Pf2eModel/SubclassTrainings.TrainingId.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.ClassRelation](Pf2eModel.Model.Structure.ClassRelation.md 'Pf2eModel\.Model\.Structure\.ClassRelation').[SubclassTrainings](SubclassTrainings.md 'Pf2eModel\.Model\.Structure\.ClassRelation\.SubclassTrainings') + +## SubclassTrainings\.TrainingId Property + +Идентификатор тренировки, связанной с подклассом\. + +```csharp +public int TrainingId { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/SubclassTrainings.md b/Documentation/Pf2eModel/SubclassTrainings.md new file mode 100644 index 0000000..9f6e271 --- /dev/null +++ b/Documentation/Pf2eModel/SubclassTrainings.md @@ -0,0 +1,21 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure\.ClassRelation](Pf2eModel.Model.Structure.ClassRelation.md 'Pf2eModel\.Model\.Structure\.ClassRelation') + +## SubclassTrainings Class + +Связь между подклассами и тренировками\. + +```csharp +public class SubclassTrainings +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 SubclassTrainings + +| Properties | | +| :--- | :--- | +| [Id](SubclassTrainings.Id.md 'Pf2eModel\.Model\.Structure\.ClassRelation\.SubclassTrainings\.Id') | Идентификатор связи между подклассом и тренировкой\. | +| [Rank](SubclassTrainings.Rank.md 'Pf2eModel\.Model\.Structure\.ClassRelation\.SubclassTrainings\.Rank') | Ранг тренировки для данного подкласса\. | +| [Subclass](SubclassTrainings.Subclass.md 'Pf2eModel\.Model\.Structure\.ClassRelation\.SubclassTrainings\.Subclass') | Подкласс, к которому относится тренировка\. | +| [SubclassId](SubclassTrainings.SubclassId.md 'Pf2eModel\.Model\.Structure\.ClassRelation\.SubclassTrainings\.SubclassId') | Идентификатор подкласса, к которому относится тренировка\. | +| [Training](SubclassTrainings.Training.md 'Pf2eModel\.Model\.Structure\.ClassRelation\.SubclassTrainings\.Training') | Тренировка, связанная с подклассом\. | +| [TrainingId](SubclassTrainings.TrainingId.md 'Pf2eModel\.Model\.Structure\.ClassRelation\.SubclassTrainings\.TrainingId') | Идентификатор тренировки, связанной с подклассом\. | diff --git a/Documentation/Pf2eModel/Training.Id.md b/Documentation/Pf2eModel/Training.Id.md new file mode 100644 index 0000000..1d53fe6 --- /dev/null +++ b/Documentation/Pf2eModel/Training.Id.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Common](Pf2eModel.Model.Common.md 'Pf2eModel\.Model\.Common').[Training](Training.md 'Pf2eModel\.Model\.Common\.Training') + +## Training\.Id Property + +Идентификатор\. + +```csharp +public int Id { get; set; } +``` + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Training.Name.md b/Documentation/Pf2eModel/Training.Name.md new file mode 100644 index 0000000..9648683 --- /dev/null +++ b/Documentation/Pf2eModel/Training.Name.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Common](Pf2eModel.Model.Common.md 'Pf2eModel\.Model\.Common').[Training](Training.md 'Pf2eModel\.Model\.Common\.Training') + +## Training\.Name Property + +Название способности\. + +```csharp +public Pf2eModel.Model.Common.I18n.LocaleString Name { get; set; } +``` + +#### Property Value +[LocaleString](LocaleString.md 'Pf2eModel\.Model\.Common\.I18n\.LocaleString') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Training.Type.md b/Documentation/Pf2eModel/Training.Type.md new file mode 100644 index 0000000..6be51aa --- /dev/null +++ b/Documentation/Pf2eModel/Training.Type.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Common](Pf2eModel.Model.Common.md 'Pf2eModel\.Model\.Common').[Training](Training.md 'Pf2eModel\.Model\.Common\.Training') + +## Training\.Type Property + +Тип способности\. + +```csharp +public Pf2eModel.Model.Enum.TrainingType Type { get; set; } +``` + +#### Property Value +[TrainingType](TrainingType.md 'Pf2eModel\.Model\.Enum\.TrainingType') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Training.md b/Documentation/Pf2eModel/Training.md new file mode 100644 index 0000000..da3ee72 --- /dev/null +++ b/Documentation/Pf2eModel/Training.md @@ -0,0 +1,18 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Common](Pf2eModel.Model.Common.md 'Pf2eModel\.Model\.Common') + +## Training Class + +Изучаемая способность\. + +```csharp +public class Training +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 Training + +| Properties | | +| :--- | :--- | +| [Id](Training.Id.md 'Pf2eModel\.Model\.Common\.Training\.Id') | Идентификатор\. | +| [Name](Training.Name.md 'Pf2eModel\.Model\.Common\.Training\.Name') | Название способности\. | +| [Type](Training.Type.md 'Pf2eModel\.Model\.Common\.Training\.Type') | Тип способности\. | diff --git a/Documentation/Pf2eModel/TrainingRank.md b/Documentation/Pf2eModel/TrainingRank.md new file mode 100644 index 0000000..dcde26d --- /dev/null +++ b/Documentation/Pf2eModel/TrainingRank.md @@ -0,0 +1,47 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Enum](Pf2eModel.Model.Enum.md 'Pf2eModel\.Model\.Enum') + +## TrainingRank Enum + +Ранг тренировки\. + +```csharp +public enum TrainingRank +``` +### Fields + + + +`Untrained` 0 + +Необученный\. + + + +`Trained` 1 + +Обученный\. + + + +`Expert` 2 + +Эксперт\. + + + +`Master` 3 + +Мастер\. + + + +`Legendary` 4 + +Легендарный\. + + + +`Mythic` 5 + +Мифический\. \ No newline at end of file diff --git a/Documentation/Pf2eModel/TrainingType.md b/Documentation/Pf2eModel/TrainingType.md new file mode 100644 index 0000000..03c9c62 --- /dev/null +++ b/Documentation/Pf2eModel/TrainingType.md @@ -0,0 +1,47 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Enum](Pf2eModel.Model.Enum.md 'Pf2eModel\.Model\.Enum') + +## TrainingType Enum + +Тип тренировки\. + +```csharp +public enum TrainingType +``` +### Fields + + + +`Perception` 0 + +Восприятие\. + + + +`Skill` 1 + +Навык\. + + + +`Lore` 2 + +Знание\. + + + +`Weapon` 3 + +Оружие\. + + + +`Armor` 4 + +Защита\. + + + +`Save` 5 + +Спасбросок\. \ No newline at end of file diff --git a/Documentation/Pf2eModel/Trait.Entities.md b/Documentation/Pf2eModel/Trait.Entities.md new file mode 100644 index 0000000..7fd97ca --- /dev/null +++ b/Documentation/Pf2eModel/Trait.Entities.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Trait](Trait.md 'Pf2eModel\.Model\.Structure\.Trait') + +## Trait\.Entities Property + +Сущности, которые имеют данный признак\. + +```csharp +public System.Collections.Generic.ICollection Entities { get; set; } +``` + +#### Property Value +[System\.Collections\.Generic\.ICollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1')[Entity](Entity.md 'Pf2eModel\.Model\.Base\.Entity')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.ICollection-1 'System\.Collections\.Generic\.ICollection\`1') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Trait.Entity.md b/Documentation/Pf2eModel/Trait.Entity.md new file mode 100644 index 0000000..78d2116 --- /dev/null +++ b/Documentation/Pf2eModel/Trait.Entity.md @@ -0,0 +1,15 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Trait](Trait.md 'Pf2eModel\.Model\.Structure\.Trait') + +## Trait\.Entity Property + +Корневая сущность\. + +```csharp +public Pf2eModel.Model.Base.Entity Entity { get; set; } +``` + +Implements [Entity](IEntity.Entity.md 'Pf2eModel\.Model\.IEntity\.Entity') + +#### Property Value +[Entity](Entity.md 'Pf2eModel\.Model\.Base\.Entity') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Trait.Id.md b/Documentation/Pf2eModel/Trait.Id.md new file mode 100644 index 0000000..35b8223 --- /dev/null +++ b/Documentation/Pf2eModel/Trait.Id.md @@ -0,0 +1,15 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Trait](Trait.md 'Pf2eModel\.Model\.Structure\.Trait') + +## Trait\.Id Property + +Идентификатор сущности\. + +```csharp +public int Id { get; set; } +``` + +Implements [Id](IEntity.Id.md 'Pf2eModel\.Model\.IEntity\.Id') + +#### Property Value +[System\.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System\.Int32') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Trait.Type.md b/Documentation/Pf2eModel/Trait.Type.md new file mode 100644 index 0000000..bc68455 --- /dev/null +++ b/Documentation/Pf2eModel/Trait.Type.md @@ -0,0 +1,13 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure').[Trait](Trait.md 'Pf2eModel\.Model\.Structure\.Trait') + +## Trait\.Type Property + +Тип признака\. + +```csharp +public Pf2eModel.Model.Enum.TraitType Type { get; set; } +``` + +#### Property Value +[TraitType](TraitType.md 'Pf2eModel\.Model\.Enum\.TraitType') \ No newline at end of file diff --git a/Documentation/Pf2eModel/Trait.md b/Documentation/Pf2eModel/Trait.md new file mode 100644 index 0000000..06e6824 --- /dev/null +++ b/Documentation/Pf2eModel/Trait.md @@ -0,0 +1,21 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure') + +## Trait Class + +Признак\. + +```csharp +public class Trait : Pf2eModel.Model.IEntity +``` + +Inheritance [System\.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System\.Object') 🡒 Trait + +Implements [IEntity](IEntity.md 'Pf2eModel\.Model\.IEntity') + +| Properties | | +| :--- | :--- | +| [Entities](Trait.Entities.md 'Pf2eModel\.Model\.Structure\.Trait\.Entities') | Сущности, которые имеют данный признак\. | +| [Entity](Trait.Entity.md 'Pf2eModel\.Model\.Structure\.Trait\.Entity') | Корневая сущность\. | +| [Id](Trait.Id.md 'Pf2eModel\.Model\.Structure\.Trait\.Id') | Идентификатор сущности\. | +| [Type](Trait.Type.md 'Pf2eModel\.Model\.Structure\.Trait\.Type') | Тип признака\. | diff --git a/Documentation/Pf2eModel/TraitType.md b/Documentation/Pf2eModel/TraitType.md new file mode 100644 index 0000000..5b27d88 --- /dev/null +++ b/Documentation/Pf2eModel/TraitType.md @@ -0,0 +1,29 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Enum](Pf2eModel.Model.Enum.md 'Pf2eModel\.Model\.Enum') + +## TraitType Enum + +Тип признака\. + +```csharp +public enum TraitType +``` +### Fields + + + +`Regular` 0 + +Обычный признак\. + + + +`Class` 1 + +Признак класса\. + + + +`Tradition` 2 + +Признак традиции\. \ No newline at end of file diff --git a/Documentation/Pf2eModel/VisionEnum.md b/Documentation/Pf2eModel/VisionEnum.md new file mode 100644 index 0000000..87f22fe --- /dev/null +++ b/Documentation/Pf2eModel/VisionEnum.md @@ -0,0 +1,29 @@ +#### [Pf2eModel](index.md 'index') +### [Pf2eModel\.Model\.Enum](Pf2eModel.Model.Enum.md 'Pf2eModel\.Model\.Enum') + +## VisionEnum Enum + +Перечисление типов зрения\. + +```csharp +public enum VisionEnum +``` +### Fields + + + +`Normal` 0 + +Обычное зрение\. + + + +`LowLightVision` 1 + +Зрение в темноте\. + + + +`DarkVision` 2 + +Тёмное зрение\. \ No newline at end of file diff --git a/Documentation/Pf2eModel/index.md b/Documentation/Pf2eModel/index.md new file mode 100644 index 0000000..749c3be --- /dev/null +++ b/Documentation/Pf2eModel/index.md @@ -0,0 +1,24 @@ +#### [Pf2eModel](index.md 'index') + +## Pf2eModel Assembly + +| Namespaces | | +| :--- | :--- | +| [Pf2eModel](Pf2eModel.md 'Pf2eModel') | Набор классов модели ORM EntityFramework\. | +| [Pf2eModel\.Model](Pf2eModel.Model.md 'Pf2eModel\.Model') | Модель классов ORM EntityFramework\. | +| [Pf2eModel\.Model\.Base](Pf2eModel.Model.Base.md 'Pf2eModel\.Model\.Base') | Описание корневой сущности модели: класса [Entity](Entity.md 'Pf2eModel\.Model\.Base\.Entity') и его прямых связей\. | +| [Pf2eModel\.Model\.Base\.Keywords](Pf2eModel.Model.Base.Keywords.md 'Pf2eModel\.Model\.Base\.Keywords') | Классы, связанные с ключевыми словами, которые могут использоваться в разных типах сущностей\. | +| [Pf2eModel\.Model\.Base\.Source](Pf2eModel.Model.Base.Source.md 'Pf2eModel\.Model\.Base\.Source') | Классы, связанные с источниками, которые могут использоваться в разных типах сущностей\. | +| [Pf2eModel\.Model\.Base\.Targets](Pf2eModel.Model.Base.Targets.md 'Pf2eModel\.Model\.Base\.Targets') | Классы, связанные с целями внешних ссылок, которые могут использоваться в разных типах сущностей\. | +| [Pf2eModel\.Model\.Common](Pf2eModel.Model.Common.md 'Pf2eModel\.Model\.Common') | Общее классы на которые могут ссылаться разные типа\. | +| [Pf2eModel\.Model\.Common\.I18n](Pf2eModel.Model.Common.I18n.md 'Pf2eModel\.Model\.Common\.I18n') | Классы, связанные с интернационализацией \(i18n\) модели\. | +| [Pf2eModel\.Model\.Enum](Pf2eModel.Model.Enum.md 'Pf2eModel\.Model\.Enum') | Описание всех перечислений, использующихся в модели\. | +| [Pf2eModel\.Model\.Structure](Pf2eModel.Model.Structure.md 'Pf2eModel\.Model\.Structure') | Основные типы, которые связаны 1\-к\-1 с [Entity](Entity.md 'Pf2eModel\.Model\.Base\.Entity')\. Для указания этой связи используется интерфейс [IEntity](IEntity.md 'Pf2eModel\.Model\.IEntity')\. | +| [Pf2eModel\.Model\.Structure\.AncestryRelation](Pf2eModel.Model.Structure.AncestryRelation.md 'Pf2eModel\.Model\.Structure\.AncestryRelation') | Классы, описывающие связи класса [Ancestry](Ancestry.md 'Pf2eModel\.Model\.Structure\.Ancestry')\. | +| [Pf2eModel\.Model\.Structure\.ArchetypeRelation](Pf2eModel.Model.Structure.ArchetypeRelation.md 'Pf2eModel\.Model\.Structure\.ArchetypeRelation') | Классы, описывающие связи класса [Archetype](Archetype.md 'Pf2eModel\.Model\.Structure\.Archetype')\. | +| [Pf2eModel\.Model\.Structure\.BackgroundRelation](Pf2eModel.Model.Structure.BackgroundRelation.md 'Pf2eModel\.Model\.Structure\.BackgroundRelation') | Классы, описывающие связи класса [Background](Background.md 'Pf2eModel\.Model\.Structure\.Background')\. | +| [Pf2eModel\.Model\.Structure\.ClassRelation](Pf2eModel.Model.Structure.ClassRelation.md 'Pf2eModel\.Model\.Structure\.ClassRelation') | Классы, описывающие связи класса [Class](Class.md 'Pf2eModel\.Model\.Structure\.Class')\. | +| [Pf2eModel\.Model\.Structure\.DeityRelation](Pf2eModel.Model.Structure.DeityRelation.md 'Pf2eModel\.Model\.Structure\.DeityRelation') | Классы, описывающие связи класса [Deity](Deity.md 'Pf2eModel\.Model\.Structure\.Deity')\. | +| [Pf2eModel\.Model\.Structure\.FeatRelation](Pf2eModel.Model.Structure.FeatRelation.md 'Pf2eModel\.Model\.Structure\.FeatRelation') | Классы, описывающие связи класса [Feat](Feat.md 'Pf2eModel\.Model\.Structure\.Feat')\. | +| [Pf2eModel\.Model\.Structure\.RitualRelation](Pf2eModel.Model.Structure.RitualRelation.md 'Pf2eModel\.Model\.Structure\.RitualRelation') | Классы, описывающие связи класса [Ritual](Ritual.md 'Pf2eModel\.Model\.Structure\.Ritual')\. | +| [Pf2eModel\.Model\.Structure\.SpellRelation](Pf2eModel.Model.Structure.SpellRelation.md 'Pf2eModel\.Model\.Structure\.SpellRelation') | Классы, описывающие связи класса [Spell](Spell.md 'Pf2eModel\.Model\.Structure\.Spell')\. | diff --git a/Documentation/index.md b/Documentation/index.md new file mode 100644 index 0000000..a1e868e --- /dev/null +++ b/Documentation/index.md @@ -0,0 +1,2 @@ +- [`Pf2eModel`](Pf2eModel/index.md) - общая ORM-структура модели. +- [`Pf2eDataScrapper`](Pf2eDataScrapper/index.md) - загрузчик и обработчик данных. \ No newline at end of file diff --git a/Pf2eDataScrapper.sln b/Pf2eDataScrapper.sln index 9c6ae20..2326c11 100644 --- a/Pf2eDataScrapper.sln +++ b/Pf2eDataScrapper.sln @@ -19,8 +19,6 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "output", "output", "{36D591 EndProject Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Pf2eModel", "Pf2eModel\Pf2eModel.csproj", "{D32B7787-D912-4B21-B341-7C1F42F62D36}" EndProject -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Pf2eViewer", "Pf2eViewer\Pf2eViewer.csproj", "{9F492EA7-1E1A-439D-A028-506BA445ABE4}" -EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution Debug|Any CPU = Debug|Any CPU @@ -35,10 +33,6 @@ Global {D32B7787-D912-4B21-B341-7C1F42F62D36}.Debug|Any CPU.Build.0 = Debug|Any CPU {D32B7787-D912-4B21-B341-7C1F42F62D36}.Release|Any CPU.ActiveCfg = Release|Any CPU {D32B7787-D912-4B21-B341-7C1F42F62D36}.Release|Any CPU.Build.0 = Release|Any CPU - {9F492EA7-1E1A-439D-A028-506BA445ABE4}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {9F492EA7-1E1A-439D-A028-506BA445ABE4}.Debug|Any CPU.Build.0 = Debug|Any CPU - {9F492EA7-1E1A-439D-A028-506BA445ABE4}.Release|Any CPU.ActiveCfg = Release|Any CPU - {9F492EA7-1E1A-439D-A028-506BA445ABE4}.Release|Any CPU.Build.0 = Release|Any CPU EndGlobalSection GlobalSection(SolutionProperties) = preSolution HideSolutionNode = FALSE diff --git a/Pf2eDataScrapper/.env.example b/Pf2eDataScrapper/.env.example index d7a97be..77f1d48 100644 --- a/Pf2eDataScrapper/.env.example +++ b/Pf2eDataScrapper/.env.example @@ -6,3 +6,6 @@ OUTPUT_DIR=D:\path\to\output\directory # Строка подключения к БД DATABASE_CONNECTION=Host=localhost;Port=5433;Database=usersdb2;Username=postgres;Password=password + +# Максимальное количество потоков. +MAX_THREADS=60 \ No newline at end of file diff --git a/Pf2eDataScrapper/ApplicationSettings.cs b/Pf2eDataScrapper/ApplicationSettings.cs new file mode 100644 index 0000000..dd191ad --- /dev/null +++ b/Pf2eDataScrapper/ApplicationSettings.cs @@ -0,0 +1,84 @@ +using System; +using System.ComponentModel; +using System.IO; +using dotenv.net; +using dotenv.net.Utilities; + +namespace Pf2eDataScrapper; + +/// +/// Настройки программы. +/// +internal class ApplicationSettings +{ + /// + /// Конструктор класса . + /// + public ApplicationSettings() + { + DotEnv.Load(); + + DataDirPath = EnvReader.GetStringValue("DATA_DIR"); + OutputDirPath = EnvReader.GetStringValue("OUTPUT_DIR"); + DatabaseConnection = EnvReader.GetStringValue("DATABASE_CONNECTION"); + MaxThreads = Convert.ToInt32(EnvReader.GetStringValue("MAX_THREADS")); + } + + #region Настройки из .env + + /// + /// Путь к папке с входными данными. + /// + [Browsable(true)] + [ReadOnly(true)] + [DisplayName("Путь к папке с входными данными.")] + [Description("Редактирование через .env-файл.")] + public string DataDirPath { get; } + + /// + /// Папка в входными данными. + /// + [Browsable(false)] + public DirectoryInfo DataDir => new(DataDirPath); + + /// + /// Путь к папке для сохранения результатов. + /// + [Browsable(true)] + [ReadOnly(true)] + [DisplayName("Путь к папке для сохранения результатов.")] + [Description("Редактирование через .env-файл.")] + public string OutputDirPath { get; } + + /// + /// Папка для сохранения результатов. + /// + [Browsable(false)] + public string OutputDir => new(OutputDirPath); + + /// + /// Строка подключения к базе данных. + /// + [Browsable(true)] + [ReadOnly(true)] + [DisplayName("Строка подключения к базе данных.")] + [Description("Редактирование через .env-файл.")] + public string DatabaseConnection { get; } + + /// + /// Максимальное количество потоков. + /// + [Browsable(true)] + [ReadOnly(true)] + [DisplayName("Максимальное количество потоков.")] + [Description("Редактирование через .env-файл.")] + public int MaxThreads { get; } + + #endregion + + #region Основные настройки + + // + + #endregion +} diff --git a/Pf2eDataScrapper/Documentation.cs b/Pf2eDataScrapper/Documentation.cs new file mode 100644 index 0000000..9c48fc6 --- /dev/null +++ b/Pf2eDataScrapper/Documentation.cs @@ -0,0 +1,247 @@ +namespace Pf2eDataScrapper +{ + /// + /// Модель классов ORM EntityFramework. + /// + internal static class NamespaceDoc { } +} + +namespace Pf2eDataScrapper.Helpers +{ + /// + /// Классы-помощники, используемые во всех частях проекта. + /// + internal static class NamespaceDoc { } +} + +namespace Pf2eDataScrapper.Importers +{ + /// + /// Описание импортёров, которые определяют наборы обработчиков данных и элементов, необходимых для их работы. + /// + internal static class NamespaceDoc { } +} + +namespace Pf2eDataScrapper.Importers.Implementations.Aonprd +{ + /// + /// Импортёр данных из сайта Archives of Nethys Pathfinder 2e. + /// + internal static class NamespaceDoc { } +} + +namespace Pf2eDataScrapper.Importers.Implementations.Aonprd.Compendium +{ + /// + /// Компендиум данных из сайта Archives of Nethys Pathfinder 2e. + /// + internal static class NamespaceDoc { } +} + +namespace Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers +{ + /// + /// Класс-помощники, которые используются в импортере данных из сайта Archives of Nethys Pathfinder 2e. + /// + internal static class NamespaceDoc { } +} + +namespace Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors +{ + /// + /// Обработчики данных из сайта Archives of Nethys Pathfinder 2e. + /// + internal static class NamespaceDoc { } +} + +namespace Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Preparation +{ + /// + /// Обработчики для подготовки данных Archives of Nethys Pathfinder 2e. + /// + internal static class NamespaceDoc { } +} + +namespace Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Subclasses +{ + /// + /// Обработчики подклассов с сайта Archives of Nethys Pathfinder 2e. + /// + internal static class NamespaceDoc { } +} + +namespace Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types +{ + /// + /// Обработчики основных сущностей с сайта Archives of Nethys Pathfinder 2e. + /// + internal static class NamespaceDoc { } +} + +namespace Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.Rules +{ + /// + /// Обработчики правил с сайта Archives of Nethys Pathfinder 2e. + /// + internal static class NamespaceDoc { } +} + +namespace Pf2eDataScrapper.Importers.Implementations.FoundryEn +{ + /// + /// Импортёр данных из модуля pf2e для FoundryVTT. + /// + internal static class NamespaceDoc { } +} + +namespace Pf2eDataScrapper.Importers.Implementations.FoundryEn.Compendium +{ + /// + /// Компендиум данных из модуля pf2e для FoundryVTT. + /// + internal static class NamespaceDoc { } +} + +namespace Pf2eDataScrapper.Importers.Implementations.FoundryEn.Processors.Preparation +{ + /// + /// Обработчики для подготовки данных из модуля pf2e для FoundryVTT. + /// + internal static class NamespaceDoc { } +} + +namespace Pf2eDataScrapper.Importers.Repositories +{ + /// + /// Общее описание репозиториев для хранения данных, которые используются в импортёрах и процессорах. + /// + internal static class NamespaceDoc { } +} + +namespace Pf2eDataScrapper.Processors +{ + /// + /// Общее описание обработчиков данных. + /// + internal static class NamespaceDoc { } +} + +namespace Pf2eDataScrapper.Processors.Attributes +{ + /// + /// Классы-аттрибуты, которые используются для описания обработчиков данных и их свойств. + /// + internal static class NamespaceDoc { } +} + +namespace Pf2eDataScrapper.Processors.Collection +{ + /// + /// Описание коллекции классов обработчиков данных. + /// + internal static class NamespaceDoc { } +} + +namespace Pf2eDataScrapper.Processors.Definitions +{ + /// + /// Общее описание классов и интерфейсов, которые используются в обработчиках данных. + /// + internal static class NamespaceDoc { } +} + +namespace Pf2eDataScrapper.Processors.Factory +{ + /// + /// Фабрики для создания экземпляров обработчиков данных на основе их атрибутов и конфигурации. + /// + internal static class NamespaceDoc { } +} + +namespace Pf2eDataScrapper.SchemaBuilder +{ + /// + /// Классы обработки вводимых JSON-данных и создание схемы данных для использовании при формировании обработчиков данных. + /// + internal static class NamespaceDoc { } +} + +namespace Pf2eDataScrapper.SchemaBuilder.Types +{ + /// + /// Типы полей, которые используются в схемах данных для описания структуры вводимых JSON-данных. + /// + internal static class NamespaceDoc { } +} + +namespace Pf2eDataScrapper.WPF +{ + /// + /// WPF-приложение для запуска обработчиков и просмотра данных Pathfinder 2e. + /// + internal static class NamespaceDoc { } +} + +namespace Pf2eDataScrapper.WPF.EntityViewer +{ + /// + /// WPF-окно для просмотра сущностей Pathfinder 2e, с возможностью фильтрации и поиска по данным. + /// + internal static class NamespaceDoc { } +} + +namespace Pf2eDataScrapper.WPF.EntityViewer.Component +{ + /// + /// Компоненты, которые используются в WPF-окне просмотра сущностей Pathfinder 2e. + /// + internal static class NamespaceDoc { } +} + +namespace Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure +{ + /// + /// Структура представления сущностей Pathfinder 2e в WPF-приложении, включая классы и интерфейсы для отображения данных. + /// + internal static class NamespaceDoc { } +} + +namespace Pf2eDataScrapper.WPF.EntityViewer.Stores +{ + /// + /// Хранилища данных для WPF-приложения просмотра сущностей Pathfinder 2e, которые управляют состоянием и данными приложения. + /// + internal static class NamespaceDoc { } +} + +namespace Pf2eDataScrapper.WPF.EntityViewer.ViewModel +{ + /// + /// ViewModel для WPF-приложения просмотра сущностей Pathfinder 2e, которые связывают данные и представление. + /// + internal static class NamespaceDoc { } +} + +namespace Pf2eDataScrapper.WPF.ProgressForm +{ + /// + /// WPF-окно для отображения прогресса выполнения операций, таких как импорт данных или обработка сущностей Pathfinder 2e. + /// + internal static class NamespaceDoc { } +} + +namespace Pf2eDataScrapper.WPF.StartForm +{ + /// + /// WPF-окно для запуска приложения, которое позволяет пользователю выбрать импортёр и начать обработку данных Pathfinder 2e. + /// + internal static class NamespaceDoc { } +} + +namespace Pf2eDataScrapper.WPF.StartForm.Components +{ + /// + /// Компоненты, которые используются в WPF-окне запуска приложения для выбора импортёра и настройки параметров обработки данных Pathfinder 2e. + /// + internal static class NamespaceDoc { } +} diff --git a/Pf2eDataScrapper/EnvSettings.cs b/Pf2eDataScrapper/EnvSettings.cs index f5b02c1..1777b12 100644 --- a/Pf2eDataScrapper/EnvSettings.cs +++ b/Pf2eDataScrapper/EnvSettings.cs @@ -1,4 +1,5 @@ -using dotenv.net; +using System.IO; +using dotenv.net; using dotenv.net.Utilities; namespace Pf2eDataScrapper; diff --git a/Pf2eDataScrapper/Importers/DatabaseHelper.cs b/Pf2eDataScrapper/Helpers/DatabaseHelper.cs similarity index 61% rename from Pf2eDataScrapper/Importers/DatabaseHelper.cs rename to Pf2eDataScrapper/Helpers/DatabaseHelper.cs index 420a102..f20a21b 100644 --- a/Pf2eDataScrapper/Importers/DatabaseHelper.cs +++ b/Pf2eDataScrapper/Helpers/DatabaseHelper.cs @@ -1,13 +1,25 @@ -using Pf2eModel; +using System.Linq; +using System.Threading; +using Pf2eModel; using Slugify; -namespace Pf2eDataScrapper.Importers; +namespace Pf2eDataScrapper.Helpers; /// /// Класс предоставляет методы для работы с базой данных. /// public class DatabaseHelper { + /// + /// Context для доступа к базе данных. + /// + public Pf2eDbContext Context { get; } = new(); + + /// + /// Сервис для работы с URL-Slug. Используется для преобразования названий в URL-friendly формат. + /// + public SlugHelper Slugger { get; } + /// /// Последний найденный идентификатор сущности. /// Используется для генерации новых ID сущностей. @@ -20,17 +32,17 @@ public class DatabaseHelper public int NextEntityId => ++_id; /// - /// Сервис для работы с URL-Slug. Используется для преобразования названий в URL-friendly формат. + /// Блокировщик для генерации идентификаторов сущностей. /// - public readonly SlugHelper Slugger = new(); + public Lock IdLock { get; } = new(); /// - /// Context для доступа к базе данных. + /// Конструктор класса /// - public readonly Pf2eDbContext Context = new(); - - private DatabaseHelper() + /// [DI] Сервис для работы с URL-Slug + public DatabaseHelper(SlugHelper slugHelper) { + Slugger = slugHelper; _id = Context.Entities.Any() ? Context.Entities.Max(e => e.Id) : 0; } @@ -41,24 +53,4 @@ public class DatabaseHelper { return Slugger.GenerateSlug(name); } - - /// - /// Возвращает singleton-инстанцию класса . - /// - public static readonly DatabaseHelper Instance = new(); - - /// - /// Контекст для доступа к базе данных. - /// - public static Pf2eDbContext DbContext => Instance.Context; - - /// - /// Обновляет контекст и сохраняет изменения в базе данных. - /// - public static void ResetContext() - { - Instance.Context.SaveChanges(); - // Instance.Context.Dispose(); - // Instance.Context = new(); - } } diff --git a/Pf2eDataScrapper/Helpers/EntityView.cs b/Pf2eDataScrapper/Helpers/EntityView.cs new file mode 100644 index 0000000..a24964b --- /dev/null +++ b/Pf2eDataScrapper/Helpers/EntityView.cs @@ -0,0 +1,150 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using Microsoft.EntityFrameworkCore; +using Pf2eModel; +using Pf2eModel.Model; +using Pf2eModel.Model.Base; +using Pf2eModel.Model.Enum; +using Pf2eModel.Model.Structure; + +namespace Pf2eDataScrapper.Helpers; + +/// +/// Класс, обрабатывающий запросы к сущностям и подключающий необходимые данные. +/// +public class EntityView +{ + /// + /// Корневая сущность. + /// + public Entity? Entity { get; } + + /// + /// Основная сущность. + /// + public IEntity? SubEntity { get; } + + /// + /// Конструктор класса, который получает сущность из базы данных и заполняет её данными. + /// + /// Контекст базы данных. + /// Тип запрашиваемой сущности. + /// Идентификатор запрашиваемой сущности. + public EntityView(Pf2eDbContext context, EntityType type, int id) + { + Getter? getter = _getters.FirstOrDefault(g => g.Type == type); + + Entity fullEntity = + context + .Entities.Where(e => e.Id == id && e.Type == type) + .Include(e => e.Sources) + .ThenInclude(s => s.Source) + .Include(e => e.Keywords) + .Include(e => e.Externals) + .ThenInclude(x => x.Target) + .Include(e => e.Traits) + .ThenInclude(t => t.Entity) + .FirstOrDefault() ?? throw new("Entity is null"); + + IEntity? subEntity = + (getter != null) + ? getter.Get(id, context) + : (IEntity?)context.Find(EntityOfTypeAttribute.Resolve(fullEntity), id); + + Entity = fullEntity; + SubEntity = subEntity; + } + + /// + /// Словарь, содержащий методы получения сущностей из базы данных. + /// + private readonly ICollection _getters = + [ + new Getter( + EntityType.Ancestry, + context => context.Ancestries.Include(a => a.AncestryBoosts) + ), + new Getter( + EntityType.Archetype, + context => + context + .Archetypes.Include(a => a.DedicationFeat) + .ThenInclude(f => f.Entity) + .Include(a => a.Feats) + .ThenInclude(f => f.Entity) + ), + new Getter( + EntityType.Background, + context => + context + .Backgrounds.Include(b => b.BackgroundBoosts) + .Include(b => b.BackgroundSkills) + .ThenInclude(t => t.Training) + .Include(b => b.BackgroundItems) + ), + new Getter( + EntityType.Class, + context => + context + .Classes.Include(c => c.ClassKeyAbilities) + .Include(c => c.ClassTrainings) + .ThenInclude(t => t.Training) + .Include(c => c.ClassProgressions) + .Include(c => c.SubclassGroups) + ), + new Getter( + EntityType.Feat, + context => + context.Feats.Include(f => f.Archetypes).ThenInclude(a => a.Entity).AsQueryable() + ), + new Getter( + EntityType.Spell, + context => context.Spells.Include(s => s.SpellAreas).Include(s => s.SpellDefenses) + ), + new Getter( + EntityType.Ritual, + context => + context + .Rituals.Include(r => r.Area) + .Include(r => r.Checks) + .ThenInclude(c => c.Training) + .AsQueryable() + ), + new Getter( + EntityType.Subclass, + context => + context + .Subclasses.Include(s => s.Trainings) + .ThenInclude(t => t.Training) + .Include(s => s.Entities) + ), + ]; + + /// + /// Абстрактный класс, который определяет метод получения сущности из базы данных. + /// + /// Связанный тип сущности. + private abstract class Getter(EntityType type) + { + public readonly EntityType Type = type; + + public abstract IEntity? Get(int id, Pf2eDbContext context); + } + + /// + /// Класс, определяющий метод получения сущности из базы данных. + /// + /// Тип данных основной сущности. + /// Связанный тип сущности. + /// Метод получения сущности из базы данных. + private class Getter(EntityType type, Func> method) + : Getter(type) + where T : IEntity + { + public override IEntity? Get(int id, Pf2eDbContext context) + { + return method.Invoke(context).FirstOrDefault(c => c.Id == id); + } + } +} diff --git a/Pf2eDataScrapper/Helpers/ILogger.cs b/Pf2eDataScrapper/Helpers/ILogger.cs new file mode 100644 index 0000000..adb1550 --- /dev/null +++ b/Pf2eDataScrapper/Helpers/ILogger.cs @@ -0,0 +1,22 @@ +namespace Pf2eDataScrapper.Helpers; + +internal abstract class AbstractLogger +{ + public abstract void Message(LogLevel level, string message); + + public void Important(string message) => Message(LogLevel.Important, message); + + public void Warning(string message) => Message(LogLevel.Warning, message); + + public void Information(string message) => Message(LogLevel.Information, message); + + public void Progress(string message) => Message(LogLevel.Progress, message); +} + +internal enum LogLevel +{ + Important, + Warning, + Information, + Progress, +} diff --git a/Pf2eDataScrapper/Helpers/ProcessProgress.cs b/Pf2eDataScrapper/Helpers/ProcessProgress.cs new file mode 100644 index 0000000..ee6bfa1 --- /dev/null +++ b/Pf2eDataScrapper/Helpers/ProcessProgress.cs @@ -0,0 +1,168 @@ +using Pf2eDataScrapper.Processors.Definitions; + +namespace Pf2eDataScrapper.Helpers; + +internal class ProcessProgress : AbstractLogger +{ + /// + /// Прогресс обработки обработчиков . + /// + public ProgressItem Processors { get; } = new(); + + /// + /// Прогресс работы конкретного обработчика . + /// + public ProgressItem Local { get; } = new(); + + /// + /// Конструктор класса . + /// + public ProcessProgress() + { + Processors.Update += Update; + Local.Update += Update; + } + + /// + /// Событие обновления + /// + private void Update() + { + ProgressUpdate?.Invoke(this); + } + + public override void Message(LogLevel level, string message) + { + ProgressMessage?.Invoke(this, level, message); + } + + public void Complete() + { + ProgressComplete?.Invoke(this); + } + + public delegate void ProgressUpdateDelegate(ProcessProgress sender); + public event ProgressUpdateDelegate? ProgressUpdate; + + public event ProgressUpdateDelegate? ProgressComplete; + + public delegate void ProgressMessageDelegate( + ProcessProgress sender, + LogLevel level, + string message + ); + public event ProgressMessageDelegate? ProgressMessage; + + /// + /// Класс прогресса. + /// + public class ProgressItem + { + /// + /// Количество обрабатываемых процессов. + /// + public int Count + { + get => _count; + set + { + _count = value; + Update?.Invoke(); + } + } + private int _count; + + /// + /// Индекс текущего обрабатываемого процесса. + /// + public int Current + { + get => _current; + set + { + _current = value; + Update?.Invoke(); + } + } + private int _current; + + /// + /// Название текущего обрабатываемого процесса. + /// + public string Text + { + get => _text; + set + { + _text = value; + Update?.Invoke(); + } + } + private string _text = ""; + + /// + /// Значение прогресса. + /// + public double Percent => Count > 0 ? 1.0 * Current / Count : 1.0; + + /// + /// Сброс прогресса до нуля и установка нового максимального значения. + /// + /// + public void Reset(int max = 0) + { + _count = max; + _current = 0; + _text = ""; + Update?.Invoke(); + } + + /// + /// Отмечает начало работы над процессом, описываемым строкой . + /// + /// Строка, описывающая процесс. + public void Start(string text) + { + _text = text; + Update?.Invoke(); + } + + /// + /// Отмечает конец работы над процессом и увеличивает значение прогресса. + /// + public void End() + { + _current++; + Update?.Invoke(); + } + + /// + /// Отмечает прогресс завершённым. + /// + public void Complete() + { + _current = _count; + _text = "Готово!"; + Update?.Invoke(); + } + + /// + /// Получение строкового представления прогресса. + /// + /// Строковое представление прогресса. + public override string ToString() + { + return $"{Text} [{Current} / {Count}; {Percent:P}]"; + } + + /// + /// Делегат события обновления. + /// + public delegate void UpdateDelegate(); + + /// + /// Событие обновление. + /// + public event UpdateDelegate? Update; + } +} diff --git a/Pf2eDataScrapper/ImportApplication.cs b/Pf2eDataScrapper/ImportApplication.cs new file mode 100644 index 0000000..0173c95 --- /dev/null +++ b/Pf2eDataScrapper/ImportApplication.cs @@ -0,0 +1,219 @@ +using System; +using System.ComponentModel; +using System.Windows; +using Microsoft.Extensions.DependencyInjection; +using Pf2eDataScrapper.Helpers; +using Pf2eDataScrapper.Processors; +using Pf2eDataScrapper.Processors.Collection; +using Pf2eDataScrapper.WPF.EntityViewer; +using Pf2eDataScrapper.WPF.ProgressForm; +using Pf2eDataScrapper.WPF.StartForm; +using Pf2eModel; +using Slugify; + +namespace Pf2eDataScrapper; + +internal sealed class ImportApplication : Application +{ + public ImportApplication( + IServiceProvider serviceProvider, + ApplicationSettings settings, + ProcessorCollection processors + ) + { + ServiceProvider = serviceProvider; + Settings = settings; + Processors = processors; + + CurrentStage = ApplicationStage.InitialSettings; + //CurrentStage = ApplicationStage.Viewer; + } + + #region "Поля" + + /// + /// Текущий этап выполнения программы. + /// + public ApplicationStage CurrentStage + { + get => _currentStage; + set + { + ApplicationStage oldValue = _currentStage; + _currentStage = value; + + CloseStage(oldValue); + StartStage(_currentStage); + } + } + private ApplicationStage _currentStage = ApplicationStage.BootUp; + + #endregion + + #region "Жизненный цикл" + + private StartForm? _startFormWpf; + + private ProgressForm? _progressFormWpf; + + private EntityForm? _entityForm; + + private Window? CurrentWpfForm { get; set; } + + public delegate void ApplicationStateChangeDelegate(object sender, ApplicationStage nextStage); + + private void StartStage(ApplicationStage stage) + { + switch (stage) + { + case ApplicationStage.BootUp: + throw new( + $"{CurrentStage} никогда не должен быть установлен через поле \"CurrentStage\"." + ); + + case ApplicationStage.InitialSettings: + _startFormWpf = ActivatorUtilities.CreateInstance(ServiceProvider); + _startFormWpf.WindowStartupLocation = WindowStartupLocation.CenterScreen; + _startFormWpf.Closing += Wpf_HandleFormClosing; + _startFormWpf.ApplicationStateChange += ApplicationStateChange; + _startFormWpf.Show(); + + CurrentWpfForm = _startFormWpf; + break; + + case ApplicationStage.ImportProcess: + ProcessorExecutor executor = ActivatorUtilities.CreateInstance( + ServiceProvider + ); + + _progressFormWpf = ActivatorUtilities.CreateInstance(ServiceProvider); + _progressFormWpf.WindowStartupLocation = WindowStartupLocation.CenterScreen; + _progressFormWpf.Closing += Wpf_HandleFormClosing; + _progressFormWpf.ApplicationStateChange += ApplicationStateChange; + _progressFormWpf.Show(); + + CurrentWpfForm = _progressFormWpf; + + executor.Start(); + break; + + case ApplicationStage.Viewer: + _entityForm = ActivatorUtilities.CreateInstance(ServiceProvider); + _entityForm.WindowStartupLocation = WindowStartupLocation.CenterScreen; + _entityForm.Closing += Wpf_HandleFormClosing; + _entityForm.ApplicationStateChange += ApplicationStateChange; + _entityForm.Show(); + + CurrentWpfForm = _entityForm; + break; + + default: + throw new ArgumentOutOfRangeException(); + } + } + + private void CloseStage(ApplicationStage stage) + { + CurrentWpfForm = null; + + switch (stage) + { + case ApplicationStage.BootUp: + // Нечего закрывать + break; + + case ApplicationStage.InitialSettings: + _startFormWpf!.Hide(); + _startFormWpf!.Close(); + _startFormWpf = null; + break; + + case ApplicationStage.ImportProcess: + _progressFormWpf!.Hide(); + _progressFormWpf!.Close(); + _progressFormWpf = null; + break; + + case ApplicationStage.Viewer: + _entityForm!.Hide(); + _entityForm!.Close(); + _entityForm = null; + break; + + default: + throw new ArgumentOutOfRangeException(nameof(stage)); + } + } + + #endregion + + #region "События" + + public void ApplicationStateChange(object sender, ApplicationStage nextStage) + { + if (sender?.Equals(CurrentWpfForm) ?? false) + { + CurrentStage = nextStage; + } + } + + private void Wpf_HandleFormClosing(object? sender, CancelEventArgs e) + { + if (sender?.Equals(CurrentWpfForm) ?? false) + { + Shutdown(); + } + else + { + e.Cancel = true; + } + } + #endregion + + #region "Внедрение зависимостей" + + public IServiceProvider ServiceProvider { get; } + public ApplicationSettings Settings { get; } + public ProcessorCollection Processors { get; } + + public static void RegisterServices(IServiceCollection services) + { + // Контекст базы данных + services.AddEntityFrameworkNpgsql(); + + services.AddDbContext(); + //services.AddDbContextPool(options => + //{ + // options.Us + //}); + + // Основная программа + services.AddSingleton(); + + // Настройки программы + services.AddSingleton(); + + // Набор процессоров + services.AddSingleton(); + + // Помощник идентификации базы данных + services.AddSingleton(); + + // Помощник создание URL-совместимых названий + services.AddTransient(); + + // Счётчик прогресса + services.AddSingleton(); + } + + #endregion +} + +internal enum ApplicationStage +{ + BootUp, + InitialSettings, + ImportProcess, + Viewer, + Rules, +} diff --git a/Pf2eDataScrapper/Importers/AbstractCompendium.cs b/Pf2eDataScrapper/Importers/AbstractCompendium.cs new file mode 100644 index 0000000..ee6d349 --- /dev/null +++ b/Pf2eDataScrapper/Importers/AbstractCompendium.cs @@ -0,0 +1,38 @@ +using System; +using System.Collections.Generic; +using Newtonsoft.Json.Linq; +using Pf2eDataScrapper.Importers.Repositories; + +namespace Pf2eDataScrapper.Importers; + +/// +/// Компендиум данных. +/// +internal abstract class AbstractCompendium +{ + /// + /// Репозиторий данных. + /// + public abstract AbstractImporterRepository Repository { get; } + + /// + /// Путь к хранению исходных данных. + /// + public string Dir => Repository.RepositoryDirPath; + + /// + /// Возвращает количество элементов для указанного типа данных. + /// + /// Типы данных. + /// Количество элементов. + public abstract int Count(params ICollection type); + + /// + /// Получение итератора сущностей. Если указан тип - то только указанного типа. + /// + /// Типы сущностей, которые нужно получить. + /// Итератор сущностей. + public abstract IEnumerable> Iterate( + params ICollection type + ); +} diff --git a/Pf2eDataScrapper/Importers/AbstractCompendiumItem.cs b/Pf2eDataScrapper/Importers/AbstractCompendiumItem.cs new file mode 100644 index 0000000..eeca1a2 --- /dev/null +++ b/Pf2eDataScrapper/Importers/AbstractCompendiumItem.cs @@ -0,0 +1,23 @@ +namespace Pf2eDataScrapper.Importers; + +/// +/// Абстрактная ссылка на сущность. +/// +internal abstract class AbstractCompendiumItem +{ + /// + /// Идентификатор сущности. + /// + public abstract string Id { get; } + + /// + /// Тип сущности. + /// + public abstract string Type { get; } + + /// + /// Строковое представление имени сущности. + /// + /// Строковое представление. + public override string ToString() => Id; +} diff --git a/Pf2eDataScrapper/Importers/AbstractImporter.cs b/Pf2eDataScrapper/Importers/AbstractImporter.cs index fcddf09..1fc79f9 100644 --- a/Pf2eDataScrapper/Importers/AbstractImporter.cs +++ b/Pf2eDataScrapper/Importers/AbstractImporter.cs @@ -1,4 +1,4 @@ -using Pf2eDataScrapper.Importers.Repositories; +using System.IO; namespace Pf2eDataScrapper.Importers; @@ -17,34 +17,8 @@ internal abstract class AbstractImporter /// public abstract string Slug { get; } - /// - /// Репозиторий для данных, загруженных из необходимых источников. - /// - public abstract AbstractImporterRepository Repository { get; } - /// /// Путь к директории с данными для импортёра. /// public string Dir => Path.Combine(EnvSettings.DataDirPath, Slug); - - /// - /// Перечисление процессоров, которые будут использоваться для обработки данных. - /// При пустом массиве будут обработаны все доступные процессоры. - /// - public string[] ProcessorNames { get; set; } = []; - - /// - /// Метод подготовки данных для импорта. - /// - public abstract void Prepare(); - - /// - /// Импорт данных - /// - public abstract void Import(); - - /// - /// Построение схем данных. - /// - public abstract void BuildSchemas(); } diff --git a/Pf2eDataScrapper/Importers/Implementations/Aonprd/AonprdImporter.cs b/Pf2eDataScrapper/Importers/Implementations/Aonprd/AonprdImporter.cs index b6443dc..21d2094 100644 --- a/Pf2eDataScrapper/Importers/Implementations/Aonprd/AonprdImporter.cs +++ b/Pf2eDataScrapper/Importers/Implementations/Aonprd/AonprdImporter.cs @@ -1,6 +1,7 @@ -using Pf2eDataScrapper.Importers.Implementations.Aonprd.DataBuilder; -using Pf2eDataScrapper.Importers.Implementations.Aonprd.SchemaBuilder; -using Pf2eDataScrapper.Importers.Repositories; +using Microsoft.Extensions.DependencyInjection; +using Pf2eDataScrapper.Importers.Implementations.Aonprd.Compendium; +using Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers; +using StringHelper = Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.StringHelper; namespace Pf2eDataScrapper.Importers.Implementations.Aonprd; @@ -9,57 +10,31 @@ namespace Pf2eDataScrapper.Importers.Implementations.Aonprd; /// internal class AonprdImporter : AbstractImporter { + /// + /// Название внешней ссылки. + /// + public const string TargetName = "Archives of Nethys Pathfinder 2e"; + /// public override string Name => TargetName; /// public override string Slug => "aonprd"; - /// - public override AbstractImporterRepository Repository => - new AonprdRepository(this, "https://elasticsearch.aonprd.com"); + #region "Внедрение зависимостей" - /// - /// Инструмент для работы с данными сайта Архивов Нефеса. - /// - public AonprdLoader Loader { get; } - - /// - /// Конструктор класса . - /// - public AonprdImporter() + public static void RegisterServices(IServiceCollection services) { - Loader = new(this); + services.AddSingleton(); + services.AddSingleton(); + services.AddSingleton(); + + services.AddSingleton(); + services.AddSingleton(); + services.AddTransient(); + + AonprdProcessorInputExtension.RegisterServices(services); } - /// - public override void Prepare() - { - Repository.Update(); - Loader.Prepare(); - } - - /// - public override void BuildSchemas() - { - AonprdSchemaBuilder builder = new(Loader); - - builder.BuildSchemas(); - builder.Save(EnvSettings.OutputDir); - } - - /// - public override void Import() - { - AonprdDataBuilder builder = new(Loader); - builder.Processors.UseOnlyNames(ProcessorNames); - - builder.TruncateTables(); - builder.Build(); - } - - /// - /// Название внешней ссылки. - /// - public const string TargetName = "Archives of Nethys Pathfinder 2e"; + #endregion } diff --git a/Pf2eDataScrapper/Importers/Implementations/Aonprd/AonprdLoader.cs b/Pf2eDataScrapper/Importers/Implementations/Aonprd/AonprdLoader.cs deleted file mode 100644 index d97b8ec..0000000 --- a/Pf2eDataScrapper/Importers/Implementations/Aonprd/AonprdLoader.cs +++ /dev/null @@ -1,105 +0,0 @@ -using Newtonsoft.Json.Linq; -using Pf2eDataScrapper.Importers.Implementations.Aonprd.Compendium; - -namespace Pf2eDataScrapper.Importers.Implementations.Aonprd; - -/// -/// Класс загрузки данных с сайта Архивов Нефеса. -/// -internal class AonprdLoader(AonprdImporter importer) -{ - /// - /// Референс на импортер, используемый для загрузки данных. - /// - public AonprdImporter Importer { get; } = importer; - - /// - /// Компендиум данных с сайта Архивов Нефеса. - /// - public AonprdCompendium Compendium { get; } = new(); - - /// - /// Число элементов в компендарии. - /// - public int ItemCount => Compendium.Count(); - - /// - /// Подготовка данных перед загрузкой. - /// - public void Prepare() - { - using StreamReader indexFile = new(Path.Combine(Importer.Dir, "index.json")); - JObject indexJson = JObject.Parse(indexFile.ReadToEnd()); - - foreach ((string file, JToken? value) in indexJson) - { - JArray items = (JArray)value!; - - foreach (JToken item in items) - { - Compendium.AddReference(item.ToString(), file); - } - } - } - - /// - /// Возвращает коллекцию всех доступных загружаемых элементов. - /// - /// Коллекция всех загружаемых элементов. - public IEnumerable Entries() - { - return Entries([.. Compendium.Types.Keys]); - } - - /// - /// Возвращает коллекцию доступных загружаемых элементов. - /// - /// Тип, которые нужно включить в результат. - /// Коллекция загружаемых элементов, соответствующих предоставленному типу. - public IEnumerable Entries(string types) - { - return Entries([types]); - } - - /// - /// Возвращает коллекцию доступных загружаемых элементов. - /// - /// Типы, которые нужно включить в результат. - /// Коллекция загружаемых элементов, соответствующих предоставленным типам. - public IEnumerable Entries(string[] types) - { - foreach (string file in Compendium.Files(types)) - { - using StreamReader fileReader = new(Path.Combine(Importer.Dir, $"{file}.json")); - JArray array = JArray.Parse(fileReader.ReadToEnd()); - - foreach (JToken item in array) - { - string? id = item.SelectToken("id")?.ToString(); - - if (id is null) - { - continue; - } - - LoaderEntry entry = new(id, file, (JObject)item); - - if (types.Contains(entry.Type)) - { - yield return entry; - } - } - } - } - - /// - /// Класс, представляющий загружаемый элемент. - /// - public class LoaderEntry(string id, string file, JObject itemJson) : AonprdReference(id, file) - { - /// - /// Возвращает JSON-объект, содерждающий данные о элементе. - /// - public JObject Json { get; } = itemJson; - } -} diff --git a/Pf2eDataScrapper/Importers/Implementations/Aonprd/AonprdRepository.cs b/Pf2eDataScrapper/Importers/Implementations/Aonprd/AonprdRepository.cs index ba05d9b..c075b3d 100644 --- a/Pf2eDataScrapper/Importers/Implementations/Aonprd/AonprdRepository.cs +++ b/Pf2eDataScrapper/Importers/Implementations/Aonprd/AonprdRepository.cs @@ -1,5 +1,10 @@ -using Konsole; +using System; +using System.Collections.Generic; +using System.IO; +using System.Net.Http; +using System.Threading.Tasks; using Newtonsoft.Json.Linq; +using Pf2eDataScrapper.Helpers; using Pf2eDataScrapper.Importers.Repositories; namespace Pf2eDataScrapper.Importers.Implementations.Aonprd; @@ -7,13 +12,12 @@ namespace Pf2eDataScrapper.Importers.Implementations.Aonprd; /// /// Основной класс для работы с репозиторием данных Aonprd. /// -internal class AonprdRepository(AbstractImporter importer, string searchUrl) - : AbstractImporterRepository(importer) +internal class AonprdRepository(AonprdImporter importer) : AbstractImporterRepository(importer) { /// /// URL для доступа к API Aonprd. /// - public readonly string SearchUrl = searchUrl; + public const string SearchUrl = "https://elasticsearch.aonprd.com"; /// /// Текущая ревизия данных. Значение обновляется при обновлении репозитория. @@ -38,18 +42,21 @@ internal class AonprdRepository(AbstractImporter importer, string searchUrl) } /// - public override void Update() + public override void Update(ProcessProgress progress) { if (CheckRevision()) { - Console.WriteLine($"Данные Aonprd актуальны, текущая ревизия {Revision}."); + progress.Local.Complete(); + progress.Information($"Данные Aonprd актуальны, текущая ревизия {Revision}."); return; } - Console.WriteLine( + progress.Information( $"Данные Aonprd устарели, обновляем {RepositoryDirPath} до ревизии {Revision}..." ); + progress.Local.Reset(1); + if (Directory.Exists(RepositoryDirPath)) { Directory.Delete(RepositoryDirPath, true); @@ -58,27 +65,28 @@ internal class AonprdRepository(AbstractImporter importer, string searchUrl) WriteFile("revision.txt", Revision.ToString()); - Console.WriteLine("Загрузка индекса..."); + progress.Local.Start("Загрузка индекса..."); + string indexContent = Load($"/json-data/aon{Revision}-index.json"); WriteFile("index.json", indexContent); JObject indexJson = JObject.Parse(indexContent); - Console.WriteLine("Загрузка индексных файлов..."); - - ProgressBar bar = new(indexJson.Count); - int i = 0; + progress.Local.Reset(indexJson.Count + 1); + progress.Local.End(); foreach (KeyValuePair kvp in indexJson) { string fileName = kvp.Key; - bar.Refresh(i++, fileName); + progress.Local.Start(fileName); string fileContent = Load($"/json-data/{fileName}.json"); WriteFile($"{fileName}.json", fileContent); + + progress.Local.End(); } - bar.Refresh(indexJson.Count, "Готово!"); + progress.Local.Complete(); } /// @@ -91,7 +99,7 @@ internal class AonprdRepository(AbstractImporter importer, string searchUrl) Revision = Convert.ToInt32( page.SelectToken("_index")?.ToObject()?.Replace("aon", "") - ?? throw new Exception("Can't get revision") + ?? throw new("Не удаётся получить ревизию Архивов Нефиса.") ); string revisionFile = Path.Combine(RepositoryDirPath, "revision.txt"); diff --git a/Pf2eDataScrapper/Importers/Implementations/Aonprd/Compendium/AonprdCompendium.cs b/Pf2eDataScrapper/Importers/Implementations/Aonprd/Compendium/AonprdCompendium.cs index e7df834..ea64077 100644 --- a/Pf2eDataScrapper/Importers/Implementations/Aonprd/Compendium/AonprdCompendium.cs +++ b/Pf2eDataScrapper/Importers/Implementations/Aonprd/Compendium/AonprdCompendium.cs @@ -1,53 +1,68 @@ -namespace Pf2eDataScrapper.Importers.Implementations.Aonprd.Compendium; +using System; +using System.Collections.Concurrent; +using System.Collections.Generic; +using System.IO; +using System.Linq; +using Newtonsoft.Json.Linq; + +namespace Pf2eDataScrapper.Importers.Implementations.Aonprd.Compendium; /// /// Класс хранения данных компендиума. /// -internal class AonprdCompendium +internal sealed class AonprdCompendium(AonprdRepository repository) : AbstractCompendium { - /// - /// Словарь данных компендиума. - /// - public readonly Dictionary Types = []; + /// + public override AonprdRepository Repository { get; } = repository; /// - /// Добавить ссылку на сущность с указанием файла, в котором она хранится. + /// Коллекция всех записей компендиума. /// - /// Идентификатор сущности. - /// Имя файла. - public void AddReference(string id, string file) + public ConcurrentBag Items { get; } = []; + + /// + public override int Count(params ICollection types) => + types.Count == 0 ? Items.Count : Items.Count(i => types.Contains(i.Type)); + + /// + public override IEnumerable> Iterate( + params ICollection types + ) { - AonprdReference reference = new(id, file); + IEnumerable files = + types.Count == 0 + ? Items.Select(item => item.File).Distinct() + : Items + .Where(item => types.Contains(item.Type)) + .Select(item => item.File) + .Distinct(); - if (Types.TryGetValue(reference.Type, out AonprdType? type)) + foreach (string file in files) { - type.Add(reference); - } - else - { - Types.Add(reference.Type, new(reference)); + Dictionary fileReferences = Items + .Where(i => i.File == file) + .ToDictionary(i => i.Id); + + using StreamReader fileReader = new( + Path.Combine(Repository.RepositoryDirPath, $"{file}.json") + ); + JArray array = JArray.Parse(fileReader.ReadToEnd()); + + foreach (JToken item in array) + { + string? id = item.SelectToken("id")?.ToString(); + + if ( + id is null + || !fileReferences.TryGetValue(id, out AonprdCompendiumItem? reference) + || !types.Contains(reference.Type) + ) + { + continue; + } + + yield return new(reference, (JObject)item); + } } } - - /// - /// Возвращает количество элементов в компендиуме. - /// - /// Количество элементов. - public int Count() => Types.Values.Sum(t => t.Count); - - /// - /// Возвращает количество элементов для указанных типов данных. - /// - /// Список типов. - /// Количество элементов. - public int Count(IEnumerable types) => - Types.Values.Where(t => types.Contains(t.Type)).Sum(t => t.Count); - - /// - /// Возвращает список файлов для выбора сущностей указанных типов данных. - /// - /// Список типов. - /// Список искомых файлов. - public IEnumerable Files(IEnumerable types) => - Types.Values.Where(t => types.Contains(t.Type)).SelectMany(t => t.Files).Distinct(); } diff --git a/Pf2eDataScrapper/Importers/Implementations/Aonprd/Compendium/AonprdReference.cs b/Pf2eDataScrapper/Importers/Implementations/Aonprd/Compendium/AonprdCompendiumItem.cs similarity index 81% rename from Pf2eDataScrapper/Importers/Implementations/Aonprd/Compendium/AonprdReference.cs rename to Pf2eDataScrapper/Importers/Implementations/Aonprd/Compendium/AonprdCompendiumItem.cs index 98ebbdd..695929b 100644 --- a/Pf2eDataScrapper/Importers/Implementations/Aonprd/Compendium/AonprdReference.cs +++ b/Pf2eDataScrapper/Importers/Implementations/Aonprd/Compendium/AonprdCompendiumItem.cs @@ -5,27 +5,27 @@ /// /// Идентификатор сущности. /// Имя файла. -internal class AonprdReference(string id, string file) +internal class AonprdCompendiumItem(string id, string file) : AbstractCompendiumItem { /// /// Идентификатор сущности. /// - public readonly string Id = id; + public override string Id { get; } = id; /// /// Тип сущности. /// - public readonly string Type = ResolveType(id); + public override string Type { get; } = ResolveType(id); /// /// Имя файла, в котором хранится сущность. /// - public readonly string File = file; + public string File { get; } = file; /// /// Определение типа сущности как префикса идентификатора. /// - private static string ResolveType(string id) + public static string ResolveType(string id) { string type = string.Join('-', id.Split('-')[..^1]); diff --git a/Pf2eDataScrapper/Importers/Implementations/Aonprd/Compendium/AonprdType.cs b/Pf2eDataScrapper/Importers/Implementations/Aonprd/Compendium/AonprdType.cs deleted file mode 100644 index 8f43ff7..0000000 --- a/Pf2eDataScrapper/Importers/Implementations/Aonprd/Compendium/AonprdType.cs +++ /dev/null @@ -1,42 +0,0 @@ -namespace Pf2eDataScrapper.Importers.Implementations.Aonprd.Compendium; - -/// -/// Класс AonprdType представляет собой уникальный тип данных, связанный с Aon (Advanced Opportunity Network). -/// Это основной класс, который хранит информацию о различных элементах системы. -/// -internal class AonprdType(string type) -{ - /// - /// Идентификатор типа данных. - /// - public readonly string Type = type; - - /// - /// Список ссылок на сущности, связанных с этим типом. - /// - public readonly List Items = []; - - public AonprdType(AonprdReference reference) - : this(reference.Type) - { - Items.Add(reference); - } - - /// - /// Добавляет новую ссылку в список. - /// - public void Add(AonprdReference reference) - { - Items.Add(reference); - } - - /// - /// Возвращает уникальные файлы, использованные в ссылках. - /// - public List Files => Items.Select(x => x.File).Distinct().ToList(); - - /// - /// Число элементов в списке ссылок. - /// - public int Count => Items.Count; -} diff --git a/Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/AonprdDataBuilder.cs b/Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/AonprdDataBuilder.cs deleted file mode 100644 index 1f94777..0000000 --- a/Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/AonprdDataBuilder.cs +++ /dev/null @@ -1,148 +0,0 @@ -using Konsole; -using Newtonsoft.Json.Linq; -using Pf2eDataScrapper.Importers.Implementations.Aonprd.Compendium; -using Pf2eDataScrapper.Importers.Implementations.Aonprd.DataBuilder.Processors; - -namespace Pf2eDataScrapper.Importers.Implementations.Aonprd.DataBuilder; - -/// -/// Класс для создание схемы данных Архива Нефиса. -/// -/// -internal class AonprdDataBuilder(AonprdLoader loader) -{ - /// - /// Класс работы с базой данных. - /// - public readonly Pf2eDatabase Database = Pf2eDatabase.Instance; - - /// - /// Основной класс для работы с данными Архива Нефиса. - /// - public readonly AonprdLoader Loader = loader; - - /// - /// Коллекция папок компендиума. - /// - public AonprdCompendium Compendium => Loader.Compendium; - - /// - /// Коллекция обработчиков данных. - /// - public readonly AonprdProcessorCollection Processors = new(); - - /// - /// Очистить таблицы в базе данных. - /// - public void TruncateTables() - { - Console.WriteLine("Truncating all old data..."); - - Database.ExecuteCommand("SELECT f_truncate_tables();"); - - Console.WriteLine("Truncation completed!"); - } - - /// - /// Конфигурация интерфейса вывода результатов. - /// - protected ConcurrentWriter Window = null!; - - /// - /// Основное окно для вывода информации. - /// - protected Window Output = null!; - - /// - /// Полоса прогресса для основного процесса обработки данных. - /// - protected ProgressBar ProcessProgressBar = null!; - - /// - /// Полоса прогресса для под-процессов обработки данных. - /// - protected ProgressBar SubProcessProgressBar = null!; - - /// - /// Метод для настройки интерфейса. - /// - protected void ConfigureWindow() - { - Window = new Window(0, 0, Console.WindowWidth, Console.WindowHeight).Concurrent(); - - IConsole bars = Window.OpenBox( - "Progress", - Console.WindowWidth, - 4, - new() { Body = Colors.WhiteOnBlack } - ); - - Output = new(0, 4, Console.WindowWidth, Console.WindowHeight - 4, Window); - - ProcessProgressBar = new(bars, Processors.Items.Count, 15); - - SubProcessProgressBar = new(bars, 1, 15); - } - - /// - /// Обработка отдельного процессора данных. - /// - protected void RunProcessor(AonprdProcessorCollection.ProcessorItem item, JObject json) - { - AonprdProcessorInput input = new(json); - AbstractProcessor processor = (AbstractProcessor)item.Constructor.Invoke([input]); - - try - { - processor.Process(); - processor.Save(); - } - catch (LegacyItemException ex) - { - Output.WriteLine(ex.Message); - } - catch (SkipItemException ex) - { - Output.WriteLine(ex.Message); - } - } - - /// - /// Полная обработка и сохранение данных. - /// - public void Build() - { - ConfigureWindow(); - - ProcessProgressBar.Refresh(-1, ""); - - foreach (AonprdProcessorCollection.ProcessorItem item in Processors.Iterate()) - { - ProcessProgressBar.Next(item.Attribute.Name); - - SubProcessProgressBar.Refresh(-1, "Starting..."); - - if (item.Attribute.Type is null) - { - RunProcessor(item, []); - continue; - } - - SubProcessProgressBar.Max = Compendium.Count([item.Attribute.Type]); - - foreach (AonprdLoader.LoaderEntry entry in Loader.Entries(item.Attribute.Type)) - { - SubProcessProgressBar.Next($"{entry.Id}"); - RunProcessor(item, entry.Json); - } - - SubProcessProgressBar.Next("Ready"); - - DatabaseHelper.ResetContext(); - } - - ProcessProgressBar.Next("Done!"); - - Window.Clear(); - } -} diff --git a/Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/AonprdProcessorAttribute.cs b/Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/AonprdProcessorAttribute.cs deleted file mode 100644 index faac790..0000000 --- a/Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/AonprdProcessorAttribute.cs +++ /dev/null @@ -1,65 +0,0 @@ -namespace Pf2eDataScrapper.Importers.Implementations.Aonprd.DataBuilder; - -/// -/// Атрибут обработчика данных Архивов Нефиса. -/// -/// Название обработчика. -/// Тип данных, которые обработчик обрабатывает. -/// Названия обработчиков, которые должны быть выполнены до запуска этого обработчика. -/// Флаг, указывающий, следует ли добавить важные общие зависимости для обработчка. -[AttributeUsage(AttributeTargets.Class)] -public class AonprdProcessorAttribute( - string name, - string? type, - string[] dependencies, - bool includeDefaults = true -) : Attribute -{ - /// - /// Важные общие зависимости для обработчка. - /// - private static readonly string[] DefaultDependencies = ["trait", "source"]; - - /// - /// Название обработчика. - /// - public readonly string Name = name; - - /// - /// Тип данных, которые обработчик обрабатывает. - /// - public readonly string? Type = type; - - /// - /// Названия обработчиков, которые должны быть выполнены до запуска этого обработчика. - /// - public readonly IEnumerable Dependencies = - [ - .. includeDefaults ? DefaultDependencies : [], - .. dependencies, - ]; - - /// - /// Конструктор класса со стандартными общими зависимости для обработчка. - /// - /// Тип данных, которые обработчик обрабатывает. Также будет использоваться в качестве названия. - public AonprdProcessorAttribute(string type) - : this(type, type, DefaultDependencies) { } - - /// - /// Конструктор класса . - /// - /// Тип данных, которые обработчик обрабатывает. Также будет использоваться в качестве названия. - /// Названия обработчиков, которые должны быть выполнены до запуска этого обработчика. - /// Флаг, указывающий, следует ли добавить важные общие зависимости для обработчка. - public AonprdProcessorAttribute(string type, string[] dependencies, bool includeDefaults = true) - : this(type, type, dependencies, includeDefaults) { } - - /// - /// Конструктор класса со стандартными общими зависимости для обработчка. - /// - /// Название обработчика. - /// Тип данных, которые обработчик обрабатывает. - public AonprdProcessorAttribute(string name, string type) - : this(name, type, DefaultDependencies) { } -} diff --git a/Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/AonprdProcessorCollection.cs b/Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/AonprdProcessorCollection.cs deleted file mode 100644 index 9d66d8a..0000000 --- a/Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/AonprdProcessorCollection.cs +++ /dev/null @@ -1,187 +0,0 @@ -using System.Reflection; -using Pf2eDataScrapper.Importers.Implementations.Aonprd.DataBuilder.Processors; - -namespace Pf2eDataScrapper.Importers.Implementations.Aonprd.DataBuilder; - -/// -/// Класс отвечает за управление обработчиками, отмеченных атрибутом . -/// -internal class AonprdProcessorCollection -{ - /// - /// Элемент коллекции обработчика. - /// - /// Атрибут, связанный с обаботчиком. - /// Конструктор обработчика. - public class ProcessorItem(AonprdProcessorAttribute attribute, ConstructorInfo constructor) - { - /// - /// Атрибут, связанный с обаботчиком. - /// - public readonly AonprdProcessorAttribute Attribute = attribute; - - /// - /// Конструктор обработчика. - /// - public readonly ConstructorInfo Constructor = constructor; - - /// - /// Приоритет выполнения обработчика. - /// - public int Priority = -1; - } - - /// - /// Список всех объявленных обработчиков. - /// - private readonly List _allItems; - - /// - /// Список используемых обработчиков. - /// - public List Items { get; private set; } = []; - - /// - /// Конструктор класса , загружающий все обработчики. - /// - public AonprdProcessorCollection() - { - foreach (Type type in Assembly.GetExecutingAssembly().GetTypes()) - { - if (type.GetCustomAttributes(typeof(AonprdProcessorAttribute), true).Length <= 0) - { - continue; - } - - if (!type.IsSubclassOf(typeof(AbstractProcessor))) - { - throw new( - $"'AonprdProcessor' attribute should only be applied to children of 'AbstractProcessor' class. '{type.FullName}' is not." - ); - } - - AonprdProcessorAttribute attribute = - type.GetCustomAttribute()!; - - ConstructorInfo constructor = type.GetConstructor([typeof(AonprdProcessorInput)])!; - - ProcessorItem? collision = Items.FirstOrDefault(i => - i.Attribute.Name == attribute.Name - ); - if (collision is not null) - { - throw new( - $"Multiply attributes 'AonprdProcessor' have same name '{attribute.Name}'." - + $" They are added to classes: '{type.FullName}' and '{collision.Constructor.DeclaringType!.FullName}'" - ); - } - - Items.Add(new(attribute, constructor)); - } - - _allItems = Items.ToList(); - } - - /// - /// Проверка, что все зависимости всех обработчиков могут быть удовлетворены. - /// - private void CheckDependencies() - { - foreach (ProcessorItem item in Items) - { - foreach (string dependency in item.Attribute.Dependencies) - { - if (Items.All(i => i.Attribute.Name != dependency)) - { - throw new( - $"Dependency '{dependency}' for processor '{item.Attribute.Name}' not found." - ); - } - } - } - } - - /// - /// Сортировать обработчики в соответсвии со всеми зависимостями. - /// - private void SortItems() - { - CheckDependencies(); - - Dictionary priorities = []; - - while (priorities.Count < Items.Count) - { - foreach (ProcessorItem item in Items) - { - if (item.Priority > 0) - { - continue; - } - - IEnumerable dependencyPriorities = item.Attribute.Dependencies.Select(d => - priorities.GetValueOrDefault(d, -1) - ); - - if (dependencyPriorities.Any(p => p == -1)) - { - continue; - } - - item.Priority = dependencyPriorities.Any() ? dependencyPriorities.Max() + 1 : 1; - priorities.Add(item.Attribute.Name, item.Priority); - } - } - - Items.Sort((a, b) => a.Priority - b.Priority); - } - - /// - /// Итерация через все используемые обработчики. - /// - /// Итератор. - public IEnumerable Iterate() - { - SortItems(); - - foreach (ProcessorItem item in Items) - { - yield return item; - } - } - - /// - /// Ограничить список используемых обработчиков по названию. - /// Автоматически включает все обработчики, от которых зависят указанные в аргументе обработчики. - /// - /// Коллекция названиий требуемых обработчиков. - public void UseOnlyNames(ICollection processorNames) - { - if (processorNames.Count == 0) - { - Items = _allItems; - return; - } - - Dictionary nameFlags = processorNames.ToDictionary(name => name, _ => false); - - while (nameFlags.Values.Any(v => !v)) - { - foreach ( - KeyValuePair pair in nameFlags.Where(pair => !pair.Value).ToList() - ) - { - ProcessorItem item = _allItems.First(item => item.Attribute.Name == pair.Key); - - foreach (string dependency in item.Attribute.Dependencies) - { - nameFlags.TryAdd(dependency, false); - } - - nameFlags[pair.Key] = true; - } - } - - Items = _allItems.Where(item => nameFlags.ContainsKey(item.Attribute.Name)).ToList(); - } -} diff --git a/Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/AonprdProcessorInput.cs b/Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/AonprdProcessorInput.cs deleted file mode 100644 index d369fec..0000000 --- a/Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/AonprdProcessorInput.cs +++ /dev/null @@ -1,137 +0,0 @@ -using Newtonsoft.Json.Linq; -using Pf2eDataScrapper.Importers.Implementations.Aonprd.DataBuilder.Helpers; - -namespace Pf2eDataScrapper.Importers.Implementations.Aonprd.DataBuilder; - -/// -/// Класс для работы с JSON-объектом при обработки данных с Архивов Нефиса. -/// -/// JSON-объект, который будет использоваться для доступа к данным. -internal class AonprdProcessorInput(JObject input) : ProcessorInput(input) -{ - /// - public override T Enum(string value) - { - try - { - return AonprdEnumResolver.Resolve(value); - } - catch - { - return base.Enum(value); - } - } - - /// - /// Обработать строку, содержащую информацию о количестве действий. - /// - /// Входная строка с данными. - /// Структура, хранящая информацию о количетсве действий. - public ActionStruct ResolveActionString(string input) - { - ActionStruct result = new(); - - switch (input) - { - case "Single Action": - result.Actions = result.MaxActions = 1; - break; - - case "Two Actions": - result.Actions = result.MaxActions = 2; - break; - - case "Three Actions": - result.Actions = result.MaxActions = 3; - break; - - case "Reaction": - result.IsReaction = true; - break; - - case "Free Action": - result.IsFreeAction = false; - break; - - case "Single Action to Three Actions": - case "Single Action or more Actions": - result.Actions = 1; - result.MaxActions = 3; - break; - - case "Single Action or Two Actions": - case "Single Action to Two Actions": - result.Actions = 1; - result.MaxActions = 2; - break; - - case "Two Actions or Three Actions": - result.Actions = 2; - result.MaxActions = 3; - break; - - case "Two Actions to 2 rounds": - result.Actions = 2; - result.MaxActions = 3; - result.TwoRounds = true; - break; - - case "Reaction or One Action": - result.IsReaction = true; - result.Actions = result.MaxActions = 1; - break; - - case "Reaction or Two Actions": - result.IsReaction = true; - result.Actions = result.MaxActions = 2; - break; - - case "Free Action or One Action": - result.IsFreeAction = false; - result.Actions = result.MaxActions = 1; - break; - - default: - result.IsPassive = true; - break; - } - - return result; - } - - /// - /// Класс структуры, хранящей информацию о количетсве действий. - /// - public class ActionStruct - { - /// - /// Количество действий - /// - public int Actions { get; set; } - - /// - /// Максимальное количество действий - /// - public int MaxActions { get; set; } - - /// - /// Флаг, указывающий, что действия не требуются. - /// - public bool IsPassive { get; set; } - - /// - /// Флаг, указывающий, что действие может быть использовано как реакция. - /// - public bool IsReaction { get; set; } - - /// - /// Флаг, указывающий, что можно использовать свободное действие. - /// - public bool IsFreeAction { get; set; } - - /// - /// Флаг, указывающий, что действие может быть продлено до 2 раундов. - /// - public bool TwoRounds { get; set; } - } -} diff --git a/Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/Helpers/AonprdBuilderGlobals.cs b/Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/Helpers/AonprdBuilderGlobals.cs deleted file mode 100644 index def6837..0000000 --- a/Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/Helpers/AonprdBuilderGlobals.cs +++ /dev/null @@ -1,25 +0,0 @@ -using Pf2eModel.Model.Base.Targets; - -namespace Pf2eDataScrapper.Importers.Implementations.Aonprd.DataBuilder.Helpers; - -/// -/// Класс-помощник, хранящий необходимые глобальные данные. -/// Реализует шаблон Singleton. -/// -internal class AonprdBuilderGlobals -{ - /// - /// Цель внешних ссылок Архивов Нефисов. - /// - public ExternalTarget AonprdTarget = null!; - - /// - /// Конструктор класса . - /// - private AonprdBuilderGlobals() { } - - /// - /// Экземпляр класса . - /// - public static readonly AonprdBuilderGlobals Instance = new(); -} diff --git a/Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/Helpers/AonprdEnumResolver.cs b/Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/Helpers/AonprdEnumResolver.cs deleted file mode 100644 index e4f395c..0000000 --- a/Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/Helpers/AonprdEnumResolver.cs +++ /dev/null @@ -1,134 +0,0 @@ -using Pf2eModel.Model.Enum; - -namespace Pf2eDataScrapper.Importers.Implementations.Aonprd.DataBuilder.Helpers; - -/// -/// Класс, помогающий разрешить строковые значения с Архивов Нефиса в перечисления. -/// -public static class AonprdEnumResolver -{ - /// - /// Коллекция классов, разрешающих строковые значения в перечисления. - /// - private static readonly ICollection Solvers = - [ - new Solver( - new() - { - { "Rulebooks", SourceCategory.Rulebooks }, - { "Adventure Paths", SourceCategory.AdventurePaths }, - { "Lost Omens", SourceCategory.LostOmens }, - { "Adventures", SourceCategory.Adventures }, - { "Comics", SourceCategory.Comics }, - { "Blog Posts", SourceCategory.BlogPosts }, - { "Society", SourceCategory.Society }, - } - ), - new Solver( - new() - { - { "Low-Light VisionEnum", VisionEnum.LowLightVision }, - { "Darkvision", VisionEnum.DarkVision }, - } - ), - new Solver( - new() - { - { "Consitution", AttributeValues.Constitution }, - { "Other", AttributeValues.Free }, - { "other", AttributeValues.Free }, - } - ), - new Solver( - new() - { - { "Single Action", ActionEnum.SingleAction }, - { "Two Actions", ActionEnum.TwoActions }, - { "Three Actions", ActionEnum.ThreeActions }, - { "Reaction", ActionEnum.Reaction }, - { "Free Action", ActionEnum.FreeAction }, - { "Single Action to Three Actions", ActionEnum.SingleActionToThreeActions }, - { "Single Action or more Actions", ActionEnum.SingleActionToThreeActions }, - { "Single Action or Two Actions", ActionEnum.SingleActionToTwoActions }, - { "Single Action to Two Actions", ActionEnum.SingleActionToTwoActions }, - { "Two Actions or Three Actions", ActionEnum.TwoActionsToThreeActions }, - { "Two Actions to 2 rounds", ActionEnum.TwoActionsToTwoRounds }, - { "Reaction or One Action", ActionEnum.ReactionOrOneAction }, - { "Reaction or Two Actions", ActionEnum.ReactionOrTwoAction }, - { "Reaction or Three Actions", ActionEnum.ReactionOrThreeAction }, - { "Free Action or One Action", ActionEnum.FreeActionOrOneAction }, - { "1 Minute", ActionEnum.OneMinute }, - { "1 minute", ActionEnum.OneMinute }, - { "5 minutes", ActionEnum.FiveMinutes }, - { "10 minutes", ActionEnum.TenMinutes }, - { "30 minutes", ActionEnum.ThirtyMinutes }, - { "1 hour", ActionEnum.OneHour }, - { "Nethys Note: No cast time was printed", ActionEnum.Unknown }, - } - ), - ]; - - /// - /// Разрешить строковое значение с Архивов Нефиса в перечисление. - /// - /// Тип искомого перечисления. - /// Обрабатываемое строковоее значение. - /// Значение искомого перечисления. - /// - /// Исключение, если для указанного типа перечисления не указан класс, разрешающий строковые значения. - /// - /// - /// Исключение, если указанное значение не получилось преобразовать искомое значение. - /// - public static T Resolve(string value) - where T : Enum - { - Type type = typeof(T); - - Solver? solver = Solvers.FirstOrDefault(s => s.Type == type); - - if (solver is null || solver.GetType() != typeof(Solver)) - { - throw new EnumResolverEnumUnknownException(type); - } - - Solver tSolver = (Solver)solver; - - return tSolver.Data.TryGetValue(value, out T? data) - ? data - : throw new EnumResolverValueUnknownException(type, value); - } - - /// - /// Класс, разрешающий строковые значения в перечисления. - /// - private abstract class Solver - { - public abstract Type Type { get; } - } - - /// - /// Абстрактный общий класс, разрешающий строковые значения в перечисления. - /// - private class Solver(Dictionary data) : Solver - where T : Enum - { - public override Type Type { get; } = typeof(T); - public Dictionary Data { get; } = data; - } - - /// - /// Исключение, указывающее, что для указанного типа перечисления не указан класс, разрешающий строковые значения. - /// - /// Тип искомого перечисления. - public class EnumResolverEnumUnknownException(Type t) - : Exception($"Can't resolve type '{t.FullName}': Solver not defined"); - - /// - /// Исключение, указывающее, что указанное значение не получилось преобразовать искомое значение. - /// - /// Тип искомого перечисления. - /// Искомое значение. - public class EnumResolverValueUnknownException(Type t, string value) - : Exception($"Can't resolve type '{t.FullName}': Value '{value}' is not matched"); -} diff --git a/Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/LegacyEntityHandler.cs b/Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/LegacyEntityHandler.cs deleted file mode 100644 index d5cfc57..0000000 --- a/Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/LegacyEntityHandler.cs +++ /dev/null @@ -1,105 +0,0 @@ -using Pf2eDataScrapper.Importers.Implementations.Aonprd.DataBuilder.Processors; -using Pf2eModel.Model.Base; -using Pf2eModel.Model.Base.Source; -using Pf2eModel.Model.Common.I18n; - -namespace Pf2eDataScrapper.Importers.Implementations.Aonprd.DataBuilder; - -/// -/// Обработчик сущностей, помеченных как устаревшие. -/// -internal class LegacyEntityHandler -{ - /// - /// Идентификатор устаревшей сущности. - /// - public string LegacyId { get; private set; } - - /// - /// Название устаревшей сущности. - /// - public string LegacyName { get; private set; } = ""; - - /// - /// Коллекция источников устревшей сущности. - /// - public List LegacySources { get; private set; } = []; - - /// - /// Флаг, указывающий, что сведения об устаревшей сущности готовы к добавлению в обновлённые. - /// - public bool LegacyPrepared { get; private set; } = false; - - /// - /// Список обновлённых сущностей, что отметели устаревшую сущность как предшественника. - /// - public List RemasterEntities { get; } = []; - - /// - /// Конструктор класса , если сущность сама отмечена как устаревшая. - /// - /// Обработчик устаревшей сущности. - public LegacyEntityHandler(AbstractEntityProcessor processor) - { - LegacyId = processor.Input.GetRequired("id"); - Prepare(processor); - } - - /// - /// Конструктор класса , если обновлённая сущность указывает на ещё недобавленную устаревшую сущность. - /// - /// Идентификатор устаревшей сущности. - /// Обновлённая сущность. - public LegacyEntityHandler(string legacyId, Entity remasterEntity) - { - LegacyId = legacyId; - LegacyPrepared = false; - RemasterEntities.Add(remasterEntity); - } - - /// - /// Подготовить данные об устравшей сущности. - /// - /// Обработчик устаревшей сущности. - public void Prepare(AbstractEntityProcessor processor) - { - if (LegacyPrepared) - { - return; - } - - LegacyName = processor.Input.GetRequired("name"); - LegacySources = processor.GetSources(); - LegacyPrepared = true; - - foreach (Entity remasterEntity in RemasterEntities) - { - Apply(remasterEntity); - } - } - - /// - /// Применить данные устаревшей сущности к обновлённой. - /// - /// Обновлённая сущность. - public void Apply(Entity remasterEntity) - { - if (!remasterEntity.Name.Contains(LegacyName)) - { - remasterEntity.Name[LocaleType.LegacyEnglish] = LegacyName; - } - - foreach (EntitySource legacySource in LegacySources) - { - EntitySource entitySource = new() - { - Entity = remasterEntity, - Source = legacySource.Source, - Suffix = legacySource.Suffix, - IsRemaster = false, - }; - - remasterEntity.Sources.Add(entitySource); - } - } -} diff --git a/Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/Processors/AbstractProcessor.cs b/Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/Processors/AbstractProcessor.cs deleted file mode 100644 index 2129587..0000000 --- a/Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/Processors/AbstractProcessor.cs +++ /dev/null @@ -1,49 +0,0 @@ -using Pf2eDataScrapper.Importers.Implementations.Aonprd.DataBuilder.Helpers; -using Pf2eModel; - -namespace Pf2eDataScrapper.Importers.Implementations.Aonprd.DataBuilder.Processors; - -/// -/// Абстрактный класс-обработчик данных, полученных из Архивов Нефиса. -/// Класс предназначен для обработки данных с помощью различных обработчиков, -/// для которых указан атрибут . -/// -/// Объект обработки вводимого JSON. -/// -internal abstract class AbstractProcessor(AonprdProcessorInput input) -{ - /// - /// Вспомогательный класс для работы с базой данных. - /// - protected readonly DatabaseHelper Helper = DatabaseHelper.Instance; - - /// - /// Вспомогательный класс для работы со строками и форматированием. - /// - protected readonly StringHelper StringHelper = StringHelper.Instance; - - /// - /// Вспомогательный класс для работы с глобальными настройками. - /// - protected readonly AonprdBuilderGlobals Globals = AonprdBuilderGlobals.Instance; - - /// - /// Контекст базы данных для работы с данными. - /// - public readonly Pf2eDbContext Context = DatabaseHelper.DbContext; - - /// - /// Объект обработки вводимого JSON. - /// - public readonly AonprdProcessorInput Input = input; - - /// - /// Основной метод обработки данных. - /// - public abstract void Process(); - - /// - /// Метод для сохранения изменений в базе данных. - /// - public abstract void Save(); -} diff --git a/Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/Processors/Common/ExternalProcessor.cs b/Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/Processors/Common/ExternalProcessor.cs deleted file mode 100644 index fd688fc..0000000 --- a/Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/Processors/Common/ExternalProcessor.cs +++ /dev/null @@ -1,26 +0,0 @@ -using Pf2eModel.Model.Base.Targets; - -namespace Pf2eDataScrapper.Importers.Implementations.Aonprd.DataBuilder.Processors.Common; - -[AonprdProcessor("external", null, [], false)] -internal class ExternalProcessor(AonprdProcessorInput input) : AbstractProcessor(input) -{ - public ExternalTarget AonprdTarget = null!; - - public override void Process() - { - AonprdTarget = new() - { - Name = AonprdImporter.TargetName, - Icon = "http://www.google.com/s2/favicons?domain=2e.aonprd.com", - Prefix = "https://2e.aonprd.com", - }; - } - - public override void Save() - { - Context.ExternalTargets.Add(AonprdTarget); - - Globals.AonprdTarget = AonprdTarget; - } -} diff --git a/Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/Processors/Common/SkillProcessor.cs b/Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/Processors/Common/SkillProcessor.cs deleted file mode 100644 index 26ab2ed..0000000 --- a/Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/Processors/Common/SkillProcessor.cs +++ /dev/null @@ -1,27 +0,0 @@ -using Pf2eModel.Model.Common; -using Pf2eModel.Model.Common.I18n; -using Pf2eModel.Model.Enum; - -namespace Pf2eDataScrapper.Importers.Implementations.Aonprd.DataBuilder.Processors.Common; - -[AonprdProcessor("skill", [], false)] -internal class SkillProcessor(AonprdProcessorInput input) : AbstractProcessor(input) -{ - /// - /// Обучаемый объект. - /// - public Training Training = null!; - - /// - public override void Save() => Context.Trainings.Add(Training); - - /// - public override void Process() - { - Training = new() - { - Name = new() { { LocaleType.English, Input.GetRequired("name") } }, - Type = TrainingType.Skill, - }; - } -} diff --git a/Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/Processors/Common/SourceProcessor.cs b/Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/Processors/Common/SourceProcessor.cs deleted file mode 100644 index 8f0a417..0000000 --- a/Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/Processors/Common/SourceProcessor.cs +++ /dev/null @@ -1,30 +0,0 @@ -using Pf2eModel.Model.Base.Source; -using Pf2eModel.Model.Enum; - -namespace Pf2eDataScrapper.Importers.Implementations.Aonprd.DataBuilder.Processors.Common; - -[AonprdProcessor("source", [], false)] -internal class SourceProcessor(AonprdProcessorInput input) : AbstractProcessor(input) -{ - /// - /// Источник сущности. - /// - protected Source Source = null!; - - /// - public override void Process() - { - Source = new() - { - Name = Input.GetRequired("name"), - Category = Input.EnumRequired("primary_source_category"), - ReleaseDate = DateOnly.Parse(Input.GetRequired("release_date")), - }; - } - - /// - public override void Save() - { - Context.Sources.Add(Source); - } -} diff --git a/Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/Processors/Subclasses/ApparitionProcessor.cs b/Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/Processors/Subclasses/ApparitionProcessor.cs deleted file mode 100644 index b89bf55..0000000 --- a/Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/Processors/Subclasses/ApparitionProcessor.cs +++ /dev/null @@ -1,79 +0,0 @@ -using Pf2eModel; -using Pf2eModel.Model.Base; -using Pf2eModel.Model.Common; -using Pf2eModel.Model.Common.I18n; -using Pf2eModel.Model.Enum; -using Pf2eModel.Model.Structure; - -namespace Pf2eDataScrapper.Importers.Implementations.Aonprd.DataBuilder.Processors.Subclasses; - -[AonprdProcessor("apparition", ["class", "spell", "skill"])] -internal class ApparitionProcessor(AonprdProcessorInput input) : AbstractSubclassProcessor(input) -{ - /// - public override Subclass Object { get; } = new(); - - /// - public override string ClassName => "Animist"; - - /// - public override string GroupName => "Apparition"; - - /// - public override void ProcessObject() - { - // Spells - string spellMd = Input.GetRequired("spells_markdown"); - List spellUrls = StringHelper - .ParseMarkdownLinks(spellMd) - .Links.Select(l => l.Url) - .ToList(); - - List spellIds = Context - .EntityExternals.Where(x => spellUrls.Contains(x.Suffix)) - .Select(x => x.Entity.Id) - .ToList(); - - List spells = Context - .Spells.Where(s => spellIds.Contains(s.Id)) - .Select(s => s.Entity) - .ToList(); - - foreach (Entity spellEntity in spells) - { - Object.Entities.Add(spellEntity); - } - - // Trainings - string trainingMd = Input.GetRequired("skill_markdown"); - - List trainingNames = trainingMd.Split(", ").ToList(); - List trainings = Context - .Trainings.Where(t => Pf2eDbContext.LocaleSearchArray(t.Name, trainingNames)) - .ToList(); - - foreach (string name in trainingNames) - { - Training? training = trainings.FirstOrDefault(t => t.Name.Contains(name)); - training ??= new() - { - Name = new() { { LocaleType.English, name } }, - Type = TrainingType.Lore, - }; - - Object.Trainings.Add( - new() - { - Subclass = Object, - Training = training, - Rank = TrainingRank.Trained, - } - ); - } - } - - /// - protected override string GetDescription() => - base.GetDescription() - + AddedDescription(["skill_markdown", "spell_markdown", "summary_markdown"]); -} diff --git a/Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/Processors/Types/ActionProcessor.cs b/Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/Processors/Types/ActionProcessor.cs deleted file mode 100644 index 8fd6b55..0000000 --- a/Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/Processors/Types/ActionProcessor.cs +++ /dev/null @@ -1,42 +0,0 @@ -using Pf2eModel.Model.Enum; - -namespace Pf2eDataScrapper.Importers.Implementations.Aonprd.DataBuilder.Processors.Types; - -[AonprdProcessor("action")] -internal class ActionProcessor(AonprdProcessorInput input) : AbstractEntityProcessor(input) -{ - /// - public override EntityType Type => EntityType.Action; - - /// - public override Pf2eModel.Model.Structure.Action Object { get; } = new(); - - /// - public override void Add() => Context.Actions.Add(Object); - - /// - public override void Process() - { - if (Input.GetRequired("markdown").StartsWith("**Activate**")) - { - throw new SkipItemException(Input.GetRequired("name"), "activating action"); - } - - base.Process(); - - Object.Actions = Input.EnumOptional("actions", ActionEnum.Passive); - Object.Extra = GenerateJsonString("school"); - } - - /// - protected override string[] AddedDescriptionPaths() => - [ - "cost_markdown", - "trait_markdown", - "source_markdown", - "search_markdown", - "requirement_markdown", - "trigger_markdown", - "summary_markdown", - ]; -} diff --git a/Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/Processors/Types/ArchetypeProcessor.cs b/Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/Processors/Types/ArchetypeProcessor.cs deleted file mode 100644 index a4f5c0b..0000000 --- a/Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/Processors/Types/ArchetypeProcessor.cs +++ /dev/null @@ -1,29 +0,0 @@ -using Pf2eModel.Model.Enum; -using Pf2eModel.Model.Structure; - -namespace Pf2eDataScrapper.Importers.Implementations.Aonprd.DataBuilder.Processors.Types; - -[AonprdProcessor("archetype")] -internal class ArchetypeProcessor(AonprdProcessorInput input) : AbstractEntityProcessor(input) -{ - /// - public override EntityType Type => EntityType.Archetype; - - /// - public override Archetype Object { get; } = new(); - - /// - public override void Add() => Context.Archetypes.Add(Object); - - /// - public override void Process() - { - base.Process(); - - Object.Level = Input.GetOptional("level"); - } - - /// - protected override string[] AddedDescriptionPaths() => - ["prerequisite_markdown", "requirement_markdown", "summary_markdown"]; -} diff --git a/Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/Processors/Types/LanguageProcessor.cs b/Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/Processors/Types/LanguageProcessor.cs deleted file mode 100644 index 206746f..0000000 --- a/Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/Processors/Types/LanguageProcessor.cs +++ /dev/null @@ -1,17 +0,0 @@ -using Pf2eModel.Model.Enum; -using Pf2eModel.Model.Structure; - -namespace Pf2eDataScrapper.Importers.Implementations.Aonprd.DataBuilder.Processors.Types; - -[AonprdProcessor("language")] -internal class LanguageProcessor(AonprdProcessorInput input) : AbstractEntityProcessor(input) -{ - /// - public override EntityType Type => EntityType.Language; - - /// - public override Language Object { get; } = new(); - - /// - public override void Add() => Context.Languages.Add(Object); -} diff --git a/Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/Processors/Types/TraitProcessor.cs b/Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/Processors/Types/TraitProcessor.cs deleted file mode 100644 index a2d729f..0000000 --- a/Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/Processors/Types/TraitProcessor.cs +++ /dev/null @@ -1,37 +0,0 @@ -using Pf2eModel.Model.Enum; -using Pf2eModel.Model.Structure; - -namespace Pf2eDataScrapper.Importers.Implementations.Aonprd.DataBuilder.Processors.Types; - -[AonprdProcessor("trait", ["external"], false)] -internal class TraitProcessor(AonprdProcessorInput input) : AbstractEntityProcessor(input) -{ - /// - public override EntityType Type => EntityType.Trait; - - /// - public override Trait Object { get; } = new(); - - /// - public override void Add() => Context.Traits.Add(Object); - - /// - public override void Process() - { - base.Process(); - - Object.Type = TraitType.Regular; - - Context.Traits.Add(Object); - } - - /// - protected override void AddTraits() - { - // Необходимо пропускать - } - - /// - protected override string GetDescription() => - base.GetDescription() + AddedDescription(["summary_markdown", "search_markdown"]); -} diff --git a/Pf2eDataScrapper/Importers/Implementations/Aonprd/Helpers/AonprdBuilderGlobals.cs b/Pf2eDataScrapper/Importers/Implementations/Aonprd/Helpers/AonprdBuilderGlobals.cs new file mode 100644 index 0000000..32cace0 --- /dev/null +++ b/Pf2eDataScrapper/Importers/Implementations/Aonprd/Helpers/AonprdBuilderGlobals.cs @@ -0,0 +1,102 @@ +using System.Collections.Generic; +using System.IO; +using Newtonsoft.Json; +using Newtonsoft.Json.Linq; +using Pf2eModel.Model.Base.Targets; + +namespace Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers; + +/// +/// Класс-помощник, хранящий необходимые глобальные данные. +/// +internal class AonprdBuilderGlobals +{ + /// + /// Цель внешних ссылок Архивов Нефисов. + /// + public ExternalTarget AonprdTarget { get; set; } = null!; + + /// + /// Словарь идентификаторов источников. + /// + public Dictionary SourceIds { get; } = []; + + /// + /// Словарь идентификаторов признаков. + /// + public Dictionary TraitIds { get; } = []; + + /// + /// Словарей суффиксов для сущностей + /// + public Dictionary SlugSuffixes { get; } = []; + + /// + /// Словарь допольнительных проверок связей. + /// Ключ - устаревшая сущность, значение - обновлённая. + /// + public Dictionary LegacyRemasterExtra { get; } = []; + + /// + /// Словарь сущностей, которые нужно слить с другой/другими. + /// Ключ - пропускаемая сущность. Значение - целевая сущность. + /// + public Dictionary MergeSources { get; } = []; + + /// + /// Словарь сущностей, которые нужно слить с другой/другими. + /// Ключ - пропускаемая сущность. Значение - целевая сущность. + /// + public Dictionary SubclassGroups { get; } = []; + + /// + /// Конструктор класса . + /// + public AonprdBuilderGlobals() + { + using StreamReader fileReader = new("Resources\\ImportAdaptation.json"); + + JObject? json = JObject + .Parse(fileReader.ReadToEnd()) + .SelectToken("Aonprd") + ?.ToObject(); + + if (json is not null) + { + SlugSuffixes = JsonToDictionary(json, "SlugSuffixes"); + LegacyRemasterExtra = JsonToDictionary(json, "LegacyRemasterExtra"); + MergeSources = JsonToDictionary(json, "MergeSources"); + SubclassGroups = JsonToDictionary(json, "SubclassGroups"); + } + } + + /// + /// Получить суффикс для ссылки. + /// + /// Идентификатор Aonprd. + /// Суффикс для ссылки или пустая строка. + public string GetSlugSuffix(string id) + { + return SlugSuffixes.TryGetValue(id, out string? slug) ? $"-{slug}" : string.Empty; + } + + private Dictionary JsonToDictionary(JObject json, string tokenPath) + { + return json.SelectToken(tokenPath)?.ToObject>() ?? []; + } +} + +/* + Проверка уникальности: + +SELECT + E.type, + E.slug, + COUNT(*), + string_agg(E.id::text, ', ' ORDER BY E.id), + string_agg(EE.external_id::text, ', ' ORDER BY E.id) +FROM public.entities AS E +INNER JOIN public.entity_externals AS EE ON EE.entity_id = E.id +GROUP BY E.type, E.slug +HAVING COUNT(*) > 1 AND E.type NOT IN ('rule', 'action') + */ diff --git a/Pf2eDataScrapper/Importers/Implementations/Aonprd/Helpers/AonprdProcessorInputExtension.cs b/Pf2eDataScrapper/Importers/Implementations/Aonprd/Helpers/AonprdProcessorInputExtension.cs new file mode 100644 index 0000000..b3f407e --- /dev/null +++ b/Pf2eDataScrapper/Importers/Implementations/Aonprd/Helpers/AonprdProcessorInputExtension.cs @@ -0,0 +1,197 @@ +using System.Collections.Generic; +using Microsoft.Extensions.DependencyInjection; +using Pf2eDataScrapper.Processors; +using Pf2eModel.Model.Enum; + +namespace Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers; + +internal static class AonprdProcessorInputExtension +{ + /// + /// Обработать строку, содержащую информацию о количестве действий. + /// + /// + /// Входная строка с данными. + /// Структура, хранящая информацию о количетсве действий. + public static ActionStruct ResolveActionString(this ProcessorInput _, string input) + { + ActionStruct result = new(); + + switch (input) + { + case "Single Action": + result.Actions = result.MaxActions = 1; + break; + + case "Two Actions": + result.Actions = result.MaxActions = 2; + break; + + case "Three Actions": + result.Actions = result.MaxActions = 3; + break; + + case "Reaction": + result.IsReaction = true; + break; + + case "Free Action": + result.IsFreeAction = false; + break; + + case "Single Action to Three Actions": + case "Single Action or more Actions": + result.Actions = 1; + result.MaxActions = 3; + break; + + case "Single Action or Two Actions": + case "Single Action to Two Actions": + result.Actions = 1; + result.MaxActions = 2; + break; + + case "Two Actions or Three Actions": + result.Actions = 2; + result.MaxActions = 3; + break; + + case "Two Actions to 2 rounds": + result.Actions = 2; + result.MaxActions = 3; + result.TwoRounds = true; + break; + + case "Reaction or One Action": + result.IsReaction = true; + result.Actions = result.MaxActions = 1; + break; + + case "Reaction or Two Actions": + result.IsReaction = true; + result.Actions = result.MaxActions = 2; + break; + + case "Free Action or One Action": + result.IsFreeAction = false; + result.Actions = result.MaxActions = 1; + break; + + default: + result.IsPassive = true; + break; + } + + return result; + } + + /// + /// Класс структуры, хранящей информацию о количетсве действий. + /// + public class ActionStruct + { + /// + /// Количество действий + /// + public int Actions { get; set; } + + /// + /// Максимальное количество действий + /// + public int MaxActions { get; set; } + + /// + /// Флаг, указывающий, что действия не требуются. + /// + public bool IsPassive { get; set; } + + /// + /// Флаг, указывающий, что действие может быть использовано как реакция. + /// + public bool IsReaction { get; set; } + + /// + /// Флаг, указывающий, что можно использовать свободное действие. + /// + public bool IsFreeAction { get; set; } + + /// + /// Флаг, указывающий, что действие может быть продлено до 2 раундов. + /// + public bool TwoRounds { get; set; } + } + + public class SourceCategorySolver : EnumSolver + { + public override Dictionary Data { get; } = + new() + { + { "Rulebooks", SourceCategory.Rulebooks }, + { "Adventure Paths", SourceCategory.AdventurePaths }, + { "Lost Omens", SourceCategory.LostOmens }, + { "Adventures", SourceCategory.Adventures }, + { "Comics", SourceCategory.Comics }, + { "Blog Posts", SourceCategory.BlogPosts }, + { "Society", SourceCategory.Society }, + }; + } + + public class VisionEnumSolver : EnumSolver + { + public override Dictionary Data { get; } = + new() + { + { "Low-Light VisionEnum", VisionEnum.LowLightVision }, + { "Darkvision", VisionEnum.DarkVision }, + }; + } + + public class AttributeValuesSolver : EnumSolver + { + public override Dictionary Data { get; } = + new() + { + { "Consitution", AttributeValues.Constitution }, + { "Other", AttributeValues.Free }, + { "other", AttributeValues.Free }, + }; + } + + public class ActionEnumSolver : EnumSolver + { + public override Dictionary Data { get; } = + new() + { + { "Single Action", ActionEnum.SingleAction }, + { "Two Actions", ActionEnum.TwoActions }, + { "Three Actions", ActionEnum.ThreeActions }, + { "Reaction", ActionEnum.Reaction }, + { "Free Action", ActionEnum.FreeAction }, + { "Single Action to Three Actions", ActionEnum.SingleActionToThreeActions }, + { "Single Action or more Actions", ActionEnum.SingleActionToThreeActions }, + { "Single Action or Two Actions", ActionEnum.SingleActionToTwoActions }, + { "Single Action to Two Actions", ActionEnum.SingleActionToTwoActions }, + { "Two Actions or Three Actions", ActionEnum.TwoActionsToThreeActions }, + { "Two Actions to 2 rounds", ActionEnum.TwoActionsToTwoRounds }, + { "Reaction or One Action", ActionEnum.ReactionOrOneAction }, + { "Reaction or Two Actions", ActionEnum.ReactionOrTwoAction }, + { "Reaction or Three Actions", ActionEnum.ReactionOrThreeAction }, + { "Free Action or One Action", ActionEnum.FreeActionOrOneAction }, + { "1 Minute", ActionEnum.OneMinute }, + { "1 minute", ActionEnum.OneMinute }, + { "5 minutes", ActionEnum.FiveMinutes }, + { "10 minutes", ActionEnum.TenMinutes }, + { "30 minutes", ActionEnum.ThirtyMinutes }, + { "1 hour", ActionEnum.OneHour }, + { "Nethys Note: No cast time was printed", ActionEnum.Unknown }, + }; + } + + public static void RegisterServices(IServiceCollection serviceCollection) + { + serviceCollection.AddTransient(); + serviceCollection.AddTransient(); + serviceCollection.AddTransient(); + serviceCollection.AddTransient(); + } +} diff --git a/Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/Processors/Types/Rules/RuleToc.cs b/Pf2eDataScrapper/Importers/Implementations/Aonprd/Helpers/RuleToc.cs similarity index 98% rename from Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/Processors/Types/Rules/RuleToc.cs rename to Pf2eDataScrapper/Importers/Implementations/Aonprd/Helpers/RuleToc.cs index 7d59e6c..cfa169a 100644 --- a/Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/Processors/Types/Rules/RuleToc.cs +++ b/Pf2eDataScrapper/Importers/Implementations/Aonprd/Helpers/RuleToc.cs @@ -1,6 +1,10 @@ -using Pf2eModel.Model.Base.Source; +using System; +using System.Collections.Generic; +using System.IO; +using System.Linq; +using Pf2eModel.Model.Base.Source; -namespace Pf2eDataScrapper.Importers.Implementations.Aonprd.DataBuilder.Processors.Types.Rules; +namespace Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers; /// /// Класс коллекции книг, содержащих правила. diff --git a/Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/Helpers/StringHelper.cs b/Pf2eDataScrapper/Importers/Implementations/Aonprd/Helpers/StringHelper.cs similarity index 84% rename from Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/Helpers/StringHelper.cs rename to Pf2eDataScrapper/Importers/Implementations/Aonprd/Helpers/StringHelper.cs index 7682c74..8ee6e66 100644 --- a/Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/Helpers/StringHelper.cs +++ b/Pf2eDataScrapper/Importers/Implementations/Aonprd/Helpers/StringHelper.cs @@ -1,6 +1,8 @@ -using System.Text.RegularExpressions; +using System.Collections.Generic; +using System.Linq; +using System.Text.RegularExpressions; -namespace Pf2eDataScrapper.Importers.Implementations.Aonprd.DataBuilder.Helpers; +namespace Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers; /// /// Класс-помощник, для обработки строкового ввода с Архивов Нефиса. @@ -11,7 +13,7 @@ internal partial class StringHelper /// /// Конструктор класса /// - private StringHelper() { } + public StringHelper() { } /// /// Разбиение строки по нестабильным строковым разделителям (например, ", ", " or " и т.д.). @@ -38,8 +40,9 @@ internal partial class StringHelper { MarkdownLinkSplit result = new(); - Match match = LinkRegex().Match(input); - if (match.Captures.Count > 0) + MatchCollection matches = LinkRegex().Matches(input); + + foreach (Match match in matches) { result.Links.Add( new() @@ -57,21 +60,16 @@ internal partial class StringHelper } /// - /// Извлечение информации о названии источника. + /// Извлечение суффикса из описания источника. /// /// Исходная строка. - /// Название источника. - public string ResolveSource(string input) + /// Суффикс. + public string ResolveSourceSuffix(string input) { Match match = SourceSuffixRegex().Match(input); - return match.Captures.Count > 0 ? match.Captures[0].Value : ""; + return match.Captures.Count > 0 ? match.Groups[1].Value : ""; } - /// - /// Экземпляр класса . - /// - public static StringHelper Instance { get; } = new(); - /// /// Регулярное выражение для извлечения источника из строки с Markdown-ссылкой. /// diff --git a/Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/Processors/AbstractEntityProcessor.cs b/Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/AbstractEntityProcessor.cs similarity index 56% rename from Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/Processors/AbstractEntityProcessor.cs rename to Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/AbstractEntityProcessor.cs index 7876221..342811b 100644 --- a/Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/Processors/AbstractEntityProcessor.cs +++ b/Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/AbstractEntityProcessor.cs @@ -1,8 +1,12 @@ -using System.Security.Cryptography; -using System.Text; -using Microsoft.EntityFrameworkCore; +using System.Collections.Generic; +using System.Linq; using Newtonsoft.Json; using Newtonsoft.Json.Linq; +using Pf2eDataScrapper.Helpers; +using Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers; +using Pf2eDataScrapper.Processors; +using Pf2eDataScrapper.Processors.Attributes; +using Pf2eDataScrapper.Processors.Definitions; using Pf2eModel; using Pf2eModel.Model; using Pf2eModel.Model.Base; @@ -11,19 +15,32 @@ using Pf2eModel.Model.Base.Targets; using Pf2eModel.Model.Common.I18n; using Pf2eModel.Model.Enum; using Pf2eModel.Model.Structure; +using StringHelper = Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.StringHelper; -namespace Pf2eDataScrapper.Importers.Implementations.Aonprd.DataBuilder.Processors; +namespace Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors; /// /// Абстрактный класс-обработчик сущностей, полученных из Архивов Нефиса. /// Класс предназначен для обработки данных с помощью различных обработчиков, -/// для которых указан атрибут . +/// для которых указан атрибут . /// /// Объект обработки вводимого JSON. -/// -internal abstract class AbstractEntityProcessor(AonprdProcessorInput input) - : AbstractProcessor(input) +/// [DI] Помощник обработки строк. +/// [DI] Помощник работы с БД. +/// [DI] Глобальные параметра обработки Архивов Нефиса. +/// +internal abstract class AbstractEntityProcessor( + ProcessorInput input, + StringHelper stringHelper, + DatabaseHelper helper, + AonprdBuilderGlobals globals +) : AbstractInputProcessor(input) { + public Pf2eDbContext Context { get; } = new(); + public StringHelper StringHelper { get; } = stringHelper; + public DatabaseHelper Helper { get; } = helper; + public AonprdBuilderGlobals Globals { get; } = globals; + /// /// Корневая сущность. /// @@ -42,24 +59,17 @@ internal abstract class AbstractEntityProcessor(AonprdProcessorInput input) /// /// Добавление основной сущности в контекст базы данных. /// - public abstract void Add(); + protected abstract void Add(); /// public override void Process() { - if (Input.GetOptional("remaster_id") is not null) - { - LegacyEntityHandler handler = new(this); - LegacyHandlers.Add(handler); - throw new LegacyItemException(handler.LegacyName); - } + Check(); AddEntity(); AddSource(); AddExternal(); AddTraits(); - - ProcessLegacy(); } /// @@ -69,6 +79,17 @@ internal abstract class AbstractEntityProcessor(AonprdProcessorInput input) Context.SaveChanges(); } + /// + /// Проверки необходимости импорта сущности. + /// + public virtual void Check() + { + if (Globals.MergeSources.ContainsKey(Input.GetRequired("id"))) + { + throw new SkipItemException(Input.GetRequired("name"), "помечено на слияние."); + } + } + #region "Генерация описания" /// @@ -103,6 +124,23 @@ internal abstract class AbstractEntityProcessor(AonprdProcessorInput input) protected virtual string GetDescription() => Input.GetRequired("markdown") + AddedDescription(AddedDescriptionPaths()); + /// + /// Генерация JSON-строки из объектов, располагаюхися по путям, указанным в . + /// + /// Коллекция путей, из которых необходимо достатить объекты. + /// JSON-строка. + protected string GenerateJsonString(params ICollection paths) + { + Dictionary data = []; + + foreach (string key in paths) + { + data.Add(key, Input.Input.SelectToken(key)); + } + + return JsonConvert.SerializeObject(data, new JsonSerializerSettings()); + } + #endregion #region "Генерация сущности" @@ -112,13 +150,19 @@ internal abstract class AbstractEntityProcessor(AonprdProcessorInput input) /// protected virtual void AddEntity() { - Entity.Id = Helper.NextEntityId; + lock (Helper.IdLock) + { + Entity.Id = Helper.NextEntityId; + } + Entity.Type = Type; Entity.Name[LocaleType.English] = Input.GetRequired("name"); Entity.Img = ""; Entity.Description = GetDescription(); Entity.Rarity = Input.EnumOptional("rarity", EntityRarity.Common); - Entity.Slug = Helper.GenerateSlug(Entity.Name[LocaleType.English]); + Entity.Slug = + Helper.GenerateSlug(Entity.Name[LocaleType.English]) + + Globals.GetSlugSuffix(Input.GetRequired("id")); Entity.IsTranslated = false; Entity.IsChecked = false; @@ -133,8 +177,31 @@ internal abstract class AbstractEntityProcessor(AonprdProcessorInput input) /// protected virtual void AddSource() { - foreach (EntitySource entitySource in GetSources()) + string[] sourceNames = Input + .GetRequired("source") + .Select(token => token.ToString()) + .ToArray(); + + if (sourceNames.Length == 0) { + throw new( + $"Источники для сущности \"{Entity.Name[LocaleType.English]}\" " + + $"(Aonprd id \"{Input.GetRequired("id")}\") не найдены." + ); + } + + foreach (string sourceName in sourceNames) + { + EntitySource entitySource = new() + { + Entity = Entity, + SourceId = Globals.SourceIds[sourceName], + Suffix = StringHelper.ResolveSourceSuffix( + Input.GetRequired("source_markdown") + ), + IsRemaster = Input.GetOptional("legacy_id") is not null, + }; + Entity.Sources.Add(entitySource); } } @@ -147,18 +214,19 @@ internal abstract class AbstractEntityProcessor(AonprdProcessorInput input) EntityExternal external = new() { Entity = Entity, - Target = Globals.AonprdTarget, + TargetId = Globals.AonprdTarget.Id, + ExternalId = Input.GetRequired("id"), Suffix = Input.GetRequired("url"), - Md5 = Md5(Input.Input.ToString()), + Md5 = Input.Md5(), }; + Entity.Externals.Add(external); Context.EntityExternals.Add(external); } /// /// Генерация списка признаков сущности. /// - /// protected virtual void AddTraits() { JToken? traitsJson = Input.Input.SelectToken("trait"); @@ -168,25 +236,11 @@ internal abstract class AbstractEntityProcessor(AonprdProcessorInput input) return; } - IEnumerable names = traitsJson.ToArray().Select(jToken => jToken.ToString()); - List traitEntities = Context - .Traits.Select(t => t.Entity) - // ReSharper disable once EntityFramework.UnsupportedServerSideFunctionCall - .Where(e => Pf2eDbContext.LocaleSearchArray(e.Name, names)) - .ToList(); + List names = traitsJson.ToArray().Select(jToken => jToken.ToString()).ToList(); - List traits = Context - .Traits.Include(t => t.Entity) - .Where(t => traitEntities.Contains(t.Entity)) - .ToList(); + List traitIds = names.Select(name => Globals.TraitIds[name]).ToList(); - foreach (string name in names) - { - if (!traits.Any(t => t.Entity.Name.Contains(name))) - { - throw new Exception($"Trait '{name}' is not found!!!"); - } - } + List traits = Context.Traits.Where(t => traitIds.Contains(t.Id)).ToList(); foreach (Trait trait in traits) { @@ -195,132 +249,4 @@ internal abstract class AbstractEntityProcessor(AonprdProcessorInput input) } #endregion - - /// - /// Обработка сущности, отмеченной как устаревшей. - /// - /// Обработка происходит в классе - /// - protected virtual void ProcessLegacy() - { - JArray? legacyIdArray = Input.GetOptional("legacy_id"); - - if (legacyIdArray is null) - { - return; - } - - string[] legacyIds = legacyIdArray.ToArray().Select(t => t.ToString()).ToArray(); - - if (legacyIds.Length == 0) - { - return; - } - - foreach (string legacyId in legacyIds) - { - LegacyEntityHandler? handler = LegacyHandlers.FirstOrDefault(h => - h.LegacyId == legacyId - ); - - if (handler is not null) - { - handler.Apply(Entity); - } - else - { - handler = new(legacyId, Entity); - LegacyHandlers.Add(handler); - } - } - } - - /// - /// Получение списка источников сущности. - /// - /// - public List GetSources() - { - string[] sourceNames = Input - .GetRequired("source") - .Select(token => token.ToString()) - .ToArray(); - - if (sourceNames.Length == 0) - { - throw new( - $"Source for entity with id \"{Entity.Name[LocaleType.English]}\" " - + $"(Aonprd id \"{Input.GetRequired("id")}\") is not found" - ); - } - - List entitySources = []; - - foreach (string sourceName in sourceNames) - { - Source source = - Context.Sources.FirstOrDefault(s => s.Name == sourceName) - ?? throw new($"Source \"{sourceName}\" did not found"); - - EntitySource entitySource = new() - { - Entity = Entity, - Source = source, - Suffix = StringHelper.ResolveSource(Input.GetRequired("source_markdown")), - IsRemaster = Input.GetOptional("legacy_id") is not null, - }; - - entitySources.Add(entitySource); - } - - return entitySources; - } - - /// - /// Генерация JSON-строки из объектов, располагаюхися по путям, указанным в . - /// - /// Коллекция путей, из которых необходимо достатить объекты. - /// JSON-строка. - public string GenerateJsonString(params ICollection paths) - { - Dictionary data = []; - - foreach (string key in paths) - { - data.Add(key, Input.Input.SelectToken(key)); - } - - return JsonConvert.SerializeObject(data, new JsonSerializerSettings()); - } - - /// - /// Создание контрольной суммы объекта. - /// - /// Строковое представление вычисляемого объекта. - /// Использовать шестнадцатеричные цифры в нижнем регистре. - /// Контрольная сумма объекта. - public static string Md5(string input, bool isLowercase = false) - { - using MD5 md5 = MD5.Create(); - byte[] byteHash = md5.ComputeHash(Encoding.UTF8.GetBytes(input)); - string hash = BitConverter.ToString(byteHash).Replace("-", ""); - return isLowercase ? hash.ToLower() : hash; - } - - protected static readonly List LegacyHandlers = []; } - -/// -/// Исключение, показывающее, что обработка сущности пропускается как устаревшая. -/// -/// Название сущности. -public class LegacyItemException(string name) - : Exception($"Item '{name}' is linked with newer version, skipping.") { } - -/// -/// Исключение, показывающее, что обработка сущности пропускается. -/// -/// Название сущности. -/// Причина пропуска. -public class SkipItemException(string name, string reason) - : Exception($"Item '{name}' is skipped, reason: {reason}.") { } diff --git a/Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/Processors/AbstractSubclassProcessor.cs b/Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/AbstractSubclassProcessor.cs similarity index 55% rename from Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/Processors/AbstractSubclassProcessor.cs rename to Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/AbstractSubclassProcessor.cs index df85831..245690c 100644 --- a/Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/Processors/AbstractSubclassProcessor.cs +++ b/Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/AbstractSubclassProcessor.cs @@ -1,20 +1,28 @@ -using Pf2eModel; +using System.Linq; +using Pf2eDataScrapper.Helpers; +using Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers; +using Pf2eDataScrapper.Processors; +using Pf2eDataScrapper.Processors.Attributes; +using Pf2eModel; using Pf2eModel.Model.Base; using Pf2eModel.Model.Common.I18n; using Pf2eModel.Model.Enum; using Pf2eModel.Model.Structure; +using StringHelper = Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.StringHelper; -namespace Pf2eDataScrapper.Importers.Implementations.Aonprd.DataBuilder.Processors; +namespace Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors; /// /// Абстрактный класс-обработчик сущностей подклассов, полученных из Архивов Нефиса. /// Класс предназначен для обработки данных с помощью различных обработчиков, -/// для которых указан атрибут . +/// для которых указан атрибут . /// -/// Объект обработки вводимого JSON. -/// -internal abstract class AbstractSubclassProcessor(AonprdProcessorInput input) - : AbstractEntityProcessor(input) +internal abstract class AbstractSubclassProcessor( + ProcessorInput input, + StringHelper stringHelper, + DatabaseHelper helper, + AonprdBuilderGlobals globals +) : AbstractEntityProcessor(input, stringHelper, helper, globals) { /// public override EntityType Type => EntityType.Subclass; @@ -33,7 +41,7 @@ internal abstract class AbstractSubclassProcessor(AonprdProcessorInput input) public abstract string GroupName { get; } /// - public override void Add() => Context.Subclasses.Add(Object); + protected override void Add() => Context.Subclasses.Add(Object); /// public override void Process() @@ -55,39 +63,8 @@ internal abstract class AbstractSubclassProcessor(AonprdProcessorInput input) /// CLR-представления группы подклассов. public SubclassGroup GetGroup() { - SubclassGroup? group = Context.SubclassGroups.FirstOrDefault(g => + return Context.SubclassGroups.First(g => Pf2eDbContext.LocaleSearch(g.Entity.Name, GroupName) ); - - if (group is not null) - { - return group; - } - - Class? cl = ClassName is not null - ? Context.Classes.FirstOrDefault(c => - Pf2eDbContext.LocaleSearch(c.Entity.Name, GroupName) - ) - : null; - - Entity groupEntity = new() - { - Id = Helper.NextEntityId, - Type = EntityType.SubclassGroup, - Img = "", - Description = "", - Rarity = EntityRarity.Common, - IsTranslated = false, - IsChecked = false, - Name = { [LocaleType.English] = GroupName }, - Slug = Helper.GenerateSlug(GroupName), - }; - - Context.Entities.Add(groupEntity); - - group = new() { Entity = groupEntity, Class = cl }; - Context.SubclassGroups.Add(group); - - return group; } } diff --git a/Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/Finalization/LegacyRemasterProcessors.cs b/Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/Finalization/LegacyRemasterProcessors.cs new file mode 100644 index 0000000..d63ad4e --- /dev/null +++ b/Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/Finalization/LegacyRemasterProcessors.cs @@ -0,0 +1,68 @@ +using System.Collections.Generic; +using System.Linq; +using Microsoft.EntityFrameworkCore; +using Newtonsoft.Json.Linq; +using Pf2eDataScrapper.Processors; +using Pf2eDataScrapper.Processors.Attributes; +using Pf2eDataScrapper.Processors.Definitions; +using Pf2eModel; +using Pf2eModel.Model.Base; +using Pf2eModel.Model.Base.Targets; + +namespace Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Finalization; + +[ProcessorCollection( + "aonprd:legacy-remaster", + InnerType = null, + CompendiumType = ProcessorCompendiumEnum.Aonprd, + Description = "Связь устаревших и обновлённых сущностей", + Group = ProcessorGroupEnum.AonprdFinalization, + Parallel = true +)] +internal class LegacyRemasterProcessors(ProcessorInput input) : AbstractInputProcessor(input) +{ + private Pf2eDbContext Context { get; } = new(); + + public override void Process() + { + string aonprdId = Input.GetRequired("id"); + EntityExternal entity = + Context.EntityExternals.AsNoTracking().FirstOrDefault(x => x.ExternalId == aonprdId) + ?? throw new SilentSkipItemException(); + int entityId = entity.EntityId; + Entity legacyEntity = + Context.Entities.FirstOrDefault(e => e.Id == entityId) + ?? throw new($"Неизвестная сущность с ID {entityId}"); + + foreach (int remasterId in GetEntityIds("remaster_id")) + { + Context.LegacyRemasters.Add(new() { LegacyId = entityId, RemasterId = remasterId }); + Entity remasterEntity = + Context.Entities.AsNoTracking().FirstOrDefault(e => e.Id == remasterId) + ?? throw new($"Неизвестная сущность с ID {remasterId}"); + + if (legacyEntity.Slug == remasterEntity.Slug) + { + legacyEntity.Slug += "-legacy"; + } + } + } + + protected List GetEntityIds(string path) + { + List aonprdIds = (Input.GetOptional(path) ?? []) + .Select(token => token.ToString()) + .ToList(); + + return Context + .EntityExternals.AsNoTracking() + .Where(x => aonprdIds.Contains(x.ExternalId!)) + .Select(x => x.EntityId) + .ToList(); + } + + public override void Save() + { + Context.SaveChanges(); + } +} diff --git a/Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/Finalization/MissingLegacyRemasterProcessorFactory.cs b/Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/Finalization/MissingLegacyRemasterProcessorFactory.cs new file mode 100644 index 0000000..06dbc44 --- /dev/null +++ b/Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/Finalization/MissingLegacyRemasterProcessorFactory.cs @@ -0,0 +1,88 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using Microsoft.EntityFrameworkCore; +using Microsoft.Extensions.DependencyInjection; +using Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers; +using Pf2eDataScrapper.Processors; +using Pf2eDataScrapper.Processors.Attributes; +using Pf2eDataScrapper.Processors.Definitions; +using Pf2eDataScrapper.Processors.Factory; +using Pf2eModel; +using Pf2eModel.Model.Base; +using Pf2eModel.Model.Base.Targets; + +namespace Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Finalization; + +[ProcessorFactory( + "aonprd:fix-legacy-remaster", + ProcessorType = typeof(MissingLegacyRemasterProcessor), + Description = "Дополнение связяй устаревших и обновлённых сущностей", + Group = ProcessorGroupEnum.AonprdFinalization, + Parallel = true +)] +[ProcessorDependencies(["aonprd:legacy-remaster"])] +internal class MissingLegacyRemasterProcessorFactory( + IServiceProvider serviceProvider, + AonprdBuilderGlobals globals +) : AbstractProcessorFactory +{ + public IServiceProvider ServiceProvider { get; } = serviceProvider; + public AonprdBuilderGlobals Globals { get; } = globals; + + public override int Count() => Globals.LegacyRemasterExtra.Count; + + public override IEnumerable> GetEnumerator() + { + foreach ((string key, string value) in Globals.LegacyRemasterExtra) + { + yield return new( + $"{key} -> {value}", + ActivatorUtilities.CreateInstance( + ServiceProvider, + key, + value + ) + ); + } + } +} + +internal class MissingLegacyRemasterProcessor(string legacyId, string remasterId) : IProcessor +{ + public Pf2eDbContext Context { get; } = new(); + public string LegacyId { get; } = legacyId; + public string RemasterId { get; } = remasterId; + + private Entity GetEntity(string aonprdId) + { + EntityExternal entity = + Context.EntityExternals.AsNoTracking().FirstOrDefault(x => x.ExternalId == aonprdId) + ?? throw new SilentSkipItemException(); + + int entityId = entity.EntityId; + + return Context.Entities.FirstOrDefault(e => e.Id == entityId) + ?? throw new($"Неизвестная сущность с ID {entityId}"); + } + + public void Process() + { + Entity legacyEntity = GetEntity(LegacyId); + Entity remasterEntity = GetEntity(RemasterId); + + Context.LegacyRemasters.Add( + new() { LegacyId = legacyEntity.Id, RemasterId = remasterEntity.Id } + ); + + if (legacyEntity.Slug == remasterEntity.Slug) + { + legacyEntity.Slug += "-legacy"; + } + } + + public void Save() + { + Context.SaveChanges(); + } +} diff --git a/Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/Preparation/CompendiumLoadProcessor.cs b/Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/Preparation/CompendiumLoadProcessor.cs new file mode 100644 index 0000000..fefcc86 --- /dev/null +++ b/Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/Preparation/CompendiumLoadProcessor.cs @@ -0,0 +1,55 @@ +using System.IO; +using Newtonsoft.Json.Linq; +using Pf2eDataScrapper.Helpers; +using Pf2eDataScrapper.Importers.Implementations.Aonprd.Compendium; +using Pf2eDataScrapper.Processors.Attributes; +using Pf2eDataScrapper.Processors.Definitions; + +namespace Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Preparation; + +[Processor( + "aonprd:compendium", + Description = "Загрузка компендиума", + Group = ProcessorGroupEnum.AonprdPreparation +)] +[ProcessorDependencies(["aonprd:repository"])] +internal class CompendiumLoadProcessor( + AonprdRepository repository, + AonprdCompendium compendium, + ProcessProgress progress +) : IProcessor +{ + public AonprdRepository Repository { get; } = repository; + public AonprdCompendium Compendium { get; } = compendium; + public ProcessProgress Progress { get; } = progress; + + public void Process() + { + using StreamReader indexFile = new( + Path.Combine(Repository.RepositoryDirPath, "index.json") + ); + JObject indexJson = JObject.Parse(indexFile.ReadToEnd()); + + Progress.Local.Reset(indexJson.Count); + + foreach ((string file, JToken? value) in indexJson) + { + Progress.Local.Start(file); + + JArray items = (JArray)value!; + + foreach (JToken item in items) + { + AonprdCompendiumItem compendiumItem = new(item.ToString(), file); + + Compendium.Items.Add(compendiumItem); + } + + Progress.Local.End(); + } + + Progress.Local.Complete(); + } + + public void Save() { } +} diff --git a/Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/Preparation/ExternalProcessor.cs b/Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/Preparation/ExternalProcessor.cs new file mode 100644 index 0000000..52fe39d --- /dev/null +++ b/Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/Preparation/ExternalProcessor.cs @@ -0,0 +1,39 @@ +using Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers; +using Pf2eDataScrapper.Processors.Attributes; +using Pf2eDataScrapper.Processors.Definitions; +using Pf2eModel; +using Pf2eModel.Model.Base.Targets; + +namespace Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Preparation; + +[Processor( + "aonprd:external", + Description = "Создание цели внешних ссылок", + Group = ProcessorGroupEnum.AonprdPreparation +)] +[ProcessorDependencies(["aonprd:repository"])] +internal class ExternalProcessor(AonprdBuilderGlobals globals) : AbstractSimpleProcessor +{ + public Pf2eDbContext Context { get; } = new(); + public AonprdBuilderGlobals Globals { get; } = globals; + + public ExternalTarget AonprdTarget = null!; + + public override void Process() + { + AonprdTarget = new() + { + Name = AonprdImporter.TargetName, + Icon = "http://www.google.com/s2/favicons?domain=2e.aonprd.com", + Prefix = "https://2e.aonprd.com", + }; + } + + public override void Save() + { + Context.ExternalTargets.Add(AonprdTarget); + Context.SaveChanges(); + + Globals.AonprdTarget = AonprdTarget; + } +} diff --git a/Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/Preparation/RepositoryUpdateProcessor.cs b/Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/Preparation/RepositoryUpdateProcessor.cs new file mode 100644 index 0000000..76f5ef4 --- /dev/null +++ b/Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/Preparation/RepositoryUpdateProcessor.cs @@ -0,0 +1,24 @@ +using Pf2eDataScrapper.Helpers; +using Pf2eDataScrapper.Processors.Attributes; +using Pf2eDataScrapper.Processors.Definitions; + +namespace Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Preparation; + +[Processor( + "aonprd:repository", + Description = "Обновление репозитория", + Group = ProcessorGroupEnum.AonprdPreparation +)] +internal class RepositoryUpdateProcessor(AonprdRepository repository, ProcessProgress progress) + : IProcessor +{ + public AonprdRepository Repository { get; } = repository; + public ProcessProgress Progress { get; } = progress; + + public void Process() + { + Repository.Update(Progress); + } + + public void Save() { } +} diff --git a/Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/Preparation/SchemaBuildProcessor.cs b/Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/Preparation/SchemaBuildProcessor.cs new file mode 100644 index 0000000..3613d04 --- /dev/null +++ b/Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/Preparation/SchemaBuildProcessor.cs @@ -0,0 +1,97 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Linq; +using Pf2eDataScrapper.Helpers; +using Pf2eDataScrapper.Importers.Implementations.Aonprd.Compendium; +using Pf2eDataScrapper.Processors.Attributes; +using Pf2eDataScrapper.SchemaBuilder; + +namespace Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Preparation; + +[Processor( + "aonprd:schema", + Description = "Построение схемы данных", + Group = ProcessorGroupEnum.AonprdPreparation, + Active = false +)] +[ProcessorDependencies(["aonprd:repository"])] +internal class SchemaBuildProcessor( + AonprdImporter importer, + AonprdCompendium compendium, + ProcessProgress progress, + ApplicationSettings settings +) : AbstractSchemaBuildProcessor +{ + /// + protected AonprdImporter Importer { get; } = importer; + + /// + protected override AonprdCompendium Compendium { get; } = compendium; + + /// + protected override ProcessProgress Progress { get; } = progress; + + /// + protected ApplicationSettings Settings { get; } = settings; + + /// + protected override string SavePath => Path.Combine(Settings.OutputDirPath, Importer.Slug); + + /// + protected override AonprdTypeResolver Resolver { get; } = new(); + + /// + /// Список типов, являющихся подклассами. + /// + private readonly string[] _subclassSchemaTypes = + [ + "research-field", + "apparition", + "practice", + "instinct", + "muse", + "cause", + "tenet", + "doctrine", + "druidic-order", + "methodology", + "element", + "hybrid-study", + "mystery", + "conscious-mind", + "subconscious-mind", + "hunters-edge", + "racket", + "bloodline", + "style", + "implement", + "lesson", + "patron", + "arcane-school", + "arcane-thesis", + "way", + "innovation", + "ikon", + "epithet", + ]; + + protected override ICollection GetSchemaNodes(AbstractCompendiumItem item) + { + List nodes = [item.Type]; + + // Нода подкласса + if (_subclassSchemaTypes.Contains(item.Type)) + { + nodes.Add("_subclass"); + } + + return nodes; + } +} + +/// +internal class AonprdTypeResolver : TypeResolver +{ + // +} diff --git a/Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/Preparation/SkillProcessor.cs b/Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/Preparation/SkillProcessor.cs new file mode 100644 index 0000000..8bf81d7 --- /dev/null +++ b/Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/Preparation/SkillProcessor.cs @@ -0,0 +1,41 @@ +using Pf2eDataScrapper.Processors; +using Pf2eDataScrapper.Processors.Attributes; +using Pf2eDataScrapper.Processors.Definitions; +using Pf2eModel; +using Pf2eModel.Model.Common; +using Pf2eModel.Model.Common.I18n; +using Pf2eModel.Model.Enum; + +namespace Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Preparation; + +[ProcessorCollection( + "aonprd:skill", + CompendiumType = ProcessorCompendiumEnum.Aonprd, + InnerType = "skill", + Description = "Навыки", + Group = ProcessorGroupEnum.AonprdPreparation +)] +[ProcessorDependencies(["aonprd:compendium"])] +internal class SkillProcessor(ProcessorInput input, Pf2eDbContext context) + : AbstractInputProcessor(input) +{ + public Pf2eDbContext Context { get; } = context; + + /// + /// Обучаемый объект. + /// + public Training Training = null!; + + /// + public override void Save() => Context.Trainings.Add(Training); + + /// + public override void Process() + { + Training = new() + { + Name = new() { { LocaleType.English, Input.GetRequired("name") } }, + Type = TrainingType.Skill, + }; + } +} diff --git a/Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/Preparation/SourceProcessor.cs b/Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/Preparation/SourceProcessor.cs new file mode 100644 index 0000000..80b99a6 --- /dev/null +++ b/Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/Preparation/SourceProcessor.cs @@ -0,0 +1,50 @@ +using System; +using Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers; +using Pf2eDataScrapper.Processors; +using Pf2eDataScrapper.Processors.Attributes; +using Pf2eDataScrapper.Processors.Definitions; +using Pf2eModel; +using Pf2eModel.Model.Base.Source; +using Pf2eModel.Model.Enum; + +namespace Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Preparation; + +[ProcessorCollection( + "aonprd:source", + InnerType = "source", + CompendiumType = ProcessorCompendiumEnum.Aonprd, + Description = "Источники", + Group = ProcessorGroupEnum.AonprdPreparation +)] +[ProcessorDependencies(["aonprd:compendium"])] +internal class SourceProcessor(ProcessorInput input, AonprdBuilderGlobals globals) + : AbstractInputProcessor(input) +{ + public AonprdBuilderGlobals Globals { get; } = globals; + public Pf2eDbContext Context { get; } = new(); + + /// + /// Источник сущности. + /// + protected Source Source = null!; + + /// + public override void Process() + { + Source = new() + { + Name = Input.GetRequired("name"), + Category = Input.EnumRequired("primary_source_category"), + ReleaseDate = DateOnly.Parse(Input.GetRequired("release_date")), + }; + } + + /// + public override void Save() + { + Context.Sources.Add(Source); + Context.SaveChanges(); + + Globals.SourceIds.Add(Source.Name, Source.Id); + } +} diff --git a/Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/Subclasses/ApparitionProcessor.cs b/Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/Subclasses/ApparitionProcessor.cs new file mode 100644 index 0000000..75ec77a --- /dev/null +++ b/Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/Subclasses/ApparitionProcessor.cs @@ -0,0 +1,134 @@ +using System.Collections.Generic; +using System.Linq; +using System.Text.RegularExpressions; +using Microsoft.EntityFrameworkCore; +using Pf2eDataScrapper.Helpers; +using Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers; +using Pf2eDataScrapper.Processors; +using Pf2eDataScrapper.Processors.Attributes; +using Pf2eDataScrapper.Processors.Collection; +using Pf2eModel; +using Pf2eModel.Model.Base; +using Pf2eModel.Model.Common; +using Pf2eModel.Model.Common.I18n; +using Pf2eModel.Model.Enum; +using Pf2eModel.Model.Structure; +using StringHelper = Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.StringHelper; + +namespace Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Subclasses; + +[ProcessorCollection( + "aonprd:apparition", + InnerType = "apparition", + CompendiumType = ProcessorCompendiumEnum.Aonprd, + Description = "Apparitions", + Group = ProcessorGroupEnum.AonprdSubclasses +)] +[ProcessorDependencies(["aonprd:subclass-group"])] +internal partial class ApparitionProcessor( + ProcessorInput input, + StringHelper stringHelper, + DatabaseHelper helper, + AonprdBuilderGlobals globals +) : AbstractSubclassProcessor(input, stringHelper, helper, globals) +{ + /// + public override Subclass Object { get; } = new(); + + /// + public override string ClassName => "Animist"; + + /// + public override string GroupName => "Apparition"; + + /// + public override void ProcessObject() + { + AddSpells(Input.GetRequired("spell_markdown")); + AddFocal(Entity.Description); + AddTrainings(Input.GetRequired("skill_markdown")); + } + + /// + /// Добавление заклинаний. + /// + /// + public void AddSpells(string spellMd) + { + List spellUrls = StringHelper + .ParseMarkdownLinks(spellMd) + .Links.Select(l => l.Url) + .ToList(); + + List spellIds = Context + .EntityExternals.Where(x => spellUrls.Contains(x.Suffix)) + .Select(x => x.Entity.Id) + .ToList(); + + List spells = Context + .Spells.Where(s => spellIds.Contains(s.Id)) + .Select(s => s.Entity) + .ToList(); + + foreach (Entity spellEntity in spells) + { + Object.Entities.Add(spellEntity); + } + } + + /// + /// Добавление заклинания сосуда. + /// + /// + public void AddFocal(string description) + { + Match match = VesselSpellMarkdownRegex().Match(description); + string aonprdId = $"spell-{match.Groups[1].Value}"; + + var entity = Context + .EntityExternals.Where(x => x.ExternalId == aonprdId) + .Select(x => x.Entity) + .First(); + + Object.Entities.Add(entity); + } + + /// + /// Добавление тренировок. + /// + /// + public void AddTrainings(string trainingMd) + { + List trainingNames = trainingMd.Split(", ").ToList(); + List trainings = Context + .Trainings.Where(t => Pf2eDbContext.LocaleSearchArray(t.Name, trainingNames)) + .ToList(); + + foreach (string name in trainingNames) + { + Training? training = trainings.FirstOrDefault(t => t.Name.Contains(name)); + training ??= new() + { + Name = new() { { LocaleType.English, name } }, + Type = TrainingType.Lore, + }; + + Object.Trainings.Add( + new() + { + Subclass = Object, + Training = training, + Rank = TrainingRank.Trained, + } + ); + } + } + + /// + //protected override string GetDescription() => + // base.GetDescription() + // + AddedDescription(["skill_markdown", "spell_markdown", "summary_markdown"]); + + [GeneratedRegex(@"\*\*Vessel Spell\*\* \[.*?\]\(/Spells\.aspx\?ID=(\d+)\)")] + private static partial Regex VesselSpellMarkdownRegex(); +} diff --git a/Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/Subclasses/SubclassGroupProcessorFactory.cs b/Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/Subclasses/SubclassGroupProcessorFactory.cs new file mode 100644 index 0000000..ee946a6 --- /dev/null +++ b/Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/Subclasses/SubclassGroupProcessorFactory.cs @@ -0,0 +1,111 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; +using Microsoft.Extensions.DependencyInjection; +using Pf2eDataScrapper.Helpers; +using Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers; +using Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Finalization; +using Pf2eDataScrapper.Processors.Attributes; +using Pf2eDataScrapper.Processors.Definitions; +using Pf2eDataScrapper.Processors.Factory; +using Pf2eModel; +using Pf2eModel.Model.Base; +using Pf2eModel.Model.Common.I18n; +using Pf2eModel.Model.Enum; +using Pf2eModel.Model.Structure; + +namespace Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Subclasses; + +[ProcessorFactory( + "aonprd:subclass-group", + ProcessorType = typeof(SubclassGroupProcessor), + Description = "Группы подклассов", + Group = ProcessorGroupEnum.AonprdSubclasses, + Parallel = true +)] +[ProcessorDependencies( + ["aonprd:trait", "aonprd:source", "aonprd:class", "aonprd:spell", "aonprd:skill"] +)] +internal class SubclassGroupProcessorFactory( + IServiceProvider serviceProvider, + AonprdBuilderGlobals globals +) : AbstractProcessorFactory +{ + public IServiceProvider ServiceProvider { get; } = serviceProvider; + public AonprdBuilderGlobals Globals { get; } = globals; + + public override int Count() => Globals.SubclassGroups.Count; + + public override IEnumerable> GetEnumerator() + { + foreach ((string key, string value) in Globals.SubclassGroups) + { + var processor = + value == "_null" + ? ActivatorUtilities.CreateInstance( + ServiceProvider, + key + ) + : ActivatorUtilities.CreateInstance( + ServiceProvider, + key, + value + ); + + yield return new($"{key} -> {value}", processor); + } + } +} + +internal class SubclassGroupProcessor(string groupName, string? className, DatabaseHelper helper) + : IProcessor +{ + public string GroupName { get; } = groupName; + public string? ClassName { get; } = className; + public DatabaseHelper Helper { get; } = helper; + + public SubclassGroupProcessor(string groupName, DatabaseHelper helper) + : this(groupName, null, helper) { } + + public Pf2eDbContext Context { get; } = new(); + + public void Process() + { + Class? cl = ClassName is not null + ? Context.Classes.FirstOrDefault(c => + Pf2eDbContext.LocaleSearch(c.Entity.Name, GroupName) + ) + : null; + + int id; + lock (Helper.IdLock) + { + id = Helper.NextEntityId; + } + + Entity groupEntity = new() + { + Id = id, + Type = EntityType.SubclassGroup, + Img = "", + Description = "", + Rarity = EntityRarity.Common, + IsTranslated = false, + IsChecked = false, + Name = { [LocaleType.English] = GroupName }, + Slug = Helper.GenerateSlug(GroupName), + }; + + Context.Entities.Add(groupEntity); + + SubclassGroup group = new() { Entity = groupEntity, Class = cl }; + Context.SubclassGroups.Add(group); + } + + public void Save() + { + Context.SaveChanges(); + } +} diff --git a/Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/Types/ActionProcessor.cs b/Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/Types/ActionProcessor.cs new file mode 100644 index 0000000..b9a781c --- /dev/null +++ b/Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/Types/ActionProcessor.cs @@ -0,0 +1,67 @@ +using Pf2eDataScrapper.Helpers; +using Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers; +using Pf2eDataScrapper.Processors; +using Pf2eDataScrapper.Processors.Attributes; +using Pf2eDataScrapper.Processors.Collection; +using Pf2eModel.Model.Enum; +using StringHelper = Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.StringHelper; + +namespace Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types; + +[ProcessorCollection( + "aonprd:action", + InnerType = "action", + CompendiumType = ProcessorCompendiumEnum.Aonprd, + Description = "Действия", + Group = ProcessorGroupEnum.AonprdEntities +)] +[ProcessorDependencies(["aonprd:trait", "aonprd:source"])] +internal class ActionProcessor( + ProcessorInput input, + StringHelper stringHelper, + DatabaseHelper helper, + AonprdBuilderGlobals globals +) : AbstractEntityProcessor(input, stringHelper, helper, globals) +{ + /// + public override EntityType Type => EntityType.Action; + + /// + public override Pf2eModel.Model.Structure.Action Object { get; } = new(); + + /// + protected override void Add() => Context.Actions.Add(Object); + + /// + public override void Process() + { + Check(); + + base.Process(); + + Object.Actions = Input.EnumOptional("actions", ActionEnum.Passive); + Object.Extra = GenerateJsonString("school"); + } + + public override void Check() + { + base.Check(); + + if (Input.GetRequired("markdown").StartsWith("**Activate")) + { + throw new SkipItemException(Input.GetRequired("name"), "activating action"); + } + } + + /// + protected override string[] AddedDescriptionPaths() => + [ + "cost_markdown", + "trait_markdown", + "source_markdown", + "search_markdown", + "requirement_markdown", + "trigger_markdown", + "summary_markdown", + ]; +} diff --git a/Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/Processors/Types/AncestryProcessor.cs b/Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/Types/AncestryProcessor.cs similarity index 58% rename from Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/Processors/Types/AncestryProcessor.cs rename to Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/Types/AncestryProcessor.cs index d0f16b0..f7ccee0 100644 --- a/Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/Processors/Types/AncestryProcessor.cs +++ b/Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/Types/AncestryProcessor.cs @@ -1,11 +1,32 @@ -using Newtonsoft.Json.Linq; +using System; +using System.Collections.Generic; +using System.Linq; +using Newtonsoft.Json.Linq; +using Pf2eDataScrapper.Helpers; +using Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers; +using Pf2eDataScrapper.Processors; +using Pf2eDataScrapper.Processors.Attributes; +using Pf2eDataScrapper.Processors.Collection; using Pf2eModel.Model.Enum; using Pf2eModel.Model.Structure; +using StringHelper = Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.StringHelper; -namespace Pf2eDataScrapper.Importers.Implementations.Aonprd.DataBuilder.Processors.Types; +namespace Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types; -[AonprdProcessor("ancestry", ["trait", "source", "language"])] -internal class AncestryProcessor(AonprdProcessorInput input) : AbstractEntityProcessor(input) +[ProcessorCollection( + "aonprd:ancestry", + InnerType = "ancestry", + CompendiumType = ProcessorCompendiumEnum.Aonprd, + Description = "Родословные", + Group = ProcessorGroupEnum.AonprdEntities +)] +[ProcessorDependencies(["aonprd:trait", "aonprd:source", "aonprd:language"])] +internal class AncestryProcessor( + ProcessorInput input, + StringHelper stringHelper, + DatabaseHelper helper, + AonprdBuilderGlobals globals +) : AbstractEntityProcessor(input, stringHelper, helper, globals) { /// public override EntityType Type => EntityType.Ancestry; @@ -14,18 +35,21 @@ internal class AncestryProcessor(AonprdProcessorInput input) : AbstractEntityPro public override Ancestry Object { get; } = new(); /// - public override void Add() => Context.Ancestries.Add(Object); + protected override void Add() => Context.Ancestries.Add(Object); + + public override void Check() + { + base.Check(); + + if (Input.GetRequired("type") != "Ancestry") + { + throw new SkipItemException(Input.GetRequired("name"), "не родословная"); + } + } /// public override void Process() { - string type = Input.GetRequired("type"); - - if (type != "Ancestry") - { - throw new SkipItemException(Input.GetRequired("name"), "not an ancestry"); - } - base.Process(); Object.Size = Input diff --git a/Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/Types/ArchetypeProcessor.cs b/Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/Types/ArchetypeProcessor.cs new file mode 100644 index 0000000..d299727 --- /dev/null +++ b/Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/Types/ArchetypeProcessor.cs @@ -0,0 +1,47 @@ +using Pf2eDataScrapper.Helpers; +using Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers; +using Pf2eDataScrapper.Processors; +using Pf2eDataScrapper.Processors.Attributes; +using Pf2eDataScrapper.Processors.Collection; +using Pf2eModel.Model.Enum; +using Pf2eModel.Model.Structure; +using StringHelper = Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.StringHelper; + +namespace Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types; + +[ProcessorCollection( + "aonprd:archetype", + InnerType = "archetype", + CompendiumType = ProcessorCompendiumEnum.Aonprd, + Description = "Архетипы", + Group = ProcessorGroupEnum.AonprdEntities +)] +[ProcessorDependencies(["aonprd:trait", "aonprd:source"])] +internal class ArchetypeProcessor( + ProcessorInput input, + StringHelper stringHelper, + DatabaseHelper helper, + AonprdBuilderGlobals globals +) : AbstractEntityProcessor(input, stringHelper, helper, globals) +{ + /// + public override EntityType Type => EntityType.Archetype; + + /// + public override Archetype Object { get; } = new(); + + /// + protected override void Add() => Context.Archetypes.Add(Object); + + /// + public override void Process() + { + base.Process(); + + Object.Level = Input.GetOptional("level"); + } + + /// + protected override string[] AddedDescriptionPaths() => + ["prerequisite_markdown", "requirement_markdown", "summary_markdown"]; +} diff --git a/Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/Processors/Types/BackgroundProcessor.cs b/Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/Types/BackgroundProcessor.cs similarity index 50% rename from Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/Processors/Types/BackgroundProcessor.cs rename to Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/Types/BackgroundProcessor.cs index cc1b8e2..ff7b782 100644 --- a/Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/Processors/Types/BackgroundProcessor.cs +++ b/Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/Types/BackgroundProcessor.cs @@ -1,12 +1,30 @@ using Newtonsoft.Json.Linq; +using Pf2eDataScrapper.Helpers; +using Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers; +using Pf2eDataScrapper.Processors; +using Pf2eDataScrapper.Processors.Attributes; +using Pf2eDataScrapper.Processors.Collection; using Pf2eModel.Model.Enum; using Pf2eModel.Model.Structure; using Pf2eModel.Model.Structure.BackgroundRelation; +using StringHelper = Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.StringHelper; -namespace Pf2eDataScrapper.Importers.Implementations.Aonprd.DataBuilder.Processors.Types; +namespace Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types; -[AonprdProcessor("background")] -internal class BackgroundProcessor(AonprdProcessorInput input) : AbstractEntityProcessor(input) +[ProcessorCollection( + "aonprd:background", + InnerType = "background", + CompendiumType = ProcessorCompendiumEnum.Aonprd, + Description = "Предыстории", + Group = ProcessorGroupEnum.AonprdEntities +)] +[ProcessorDependencies(["aonprd:trait", "aonprd:source"])] +internal class BackgroundProcessor( + ProcessorInput input, + StringHelper stringHelper, + DatabaseHelper helper, + AonprdBuilderGlobals globals +) : AbstractEntityProcessor(input, stringHelper, helper, globals) { /// public override EntityType Type => EntityType.Background; @@ -15,7 +33,7 @@ internal class BackgroundProcessor(AonprdProcessorInput input) : AbstractEntityP public override Background Object { get; } = new(); /// - public override void Add() => Context.Backgrounds.Add(Object); + protected override void Add() => Context.Backgrounds.Add(Object); /// public override void Process() diff --git a/Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/Processors/Types/ClassProcessor.cs b/Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/Types/ClassProcessor.cs similarity index 85% rename from Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/Processors/Types/ClassProcessor.cs rename to Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/Types/ClassProcessor.cs index c70d24d..a3db82f 100644 --- a/Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/Processors/Types/ClassProcessor.cs +++ b/Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/Types/ClassProcessor.cs @@ -1,5 +1,13 @@ -using System.Text.RegularExpressions; +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text.RegularExpressions; using Newtonsoft.Json.Linq; +using Pf2eDataScrapper.Helpers; +using Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers; +using Pf2eDataScrapper.Processors; +using Pf2eDataScrapper.Processors.Attributes; +using Pf2eDataScrapper.Processors.Collection; using Pf2eModel; using Pf2eModel.Model.Common; using Pf2eModel.Model.Common.I18n; @@ -7,11 +15,24 @@ using Pf2eModel.Model.Enum; using Pf2eModel.Model.Structure; using Pf2eModel.Model.Structure.ClassRelation; using static System.Text.RegularExpressions.Regex; +using StringHelper = Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.StringHelper; -namespace Pf2eDataScrapper.Importers.Implementations.Aonprd.DataBuilder.Processors.Types; +namespace Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types; -[AonprdProcessor("class", ["trait", "source", "skill"])] -internal partial class ClassProcessor(AonprdProcessorInput input) : AbstractEntityProcessor(input) +[ProcessorCollection( + "aonprd:class", + InnerType = "class", + CompendiumType = ProcessorCompendiumEnum.Aonprd, + Description = "Классы", + Group = ProcessorGroupEnum.AonprdEntities +)] +[ProcessorDependencies(["aonprd:trait", "aonprd:source", "aonprd:skill"])] +internal partial class ClassProcessor( + ProcessorInput input, + StringHelper stringHelper, + DatabaseHelper helper, + AonprdBuilderGlobals globals +) : AbstractEntityProcessor(input, stringHelper, helper, globals) { /// public override EntityType Type => EntityType.Class; @@ -20,7 +41,7 @@ internal partial class ClassProcessor(AonprdProcessorInput input) : AbstractEnti public override Class Object { get; } = new(); /// - public override void Add() => Context.Classes.Add(Object); + protected override void Add() => Context.Classes.Add(Object); /// public override void Process() @@ -36,14 +57,10 @@ internal partial class ClassProcessor(AonprdProcessorInput input) : AbstractEnti foreach (AttributeValues attribute in attributes) { - ClassKeyAbility classKeyAbility = new ClassKeyAbility() - { - Class = Object, - Value = attribute, - }; + ClassKeyAttribute classKeyAttribute = new() { Class = Object, Value = attribute }; - Context.ClassKeyAbilities.Add(classKeyAbility); - Object.ClassKeyAbilities.Add(classKeyAbility); + Context.ClassKeyAbilities.Add(classKeyAttribute); + Object.ClassKeyAbilities.Add(classKeyAttribute); } ClassTraining[] classTrainings = diff --git a/Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/Processors/Types/FeatProcessor.cs b/Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/Types/FeatProcessor.cs similarity index 63% rename from Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/Processors/Types/FeatProcessor.cs rename to Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/Types/FeatProcessor.cs index aa93139..b6589b9 100644 --- a/Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/Processors/Types/FeatProcessor.cs +++ b/Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/Types/FeatProcessor.cs @@ -1,12 +1,30 @@ -using Newtonsoft.Json.Linq; +using System.Linq; +using Newtonsoft.Json.Linq; +using Pf2eDataScrapper.Helpers; +using Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers; +using Pf2eDataScrapper.Processors; +using Pf2eDataScrapper.Processors.Attributes; using Pf2eModel; using Pf2eModel.Model.Enum; using Pf2eModel.Model.Structure; +using StringHelper = Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.StringHelper; -namespace Pf2eDataScrapper.Importers.Implementations.Aonprd.DataBuilder.Processors.Types; +namespace Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types; -[AonprdProcessor("feat", ["trait", "source", "archetype"])] -internal class FeatProcessor(AonprdProcessorInput input) : AbstractEntityProcessor(input) +[ProcessorCollection( + "aonprd:feat", + InnerType = "feat", + CompendiumType = ProcessorCompendiumEnum.Aonprd, + Description = "Черты", + Group = ProcessorGroupEnum.AonprdEntities +)] +[ProcessorDependencies(["aonprd:trait", "aonprd:source", "aonprd:archetype"])] +internal class FeatProcessor( + ProcessorInput input, + StringHelper stringHelper, + DatabaseHelper helper, + AonprdBuilderGlobals globals +) : AbstractEntityProcessor(input, stringHelper, helper, globals) { /// public override EntityType Type => EntityType.Feat; @@ -15,7 +33,7 @@ internal class FeatProcessor(AonprdProcessorInput input) : AbstractEntityProcess public override Feat Object { get; } = new(); /// - public override void Add() => Context.Feats.Add(Object); + protected override void Add() => Context.Feats.Add(Object); /// public override void Process() @@ -28,14 +46,7 @@ internal class FeatProcessor(AonprdProcessorInput input) : AbstractEntityProcess ? FeatCategory.Class : FeatCategory.Uncategorized; - AonprdProcessorInput.ActionStruct action = Input.ResolveActionString( - Input.GetOptional("actions") ?? "" - ); - Object.Actions = action.Actions; - Object.MaxActions = action.MaxActions; - Object.IsFreeAction = action.IsFreeAction; - Object.IsPassive = action.IsPassive; - Object.IsReaction = action.IsReaction; + Object.Actions = Input.EnumOptional("actions", ActionEnum.Unknown); Object.Extra = GenerateJsonString( "archetype", @@ -53,7 +64,7 @@ internal class FeatProcessor(AonprdProcessorInput input) : AbstractEntityProcess Archetype[] archetypes = Context // ReSharper disable once EntityFramework.UnsupportedServerSideFunctionCall .Archetypes.Where(a => Pf2eDbContext.LocaleSearchArray(a.Entity.Name, archetypeStrings)) - // .Where(a => archetypeStrings.Contains(a.Entity.Name.ToString())) + // .Where(a => archetypeStrings.Contains(a.Entity.Group.ToString())) .ToArray(); if (archetypes.Length != 0) diff --git a/Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/Types/HeritageProcessor.cs b/Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/Types/HeritageProcessor.cs new file mode 100644 index 0000000..e826abb --- /dev/null +++ b/Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/Types/HeritageProcessor.cs @@ -0,0 +1,44 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; +using Pf2eDataScrapper.Helpers; +using Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers; +using Pf2eDataScrapper.Processors; +using Pf2eDataScrapper.Processors.Attributes; +using Pf2eModel.Model.Enum; +using Pf2eModel.Model.Structure; + +namespace Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types; + +[ProcessorCollection( + "aonprd:heritage", + InnerType = "heritage", + CompendiumType = ProcessorCompendiumEnum.Aonprd, + Description = "Наследства", + Group = ProcessorGroupEnum.AonprdEntities +)] +[ProcessorDependencies(["aonprd:ancestry"])] +internal class HeritageProcessor( + ProcessorInput input, + StringHelper stringHelper, + DatabaseHelper helper, + AonprdBuilderGlobals globals +) : AbstractEntityProcessor(input, stringHelper, helper, globals) +{ + /// + public override EntityType Type => EntityType.Heritage; + + /// + public override Heritage Object { get; } = new(); + + /// + protected override void Add() => Context.Heritages.Add(Object); + + /// + public override void Process() + { + base.Process(); + } +} diff --git a/Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/Types/LanguageProcessor.cs b/Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/Types/LanguageProcessor.cs new file mode 100644 index 0000000..4b3cb42 --- /dev/null +++ b/Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/Types/LanguageProcessor.cs @@ -0,0 +1,34 @@ +using Pf2eDataScrapper.Helpers; +using Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers; +using Pf2eDataScrapper.Processors; +using Pf2eDataScrapper.Processors.Attributes; +using Pf2eModel.Model.Enum; +using Pf2eModel.Model.Structure; +using StringHelper = Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.StringHelper; + +namespace Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types; + +[ProcessorCollection( + "aonprd:language", + InnerType = "language", + CompendiumType = ProcessorCompendiumEnum.Aonprd, + Description = "Языки", + Group = ProcessorGroupEnum.AonprdEntities +)] +[ProcessorDependencies(["aonprd:trait", "aonprd:source"])] +internal class LanguageProcessor( + ProcessorInput input, + StringHelper stringHelper, + DatabaseHelper helper, + AonprdBuilderGlobals globals +) : AbstractEntityProcessor(input, stringHelper, helper, globals) +{ + /// + public override EntityType Type => EntityType.Language; + + /// + public override Language Object { get; } = new(); + + /// + protected override void Add() => Context.Languages.Add(Object); +} diff --git a/Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/Processors/Types/RitualProcessor.cs b/Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/Types/RitualProcessor.cs similarity index 90% rename from Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/Processors/Types/RitualProcessor.cs rename to Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/Types/RitualProcessor.cs index b4e7430..524dc01 100644 --- a/Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/Processors/Types/RitualProcessor.cs +++ b/Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/Types/RitualProcessor.cs @@ -1,16 +1,35 @@ -using System.Text.RegularExpressions; +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text.RegularExpressions; using Newtonsoft.Json.Linq; -using Pf2eDataScrapper.Importers.Implementations.Aonprd.DataBuilder.Helpers; +using Pf2eDataScrapper.Helpers; +using Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers; +using Pf2eDataScrapper.Processors; +using Pf2eDataScrapper.Processors.Attributes; using Pf2eModel; using Pf2eModel.Model.Common.I18n; using Pf2eModel.Model.Enum; using Pf2eModel.Model.Structure; using Pf2eModel.Model.Structure.RitualRelation; +using StringHelper = Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.StringHelper; -namespace Pf2eDataScrapper.Importers.Implementations.Aonprd.DataBuilder.Processors.Types; +namespace Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types; -[AonprdProcessor("ritual", ["trait", "source", "skill"])] -internal partial class RitualProcessor(AonprdProcessorInput input) : AbstractEntityProcessor(input) +[ProcessorCollection( + "aonprd:ritual", + InnerType = "ritual", + CompendiumType = ProcessorCompendiumEnum.Aonprd, + Description = "Ритуалы", + Group = ProcessorGroupEnum.AonprdEntities +)] +[ProcessorDependencies(["aonprd:trait", "aonprd:source", "aonprd:skill"])] +internal partial class RitualProcessor( + ProcessorInput input, + StringHelper stringHelper, + DatabaseHelper helper, + AonprdBuilderGlobals globals +) : AbstractEntityProcessor(input, stringHelper, helper, globals) { /// public override EntityType Type => EntityType.Ritual; @@ -19,7 +38,7 @@ internal partial class RitualProcessor(AonprdProcessorInput input) : AbstractEnt public override Ritual Object { get; } = new(); /// - public override void Add() => Context.Rituals.Add(Object); + protected override void Add() => Context.Rituals.Add(Object); /// public override void Process() @@ -27,9 +46,9 @@ internal partial class RitualProcessor(AonprdProcessorInput input) : AbstractEnt base.Process(); Object.Level = Input.GetRequired("level"); - Object.Duration = Input.GetOptional("duration", -1); + Object.Duration = Input.GetOptional("duration", -1); - Object.Range = Input.GetOptional("range", -1); + Object.Range = Input.GetOptional("range", -1); Object.RangeString = Input.GetOptionalLocale("range_raw", LocaleType.English); Object.CastTime = CalculateCastTime(Input.GetRequired("actions")); diff --git a/Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/Processors/Types/Rules/RuleProcessor.cs b/Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/Types/Rules/RuleProcessor.cs similarity index 75% rename from Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/Processors/Types/Rules/RuleProcessor.cs rename to Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/Types/Rules/RuleProcessor.cs index 43cbd04..b5fe866 100644 --- a/Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/Processors/Types/Rules/RuleProcessor.cs +++ b/Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/Types/Rules/RuleProcessor.cs @@ -1,14 +1,32 @@ -using Newtonsoft.Json.Linq; +using System.Linq; +using Newtonsoft.Json.Linq; +using Pf2eDataScrapper.Helpers; +using Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers; +using Pf2eDataScrapper.Processors; +using Pf2eDataScrapper.Processors.Attributes; using Pf2eModel.Model.Base.Source; using Pf2eModel.Model.Base.Targets; using Pf2eModel.Model.Common.I18n; using Pf2eModel.Model.Enum; using Rule = Pf2eModel.Model.Structure.Rule; +using StringHelper = Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.StringHelper; -namespace Pf2eDataScrapper.Importers.Implementations.Aonprd.DataBuilder.Processors.Types.Rules; +namespace Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.Rules; -[AonprdProcessor("rules", ["rules-toc"])] -internal class RuleProcessor(AonprdProcessorInput input) : AbstractEntityProcessor(input) +[ProcessorCollection( + "aonprd:rules", + InnerType = "rules", + CompendiumType = ProcessorCompendiumEnum.Aonprd, + Description = "Правила", + Group = ProcessorGroupEnum.AonprdEntities +)] +[ProcessorDependencies(["aonprd:trait", "aonprd:source", "aonprd:rules-toc"])] +internal class RuleProcessor( + ProcessorInput input, + StringHelper stringHelper, + DatabaseHelper helper, + AonprdBuilderGlobals globals +) : AbstractEntityProcessor(input, stringHelper, helper, globals) { /// public override EntityType Type => EntityType.Rule; @@ -17,7 +35,7 @@ internal class RuleProcessor(AonprdProcessorInput input) : AbstractEntityProcess public override Rule Object { get; } = new(); /// - public override void Add() => Context.Rules.Add(Object); + protected override void Add() => Context.Rules.Add(Object); /// /// Структура генерации содержания правил. @@ -33,7 +51,7 @@ internal class RuleProcessor(AonprdProcessorInput input) : AbstractEntityProcess AddExternal(); AddTraits(); - RuleTocBook book = Toc[GetSource().Id]; + RuleTocBook book = Toc[GetSourceId()]; string[] breadcrumbs = (Input.GetOptional("breadcrumbs") ?? []) .Select(token => token.ToString()) @@ -101,11 +119,11 @@ internal class RuleProcessor(AonprdProcessorInput input) : AbstractEntityProcess /// Получение источника, к которому относится правило. /// /// Источник, к которому относится правило. - private Source GetSource() + private int GetSourceId() { foreach (EntitySource entitySource in Entity.Sources) { - return entitySource.Source; + return entitySource.SourceId; } throw new("Source not found"); diff --git a/Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/Processors/Types/Rules/RulesOrderProcessor.cs b/Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/Types/Rules/RulesOrderProcessor.cs similarity index 88% rename from Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/Processors/Types/Rules/RulesOrderProcessor.cs rename to Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/Types/Rules/RulesOrderProcessor.cs index 98c23d3..c5f09ab 100644 --- a/Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/Processors/Types/Rules/RulesOrderProcessor.cs +++ b/Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/Types/Rules/RulesOrderProcessor.cs @@ -5,15 +5,26 @@ // так что ставить порядок ВСЕХ правил в архиве не получится, только тех, что есть в содержании. // Ну а пока просто расставляем родительские и дочерние элементы. -using System.Data; -using Pf2eModel.Model.Structure; +using System.Collections.Generic; +using System.Linq; +using Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers; +using Pf2eDataScrapper.Processors.Attributes; +using Pf2eDataScrapper.Processors.Definitions; +using Pf2eModel; using Rule = Pf2eModel.Model.Structure.Rule; -namespace Pf2eDataScrapper.Importers.Implementations.Aonprd.DataBuilder.Processors.Types.Rules; +namespace Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.Rules; -[AonprdProcessor("rules-order", null, ["rules"], false)] -internal class RulesOrderProcessor(AonprdProcessorInput input) : AbstractProcessor(input) +[Processor( + "aonprd:rules-order", + Description = "Формирование порядка правил", + Group = ProcessorGroupEnum.AonprdEntities +)] +[ProcessorDependencies(["aonprd:rules"])] +internal class RulesOrderProcessor(Pf2eDbContext context) : IProcessor { + public Pf2eDbContext Context { get; } = context; + /// /// Структура генерации содержания правил. /// @@ -25,7 +36,7 @@ internal class RulesOrderProcessor(AonprdProcessorInput input) : AbstractProcess private readonly List _orderItems = []; /// - public override void Process() + public void Process() { Toc.SaveFile(); @@ -147,7 +158,7 @@ internal class RulesOrderProcessor(AonprdProcessorInput input) : AbstractProcess } /// - public override void Save() + public void Save() { Context.SaveChanges(); } diff --git a/Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/Processors/Types/Rules/RulesTocProcessor.cs b/Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/Types/Rules/RulesTocProcessor.cs similarity index 80% rename from Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/Processors/Types/Rules/RulesTocProcessor.cs rename to Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/Types/Rules/RulesTocProcessor.cs index 511d4a4..592cc74 100644 --- a/Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/Processors/Types/Rules/RulesTocProcessor.cs +++ b/Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/Types/Rules/RulesTocProcessor.cs @@ -1,14 +1,27 @@ -using System.Text.RegularExpressions; +using System; +using System.Linq; +using System.Text.RegularExpressions; using System.Web; using AngleSharp; using AngleSharp.Dom; +using Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers; +using Pf2eDataScrapper.Processors.Attributes; +using Pf2eDataScrapper.Processors.Definitions; +using Pf2eModel; using Pf2eModel.Model.Base.Source; -namespace Pf2eDataScrapper.Importers.Implementations.Aonprd.DataBuilder.Processors.Types.Rules; +namespace Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types.Rules; -[AonprdProcessor("rules-toc", null, ["source"], false)] -internal partial class RulesTocProcessor(AonprdProcessorInput input) : AbstractProcessor(input) +[Processor( + "aonprd:rules-toc", + Description = "Загрузка содержания правил", + Group = ProcessorGroupEnum.AonprdEntities +)] +[ProcessorDependencies(["aonprd:source"])] +internal partial class RulesTocProcessor(Pf2eDbContext context) : IProcessor { + public Pf2eDbContext Context { get; } = context; + /// /// Селектор HTML-элемента, в котором находится содержание. /// @@ -25,7 +38,7 @@ internal partial class RulesTocProcessor(AonprdProcessorInput input) : AbstractP public readonly RuleTocCollection Toc = RuleTocCollection.Instance; /// - public override void Process() + public void Process() { IDocument document = DownloadPage(); @@ -104,7 +117,21 @@ internal partial class RulesTocProcessor(AonprdProcessorInput input) : AbstractP { IConfiguration config = Configuration.Default.WithDefaultLoader(); IBrowsingContext context = BrowsingContext.New(config); - IDocument document = context.OpenAsync(Url).Result; + IDocument document = null!; + bool completed = false; + + while (!completed) + { + try + { + document = context.OpenAsync(Url).Result; + completed = true; + } + catch (AggregateException) + { + // + } + } IElement root = document.QuerySelector(Selector) ?? throw new("Broken page download"); @@ -119,7 +146,7 @@ internal partial class RulesTocProcessor(AonprdProcessorInput input) : AbstractP } /// - public override void Save() { } + public void Save() { } /// /// Получить скомпилированное регулярное выражение для получения HTML-ссылки. diff --git a/Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/Types/SkillActionsProcessor.cs b/Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/Types/SkillActionsProcessor.cs new file mode 100644 index 0000000..4c3ff04 --- /dev/null +++ b/Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/Types/SkillActionsProcessor.cs @@ -0,0 +1,60 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; +using Pf2eDataScrapper.Helpers; +using Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers; +using Pf2eDataScrapper.Processors; +using Pf2eDataScrapper.Processors.Attributes; +using Pf2eModel.Model.Enum; + +namespace Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types; + +[ProcessorCollection( + "aonprd:skill-general-action", + InnerType = "skill-general-action", + CompendiumType = ProcessorCompendiumEnum.Aonprd, + Description = "Действия скиллов", + Group = ProcessorGroupEnum.AonprdEntities +)] +[ProcessorDependencies(["aonprd:trait", "aonprd:source"])] +internal class SkillActionsProcessor( + ProcessorInput input, + StringHelper stringHelper, + DatabaseHelper helper, + AonprdBuilderGlobals globals +) : AbstractEntityProcessor(input, stringHelper, helper, globals) +{ + /// + public override EntityType Type => EntityType.Action; + + /// + public override Pf2eModel.Model.Structure.Action Object { get; } = new(); + + /// + protected override void Add() => Context.Actions.Add(Object); + + /// + public override void Process() + { + Check(); + + base.Process(); + + Object.Actions = ActionEnum.Other; + Object.Category = ActionCategory.SkillAction; + } + + /// + protected override string[] AddedDescriptionPaths() => + [ + "cost_markdown", + "trait_markdown", + "source_markdown", + "search_markdown", + "requirement_markdown", + "trigger_markdown", + "summary_markdown", + ]; +} diff --git a/Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/Processors/Types/SpellProcessor.cs b/Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/Types/SpellProcessor.cs similarity index 75% rename from Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/Processors/Types/SpellProcessor.cs rename to Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/Types/SpellProcessor.cs index b1c4b71..4e33470 100644 --- a/Pf2eDataScrapper/Importers/Implementations/Aonprd/DataBuilder/Processors/Types/SpellProcessor.cs +++ b/Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/Types/SpellProcessor.cs @@ -1,13 +1,32 @@ -using Newtonsoft.Json.Linq; +using System.Collections.Generic; +using System.Linq; +using Newtonsoft.Json.Linq; +using Pf2eDataScrapper.Helpers; +using Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers; +using Pf2eDataScrapper.Processors; +using Pf2eDataScrapper.Processors.Attributes; using Pf2eModel.Model.Common.I18n; using Pf2eModel.Model.Enum; using Pf2eModel.Model.Structure; using Pf2eModel.Model.Structure.SpellRelation; +using StringHelper = Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.StringHelper; -namespace Pf2eDataScrapper.Importers.Implementations.Aonprd.DataBuilder.Processors.Types; +namespace Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types; -[AonprdProcessor("spell")] -internal class SpellProcessor(AonprdProcessorInput input) : AbstractEntityProcessor(input) +[ProcessorCollection( + "aonprd:spell", + InnerType = "spell", + CompendiumType = ProcessorCompendiumEnum.Aonprd, + Description = "Заклинания", + Group = ProcessorGroupEnum.AonprdEntities +)] +[ProcessorDependencies(["aonprd:trait", "aonprd:source"])] +internal class SpellProcessor( + ProcessorInput input, + StringHelper stringHelper, + DatabaseHelper helper, + AonprdBuilderGlobals globals +) : AbstractEntityProcessor(input, stringHelper, helper, globals) { /// public override EntityType Type => EntityType.Spell; @@ -16,7 +35,7 @@ internal class SpellProcessor(AonprdProcessorInput input) : AbstractEntityProces public override Spell Object { get; } = new(); /// - public override void Add() => Context.Spells.Add(Object); + protected override void Add() => Context.Spells.Add(Object); /// public override void Process() @@ -26,8 +45,8 @@ internal class SpellProcessor(AonprdProcessorInput input) : AbstractEntityProces Object.Level = Input.GetRequired("level"); Object.Actions = Input.EnumOptional("actions", ActionEnum.Unknown); Object.IsFocus = Input.GetRequired("spell_type") == "Focus"; - Object.Duration = Input.GetOptional("duration", -1); - Object.Range = Input.GetOptional("range", -1); + Object.Duration = Input.GetOptional("duration", -1); + Object.Range = Input.GetOptional("range", -1); Object.Cost = Input.GetOptionalLocale("cost_markdown", LocaleType.English); Object.Trigger = Input.GetOptionalLocale("trigger_markdown", LocaleType.English); @@ -90,6 +109,10 @@ internal class SpellProcessor(AonprdProcessorInput input) : AbstractEntityProces { A(new() { Spell = Object, Type = SpellAreaType.Square }); } + if (areaDetails.Contains("fungi")) + { + areaDetails = [areaDetails[0] + " or " + areaDetails[1]]; + } if (areaTypes.Count != areaDetails.Count) { diff --git a/Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/Types/TraitProcessor.cs b/Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/Types/TraitProcessor.cs new file mode 100644 index 0000000..0d179ff --- /dev/null +++ b/Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/Types/TraitProcessor.cs @@ -0,0 +1,60 @@ +using Pf2eDataScrapper.Helpers; +using Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers; +using Pf2eDataScrapper.Processors; +using Pf2eDataScrapper.Processors.Attributes; +using Pf2eModel.Model.Common.I18n; +using Pf2eModel.Model.Enum; +using Pf2eModel.Model.Structure; +using StringHelper = Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers.StringHelper; + +namespace Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types; + +[ProcessorCollection( + "aonprd:trait", + InnerType = "trait", + CompendiumType = ProcessorCompendiumEnum.Aonprd, + Description = "Признаки", + Group = ProcessorGroupEnum.AonprdEntities +)] +[ProcessorDependencies(["aonprd:external", "aonprd:source"])] +internal class TraitProcessor( + ProcessorInput input, + StringHelper stringHelper, + DatabaseHelper helper, + AonprdBuilderGlobals globals +) : AbstractEntityProcessor(input, stringHelper, helper, globals) +{ + /// + public override EntityType Type => EntityType.Trait; + + /// + public override Trait Object { get; } = new(); + + /// + protected override void Add() + { + Context.Traits.Add(Object); + + Globals.TraitIds[Entity.Name[LocaleType.English]] = Entity.Id; + } + + /// + public override void Process() + { + base.Process(); + + Object.Type = TraitType.Regular; + + Context.Traits.Add(Object); + } + + /// + protected override void AddTraits() + { + // Необходимо пропускать + } + + /// + protected override string GetDescription() => + base.GetDescription() + AddedDescription(["summary_markdown", "search_markdown"]); +} diff --git a/Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/Types/VersitileHeritageProcessor.cs b/Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/Types/VersitileHeritageProcessor.cs new file mode 100644 index 0000000..22b0a96 --- /dev/null +++ b/Pf2eDataScrapper/Importers/Implementations/Aonprd/Processors/Types/VersitileHeritageProcessor.cs @@ -0,0 +1,57 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; +using Pf2eDataScrapper.Helpers; +using Pf2eDataScrapper.Importers.Implementations.Aonprd.Helpers; +using Pf2eDataScrapper.Processors; +using Pf2eDataScrapper.Processors.Attributes; +using Pf2eModel.Model.Enum; +using Pf2eModel.Model.Structure; + +namespace Pf2eDataScrapper.Importers.Implementations.Aonprd.Processors.Types; + +[ProcessorCollection( + "aonprd:versitile-heritage", + InnerType = "ancestry", + CompendiumType = ProcessorCompendiumEnum.Aonprd, + Description = "Универсальные наследства", + Group = ProcessorGroupEnum.AonprdEntities +)] +[ProcessorDependencies(["aonprd:ancestry"])] +internal class VersitileHeritageProcessor( + ProcessorInput input, + StringHelper stringHelper, + DatabaseHelper helper, + AonprdBuilderGlobals globals +) : AbstractEntityProcessor(input, stringHelper, helper, globals) +{ + /// + public override EntityType Type => EntityType.Heritage; + + /// + public override Heritage Object { get; } = new(); + + /// + protected override void Add() => Context.Heritages.Add(Object); + + public override void Check() + { + base.Check(); + + if (Input.GetRequired("type") == "Ancestry") + { + throw new SkipItemException( + Input.GetRequired("name"), + "не универсальное наследие" + ); + } + } + + /// + public override void Process() + { + base.Process(); + } +} diff --git a/Pf2eDataScrapper/Importers/Implementations/Aonprd/SchemaBuilder/AonprdSchemaBuilder.cs b/Pf2eDataScrapper/Importers/Implementations/Aonprd/SchemaBuilder/AonprdSchemaBuilder.cs deleted file mode 100644 index 3551a72..0000000 --- a/Pf2eDataScrapper/Importers/Implementations/Aonprd/SchemaBuilder/AonprdSchemaBuilder.cs +++ /dev/null @@ -1,171 +0,0 @@ -using Konsole; -using Pf2eDataScrapper.Importers.Implementations.Aonprd.Compendium; -using Pf2eDataScrapper.SchemaBuilder; - -namespace Pf2eDataScrapper.Importers.Implementations.Aonprd.SchemaBuilder; - -/// -/// Класс создания схемы данных с сайта Архивов Нефеса. -/// -/// Загузчик данных с сайта Архивов Нефеса. -internal class AonprdSchemaBuilder(AonprdLoader loader) -{ - /// - /// Загузчик данных с сайта Архивов Нефеса. - /// - public readonly AonprdLoader Loader = loader; - - /// - public readonly AonprdCompendium Compendium = loader.Compendium; - - // public readonly AonprdSchemaTypeResolver Resolver = new(); - - /// - /// Дополнительные схемы данных. - /// - public readonly Dictionary Schemas = new() - { - ["_subclass"] = new() { Path = "_subclass" }, - }; - - /// - /// Список типов, являющихся подклассами. - /// - private readonly string[] _subclassSchemaTypes = - [ - "research-field", - "apparition", - "practice", - "instinct", - "muse", - "cause", - "tenet", - "doctrine", - "druidic-order", - "methodology", - "element", - "hybrid-study", - "mystery", - "conscious-mind", - "subconscious-mind", - "hunters-edge", - "racket", - "bloodline", - "style", - "implement", - "lesson", - "patron", - "arcane-school", - "arcane-thesis", - "way", - "innovation", - "ikon", - "epithet", - ]; - - /// - /// Выбор целевого элемента схемы данных для ввода. - /// - /// Входные данные. - /// Целевой элемент схемы данных. - private SchemaNode GetSchema(AonprdLoader.LoaderEntry entry) - { - string key = entry.Type; - - if (Schemas.TryGetValue(key, out SchemaNode? value)) - { - return value; - } - - value = new() - { - // Resolver = Resolver, - Path = key, - }; - Schemas[key] = value; - - return value; - } - - /// - /// Построение схемы данных. - /// - public void BuildSchemas() - { - Console.WriteLine("Building schemas..."); - - ProgressBar bar = new(Loader.ItemCount); - int i = 0; - - foreach (AonprdLoader.LoaderEntry entry in Loader.Entries()) - { - bar.Refresh(i++, entry.Type); - GetSchema(entry).AddValue(entry.Json); - - if (_subclassSchemaTypes.Contains(entry.Type)) - { - Schemas["_subclass"].AddValue(entry.Json); - } - } - - bar.Refresh(Loader.ItemCount, "Done!"); - } - - /// - /// Сохранение постренных схем данных. - /// - /// Целевой каталог. - public void Save(string targetDir) - { - Console.WriteLine("Dumping schemas..."); - - targetDir = Path.Combine(targetDir, Loader.Importer.Slug); - - ProgressBar bar = new(Schemas.Count); - int i = 0; - - foreach (KeyValuePair kvp in Schemas) - { - bar.Refresh(i++, kvp.Key); - SaveSchema(targetDir, kvp.Key, kvp.Value); - } - } - - /// - /// Сохранение отдельной схемы данных. - /// - /// Целевой каталог. - /// Название схемы. - /// Сохраняемая схема. - protected void SaveSchema(string dir, string name, SchemaNode schema) - { - char[] invalids = Path.GetInvalidFileNameChars(); - string fileName = string.Join( - "_", - schema.Path.Split(invalids, StringSplitOptions.RemoveEmptyEntries) - ) - .TrimEnd('.'); - string path = Path.Combine(dir, fileName + ".yaml"); - - string? dirPath = Path.GetDirectoryName(path); - if (dirPath is not null && !Directory.Exists(dirPath)) - { - Directory.CreateDirectory(dirPath); - } - - using StreamWriter writer = new(path); - - schema.Beautify(); - - writer.WriteLine( - SchemaNode.FormatYaml( - new Dictionary() - { - ["name"] = name, - ["values"] = schema.Values.ToString(), - }, - schema.Types[0].GetYamlData() - ) - ); - } -} diff --git a/Pf2eDataScrapper/Importers/Implementations/Pf2eFoundry/Compendium/CompendiumDocumentType.cs b/Pf2eDataScrapper/Importers/Implementations/FoundryEn/Compendium/CompendiumDocumentType.cs similarity index 75% rename from Pf2eDataScrapper/Importers/Implementations/Pf2eFoundry/Compendium/CompendiumDocumentType.cs rename to Pf2eDataScrapper/Importers/Implementations/FoundryEn/Compendium/CompendiumDocumentType.cs index 72928df..3a7acdc 100644 --- a/Pf2eDataScrapper/Importers/Implementations/Pf2eFoundry/Compendium/CompendiumDocumentType.cs +++ b/Pf2eDataScrapper/Importers/Implementations/FoundryEn/Compendium/CompendiumDocumentType.cs @@ -1,4 +1,4 @@ -namespace Pf2eDataScrapper.Importers.Implementations.Pf2eFoundry.Compendium; +namespace Pf2eDataScrapper.Importers.Implementations.FoundryEn.Compendium; /// /// Тип документов компендиума. diff --git a/Pf2eDataScrapper/Importers/Implementations/Pf2eFoundry/Compendium/CompendiumFolder.cs b/Pf2eDataScrapper/Importers/Implementations/FoundryEn/Compendium/CompendiumFolder.cs similarity index 78% rename from Pf2eDataScrapper/Importers/Implementations/Pf2eFoundry/Compendium/CompendiumFolder.cs rename to Pf2eDataScrapper/Importers/Implementations/FoundryEn/Compendium/CompendiumFolder.cs index 07557b5..a7ff17d 100644 --- a/Pf2eDataScrapper/Importers/Implementations/Pf2eFoundry/Compendium/CompendiumFolder.cs +++ b/Pf2eDataScrapper/Importers/Implementations/FoundryEn/Compendium/CompendiumFolder.cs @@ -1,6 +1,7 @@ -using Newtonsoft.Json.Linq; +using System; +using Newtonsoft.Json.Linq; -namespace Pf2eDataScrapper.Importers.Implementations.Pf2eFoundry.Compendium; +namespace Pf2eDataScrapper.Importers.Implementations.FoundryEn.Compendium; /// /// Папка компендиума. @@ -10,32 +11,32 @@ internal class CompendiumFolder /// /// Идентификатор папки. /// - public readonly string Id; + public string Id { get; } /// /// Название папки. /// - public readonly string Name; + public string Name { get; } /// /// Путь к папке. /// - public readonly string? Path; + public string? Path { get; } /// /// Указатель, что папка содержится в других папках. /// - public readonly bool IsContained; - - /// - /// Родительская папка. - /// - public CompendiumFolder? Parent; + public bool IsContained { get; } /// /// Тип документов в папке. /// - public readonly CompendiumDocumentType Type; + public CompendiumDocumentType Type { get; } + + /// + /// Родительская папка. + /// + public CompendiumFolder? Parent { get; set; } = null; /// /// Конструктор папки компендиума из JSON-объекта. @@ -60,8 +61,7 @@ internal class CompendiumFolder IsContained = false; } - Type = (CompendiumDocumentType) - Enum.Parse(typeof(CompendiumDocumentType), json["type"]!.ToString()); + Type = Enum.Parse(json["type"]!.ToString()); } /// @@ -83,6 +83,6 @@ internal class CompendiumFolder /// Строковое представление данных о папки компендиума. public override string ToString() { - return $"CompendiumFolder([Id={Id}][Type={Type}][Name={Name}][Path={Path}][Parent={Parent?.Name ?? "null"}])"; + return $"CompendiumFolder([Id={Id}][Type={Type}][Group={Name}][Path={Path}][Parent={Parent?.Name ?? "null"}])"; } } diff --git a/Pf2eDataScrapper/Importers/Implementations/FoundryEn/Compendium/CompendiumFolderCollection.cs b/Pf2eDataScrapper/Importers/Implementations/FoundryEn/Compendium/CompendiumFolderCollection.cs new file mode 100644 index 0000000..7528df6 --- /dev/null +++ b/Pf2eDataScrapper/Importers/Implementations/FoundryEn/Compendium/CompendiumFolderCollection.cs @@ -0,0 +1,34 @@ +using System.Collections.Generic; +using System.Linq; + +namespace Pf2eDataScrapper.Importers.Implementations.FoundryEn.Compendium; + +/// +/// Коллекция папок компендиума +/// +internal class CompendiumFolderCollection +{ + /// + /// Список загруженных папок. + /// + public List Items { get; } = []; + + /// + /// Добавление информации о папке. + /// + /// Добавляемая папка. + public void Add(CompendiumFolder folder) + { + Items.Add(folder); + } + + /// + /// Получение папки по идентификатору + /// + /// Искомый идентификатор + /// Искомая папка + public CompendiumFolder? GetById(string id) + { + return Items.FirstOrDefault(x => x.Id == id); + } +} diff --git a/Pf2eDataScrapper/Importers/Implementations/FoundryEn/Compendium/FoundryEnCompendium.cs b/Pf2eDataScrapper/Importers/Implementations/FoundryEn/Compendium/FoundryEnCompendium.cs new file mode 100644 index 0000000..b60154c --- /dev/null +++ b/Pf2eDataScrapper/Importers/Implementations/FoundryEn/Compendium/FoundryEnCompendium.cs @@ -0,0 +1,55 @@ +using System; +using System.Collections.Concurrent; +using System.Collections.Generic; +using System.IO; +using System.Linq; +using Newtonsoft.Json.Linq; + +namespace Pf2eDataScrapper.Importers.Implementations.FoundryEn.Compendium; + +/// +/// Загрузчик данных компендиума. +/// +/// Репозиторий данных. +/// [DI] Коллекция папок компендиумов. +internal sealed class FoundryEnCompendium( + FoundryEnRepository repository, + CompendiumFolderCollection folders +) : AbstractCompendium +{ + /// + public override FoundryEnRepository Repository { get; } = repository; + + /// + /// Набор папок компендиума + /// + public CompendiumFolderCollection Folders { get; } = folders; + + /// + /// Коллекция всех записей компендиума. + /// + public ConcurrentBag Items { get; } = []; + + /// + public override int Count(params ICollection types) => + types.Count == 0 ? Items.Count : Items.Count(i => types.Contains(i.Type)); + + /// + public override IEnumerable> Iterate( + params ICollection types + ) + { + foreach ( + FoundryEnCompendiumItem item in types.Count == 0 + ? Items + : Items.Where(i => types.Contains(i.Type)) + ) + { + using StreamReader fileReader = new( + Path.Combine(Repository.RepositoryDirPath, item.File) + ); + + yield return new(item, JObject.Parse(fileReader.ReadToEnd())); + } + } +} diff --git a/Pf2eDataScrapper/Importers/Implementations/FoundryEn/Compendium/FoundryEnCompendiumItem.cs b/Pf2eDataScrapper/Importers/Implementations/FoundryEn/Compendium/FoundryEnCompendiumItem.cs new file mode 100644 index 0000000..0e4fa95 --- /dev/null +++ b/Pf2eDataScrapper/Importers/Implementations/FoundryEn/Compendium/FoundryEnCompendiumItem.cs @@ -0,0 +1,25 @@ +namespace Pf2eDataScrapper.Importers.Implementations.FoundryEn.Compendium; + +/// +/// Ссылка на сущность с указанием файла, в котором она хранится. +/// +/// Идентификатор сущности. +/// Тип сущности. +/// Имя файла, в котором хранится сущность. +internal class FoundryEnCompendiumItem(string id, string type, string file) : AbstractCompendiumItem +{ + /// + /// Идентификатор сущности. + /// + public override string Id { get; } = id; + + /// + /// Тип сущности. + /// + public override string Type { get; } = type; + + /// + /// Имя файла, в котором хранится сущность. + /// + public string File { get; } = file; +} diff --git a/Pf2eDataScrapper/Importers/Implementations/FoundryEn/FoundryEnImporter.cs b/Pf2eDataScrapper/Importers/Implementations/FoundryEn/FoundryEnImporter.cs new file mode 100644 index 0000000..3f91308 --- /dev/null +++ b/Pf2eDataScrapper/Importers/Implementations/FoundryEn/FoundryEnImporter.cs @@ -0,0 +1,48 @@ +using Microsoft.Extensions.DependencyInjection; +using Pf2eDataScrapper.Importers.Implementations.FoundryEn.Compendium; +using Pf2eDataScrapper.Importers.Repositories; + +namespace Pf2eDataScrapper.Importers.Implementations.FoundryEn; + +/// +/// Импортёр для модуля Pf2e FoundryVTT. +/// +internal class FoundryEnImporter : AbstractImporter +{ + /// + /// Название внешней ссылки. + /// + public const string TargetName = "Pf2e FoundryVTT module"; + + /// + /// Отображаемое имя импортёра. + /// + public override string Name => TargetName; + + /// + /// Короткое имя импортёра. + /// + public override string Slug => "foundry-en"; + + #region "Внедрение зависимостей" + + public static void RegisterServices(IServiceCollection services) + { + services.AddSingleton(); + services.AddSingleton(); + services.AddSingleton(); + + services.AddSingleton(); + } + + #endregion +} + +/// +/// Git-репозиторий данных FoundryVTT-модуля "pf2e". +/// +/// +internal class FoundryEnRepository(FoundryEnImporter importer) : GitRepository(importer, GitUrl) +{ + public const string GitUrl = "https://github.com/foundryvtt/pf2e.git"; +} diff --git a/Pf2eDataScrapper/Importers/Implementations/Pf2eFoundry/DataBuilder/Processors/ActionProcessor.cs b/Pf2eDataScrapper/Importers/Implementations/FoundryEn/Processors/Entities/ActionProcessor.cs similarity index 52% rename from Pf2eDataScrapper/Importers/Implementations/Pf2eFoundry/DataBuilder/Processors/ActionProcessor.cs rename to Pf2eDataScrapper/Importers/Implementations/FoundryEn/Processors/Entities/ActionProcessor.cs index b17f9b2..34e192b 100644 --- a/Pf2eDataScrapper/Importers/Implementations/Pf2eFoundry/DataBuilder/Processors/ActionProcessor.cs +++ b/Pf2eDataScrapper/Importers/Implementations/FoundryEn/Processors/Entities/ActionProcessor.cs @@ -1,10 +1,27 @@ using Newtonsoft.Json.Linq; +using Pf2eDataScrapper.Helpers; +using Pf2eDataScrapper.Processors; +using Pf2eDataScrapper.Processors.Attributes; +using Pf2eDataScrapper.Processors.Collection; +using Pf2eModel; using Pf2eModel.Model.Enum; -namespace Pf2eDataScrapper.Importers.Implementations.Pf2eFoundry.DataBuilder.Processors; +namespace Pf2eDataScrapper.Importers.Implementations.FoundryEn.Processors.Entities; -[Pf2eTypeProcessor("Item.action")] -internal class ActionProcessor(ProcessorInput input) : AbstractProcessor(input) +[ProcessorCollection( + "foundry-en:action", + InnerType = "action", + CompendiumType = ProcessorCompendiumEnum.FoundryEn, + Description = "Действия", + Group = ProcessorGroupEnum.FoundryEnEntities, + Active = false +)] +[ProcessorDependencies(["foundry-en:compendium"])] +internal class ActionProcessor( + DatabaseHelper databaseHelper, + Pf2eDbContext context, + ProcessorInput input +) : FoundryEnAbstractProcessor(databaseHelper, context, input) { public override EntityType Type => EntityType.Action; diff --git a/Pf2eDataScrapper/Importers/Implementations/Pf2eFoundry/DataBuilder/Processors/ConditionProcessor.cs b/Pf2eDataScrapper/Importers/Implementations/FoundryEn/Processors/Entities/ConditionProcessor.cs similarity index 52% rename from Pf2eDataScrapper/Importers/Implementations/Pf2eFoundry/DataBuilder/Processors/ConditionProcessor.cs rename to Pf2eDataScrapper/Importers/Implementations/FoundryEn/Processors/Entities/ConditionProcessor.cs index f549256..5cf90a3 100644 --- a/Pf2eDataScrapper/Importers/Implementations/Pf2eFoundry/DataBuilder/Processors/ConditionProcessor.cs +++ b/Pf2eDataScrapper/Importers/Implementations/FoundryEn/Processors/Entities/ConditionProcessor.cs @@ -1,11 +1,28 @@ using Newtonsoft.Json.Linq; +using Pf2eDataScrapper.Helpers; +using Pf2eDataScrapper.Processors; +using Pf2eDataScrapper.Processors.Attributes; +using Pf2eDataScrapper.Processors.Collection; +using Pf2eModel; using Pf2eModel.Model.Enum; using Pf2eModel.Model.Structure; -namespace Pf2eDataScrapper.Importers.Implementations.Pf2eFoundry.DataBuilder.Processors; +namespace Pf2eDataScrapper.Importers.Implementations.FoundryEn.Processors.Entities; -[Pf2eTypeProcessor("Item.condition")] -internal class ConditionProcessor(ProcessorInput input) : AbstractProcessor(input) +[ProcessorCollection( + "foundry-en:condition", + InnerType = "Item.condition", + CompendiumType = ProcessorCompendiumEnum.FoundryEn, + Description = "Состояния", + Group = ProcessorGroupEnum.FoundryEnEntities, + Active = false +)] +[ProcessorDependencies(["foundry-en:compendium"])] +internal class ConditionProcessor( + DatabaseHelper databaseHelper, + Pf2eDbContext context, + ProcessorInput input +) : FoundryEnAbstractProcessor(databaseHelper, context, input) { public override EntityType Type => EntityType.Condition; diff --git a/Pf2eDataScrapper/Importers/Implementations/Pf2eFoundry/DataBuilder/AbstractProcessor.cs b/Pf2eDataScrapper/Importers/Implementations/FoundryEn/Processors/FoundryEnAbstractProcessor.cs similarity index 84% rename from Pf2eDataScrapper/Importers/Implementations/Pf2eFoundry/DataBuilder/AbstractProcessor.cs rename to Pf2eDataScrapper/Importers/Implementations/FoundryEn/Processors/FoundryEnAbstractProcessor.cs index 8ff9468..4459b3b 100644 --- a/Pf2eDataScrapper/Importers/Implementations/Pf2eFoundry/DataBuilder/AbstractProcessor.cs +++ b/Pf2eDataScrapper/Importers/Implementations/FoundryEn/Processors/FoundryEnAbstractProcessor.cs @@ -1,7 +1,13 @@ -using System.Security.Cryptography; +using System; +using System.Collections.Generic; +using System.Linq; +using System.Security.Cryptography; using System.Text; using Microsoft.EntityFrameworkCore; using Newtonsoft.Json.Linq; +using Pf2eDataScrapper.Helpers; +using Pf2eDataScrapper.Processors; +using Pf2eDataScrapper.Processors.Definitions; using Pf2eModel; using Pf2eModel.Model; using Pf2eModel.Model.Base; @@ -11,15 +17,17 @@ using Pf2eModel.Model.Common.I18n; using Pf2eModel.Model.Enum; using Pf2eModel.Model.Structure; -namespace Pf2eDataScrapper.Importers.Implementations.Pf2eFoundry.DataBuilder; +namespace Pf2eDataScrapper.Importers.Implementations.FoundryEn.Processors; -internal abstract class AbstractProcessor(ProcessorInput input) +internal abstract class FoundryEnAbstractProcessor( + DatabaseHelper databaseHelper, + Pf2eDbContext context, + ProcessorInput input +) : AbstractInputProcessor(input) { - protected DatabaseHelper Helper = DatabaseHelper.Instance; + protected DatabaseHelper Helper { get; } = databaseHelper; - public readonly Pf2eDbContext Context = DatabaseHelper.DbContext; - - public readonly ProcessorInput Input = input; + public Pf2eDbContext Context { get; } = context; public Entity Entity { get; set; } = new(); @@ -27,7 +35,7 @@ internal abstract class AbstractProcessor(ProcessorInput input) public abstract IEntity Object { get; } - public virtual void Process() + public override void Process() { Entity.Id = Helper.NextEntityId; Entity.Type = Type; @@ -51,8 +59,8 @@ internal abstract class AbstractProcessor(ProcessorInput input) EntityAlias alias = new() { Type = LocaleType.English, - Alias = Entity.Name, - EntityId = Entity.Id, + Alias = Entity.Group, + LegacyId = Entity.Id, Entity = Entity }; Context.EntityAliases.Add(alias); @@ -93,7 +101,7 @@ internal abstract class AbstractProcessor(ProcessorInput input) } } - public void Save() + public override void Save() { Context.SaveChanges(); } @@ -147,13 +155,13 @@ internal abstract class AbstractProcessor(ProcessorInput input) /* foreach (string name in names) { - if (result.Any(t => t.Entity.Name.Contains(name))) + if (result.Any(t => t.Entity.Group.Contains(name))) { continue; } Trait trait = new() { - Name = name, + Group = name, Slug = name, Type = TraitType.Regular, Description = "", diff --git a/Pf2eDataScrapper/Importers/Implementations/FoundryEn/Processors/Preparation/CompendiumFolderProcessor.cs b/Pf2eDataScrapper/Importers/Implementations/FoundryEn/Processors/Preparation/CompendiumFolderProcessor.cs new file mode 100644 index 0000000..f1f4532 --- /dev/null +++ b/Pf2eDataScrapper/Importers/Implementations/FoundryEn/Processors/Preparation/CompendiumFolderProcessor.cs @@ -0,0 +1,125 @@ +using System.IO; +using Newtonsoft.Json.Linq; +using Pf2eDataScrapper.Importers.Implementations.FoundryEn.Compendium; +using Pf2eDataScrapper.Processors.Attributes; +using Pf2eDataScrapper.Processors.Definitions; + +namespace Pf2eDataScrapper.Importers.Implementations.FoundryEn.Processors.Preparation; + +[Processor( + "foundry-en:compendium-folders", + Description = "Загрузка каталогов компендиума", + Group = ProcessorGroupEnum.FoundryEnPreparation, + Active = false +)] +[ProcessorDependencies(["foundry-en:repository"])] +internal class CompendiumFolderProcessor( + FoundryEnRepository repository, + CompendiumFolderCollection folders +) : IProcessor +{ + private FoundryEnRepository Repository { get; } = repository; + private CompendiumFolderCollection Folders { get; } = folders; + + private string Dir => Repository.RepositoryDirPath; + private int NextFolderId { get; set; } + + public void Process() + { + LoadPacks(); + ScanFolders(); + } + + /// + /// Загрузка основных папок. + /// + private void LoadPacks() + { + using StreamReader systemFile = new(Path.Combine(Dir, "static", "system.json")); + JObject systemData = JObject.Parse(systemFile.ReadToEnd()); + + foreach (JToken pack in systemData["packs"]!) + { + CompendiumFolder folder = new((JObject)pack); + + Folders.Add(folder); + } + + if (systemData.TryGetValue("packFolders", out JToken? packFolders)) + { + ProcessPackFolders((JArray)packFolders, null); + } + } + + /// + /// Обработка папок компендиума в поле `packFolders`. + /// + /// + /// + private void ProcessPackFolders(JArray folders, CompendiumFolder? parent) + { + foreach (JToken token in folders) + { + JObject obj = (JObject)token; + + string id = $"folder-{NextFolderId++}"; + string name = obj["name"]!.ToString(); + + CompendiumFolder folder = new(id, name) { Parent = parent }; + Folders.Add(folder); + + if (obj.TryGetValue("packs", out JToken? packs)) + { + foreach (JToken jToken in packs) + { + string packId = jToken.ToString(); + CompendiumFolder? child = Folders.GetById(packId); + + if (child is not null) + { + child.Parent = folder; + } + } + } + + if (obj.TryGetValue("folders", out JToken? innerFolders)) + { + ProcessPackFolders((JArray)innerFolders, folder); + } + } + } + + private void ScanFolders() + { + // Поиск _folders.json + foreach (CompendiumFolder parent in Folders.Items) + { + if (parent.Path is null) + { + continue; + } + + string dirPath = Path.Combine(Dir, parent.Path); + + foreach ( + string foldersFilePath in Directory.GetFiles( + dirPath, + "_folders.json", + SearchOption.AllDirectories + ) + ) + { + using StreamReader file = new(foldersFilePath); + JArray data = JArray.Parse(file.ReadToEnd()); + + foreach (JToken pack in data) + { + CompendiumFolder folder = new((JObject)pack) { Parent = parent }; + Folders.Add(folder); + } + } + } + } + + public void Save() { } +} diff --git a/Pf2eDataScrapper/Importers/Implementations/FoundryEn/Processors/Preparation/CompendiumItemsProcessor.cs b/Pf2eDataScrapper/Importers/Implementations/FoundryEn/Processors/Preparation/CompendiumItemsProcessor.cs new file mode 100644 index 0000000..79d6eea --- /dev/null +++ b/Pf2eDataScrapper/Importers/Implementations/FoundryEn/Processors/Preparation/CompendiumItemsProcessor.cs @@ -0,0 +1,109 @@ +using System.Collections.Generic; +using System.IO; +using System.Linq; +using Newtonsoft.Json.Linq; +using Pf2eDataScrapper.Helpers; +using Pf2eDataScrapper.Importers.Implementations.FoundryEn.Compendium; +using Pf2eDataScrapper.Processors.Attributes; +using Pf2eDataScrapper.Processors.Definitions; + +namespace Pf2eDataScrapper.Importers.Implementations.FoundryEn.Processors.Preparation; + +[Processor( + "foundry-en:compendium", + Description = "Загрузка компендиума", + Group = ProcessorGroupEnum.FoundryEnPreparation, + Active = false +)] +[ProcessorDependencies(["foundry-en:compendium-folders"])] +internal class CompendiumItemsProcessor( + FoundryEnRepository repository, + FoundryEnCompendium compendium, + ProcessProgress progress +) : IProcessor +{ + private FoundryEnRepository Repository { get; } = repository; + private FoundryEnCompendium Compendium { get; } = compendium; + public ProcessProgress Progress { get; } = progress; + + private string Dir => Repository.RepositoryDirPath; + private List RootFolders { get; } = + compendium.Folders.Items.FindAll(f => f.Path != null); + + public void Process() + { + Progress.Local.Reset(CountItems()); + + foreach (CompendiumFolder folder in RootFolders) + { + string dirPath = Path.Combine(Dir, folder.Path!); + + foreach ( + string filePath in Directory.GetFiles( + dirPath, + "*.json", + SearchOption.AllDirectories + ) + ) + { + string relativePath = Path.GetRelativePath(filePath, Dir); + Progress.Local.Start(relativePath); + + FoundryEnCompendiumItem? item = ProcessFile(relativePath, folder); + + if (item is not null) + { + Compendium.Items.Add(item); + } + + Progress.Local.End(); + } + } + + Progress.Local.Complete(); + } + + private FoundryEnCompendiumItem? ProcessFile(string relativePath, CompendiumFolder folder) + { + FileInfo file = new(Path.Combine(Dir, relativePath)); + + if (file.Name == "_folders.json") + { + return null; + } + + using StreamReader reader = new(file.FullName); + JObject itemJson = JObject.Parse(reader.ReadToEnd()); + + CompendiumFolder? itemFolder = folder; + + JToken? itemJsonFolder = itemJson.SelectToken("folder"); + if (itemJsonFolder is not null) + { + itemFolder = Compendium.Folders.GetById(itemJsonFolder.ToString()); + } + + if (itemFolder is null) + { + throw new( + $"Не удаётся определить папку, к которой относится элемент {file.Name} (путь: {file.FullName})" + ); + } + + string? type = itemJson.SelectToken("type")?.ToString(); + + return new(file.Name, itemFolder.Type + (type is not null ? $".{type}" : ""), relativePath); + } + + private int CountItems() + { + return RootFolders.Sum(folder => + { + string dirPath = Path.Combine(Dir, folder.Path!); + return Directory.GetFiles(dirPath, "*.json", SearchOption.AllDirectories).Length + - Directory.GetFiles(dirPath, "_folders.json", SearchOption.AllDirectories).Length; + }); + } + + public void Save() { } +} diff --git a/Pf2eDataScrapper/Importers/Implementations/FoundryEn/Processors/Preparation/RepositoryUpdateProcessor.cs b/Pf2eDataScrapper/Importers/Implementations/FoundryEn/Processors/Preparation/RepositoryUpdateProcessor.cs new file mode 100644 index 0000000..3af769a --- /dev/null +++ b/Pf2eDataScrapper/Importers/Implementations/FoundryEn/Processors/Preparation/RepositoryUpdateProcessor.cs @@ -0,0 +1,25 @@ +using Pf2eDataScrapper.Helpers; +using Pf2eDataScrapper.Processors.Attributes; +using Pf2eDataScrapper.Processors.Definitions; + +namespace Pf2eDataScrapper.Importers.Implementations.FoundryEn.Processors.Preparation; + +[Processor( + "foundry-en:repository", + Description = "Обновление репозитория", + Group = ProcessorGroupEnum.FoundryEnPreparation, + Active = false +)] +internal class RepositoryUpdateProcessor(FoundryEnRepository repository, ProcessProgress progress) + : IProcessor +{ + public FoundryEnRepository Repository { get; } = repository; + public ProcessProgress Progress { get; } = progress; + + public void Process() + { + Repository.Update(Progress); + } + + public void Save() { } +} diff --git a/Pf2eDataScrapper/Importers/Implementations/FoundryEn/Processors/Preparation/SchemaBuildProcessor.cs b/Pf2eDataScrapper/Importers/Implementations/FoundryEn/Processors/Preparation/SchemaBuildProcessor.cs new file mode 100644 index 0000000..36c5ee8 --- /dev/null +++ b/Pf2eDataScrapper/Importers/Implementations/FoundryEn/Processors/Preparation/SchemaBuildProcessor.cs @@ -0,0 +1,104 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Linq; +using Pf2eDataScrapper.Helpers; +using Pf2eDataScrapper.Importers.Implementations.FoundryEn.Compendium; +using Pf2eDataScrapper.Processors.Attributes; +using Pf2eDataScrapper.SchemaBuilder; + +namespace Pf2eDataScrapper.Importers.Implementations.FoundryEn.Processors.Preparation; + +[Processor( + "foundry-en:schema", + Description = "Построение схемы данных", + Group = ProcessorGroupEnum.FoundryEnPreparation, + Active = false +)] +[ProcessorDependencies(["foundry-en:compendium"])] +internal class SchemaBuildProcessor( + FoundryEnImporter importer, + FoundryEnRepository repository, + FoundryEnCompendium compendium, + ProcessProgress progress, + ApplicationSettings settings +) : AbstractSchemaBuildProcessor +{ + /// + protected FoundryEnImporter Importer { get; } = importer; + + /// + protected FoundryEnRepository Repository { get; } = repository; + + /// + protected override FoundryEnCompendium Compendium { get; } = compendium; + + /// + protected override ProcessProgress Progress { get; } = progress; + + /// + protected ApplicationSettings Settings { get; } = settings; + + /// + protected override string SavePath => Path.Combine(Settings.OutputDirPath, Importer.Slug); + + /// + /// Определитель типов данных. + /// + protected override SchemaTypeResolver Resolver { get; } = new(); + + /// + /// Список типов, являющихся экипировкой. + /// + private readonly string[] _equipmentTypes = + [ + "Item.equipment", + "Item.armor", + "Item.backpack", + "Item.consumable", + "Item.kit", + "Item.shield", + "Item.treasure", + "Item.weapon", + ]; + + /// + /// Выбор целевых элементом схемы данных для типа элемента. + /// + /// Тип входного элемента. + /// Список целевых элементов схемы данных. + private List GetSchemaNodes(string type) + { + List nodes = []; + + // Общая нода + if (!Schemas.TryGetValue(type, out SchemaNode? typeNode)) + { + typeNode = new() { Resolver = Resolver, Path = type }; + Schemas[type] = typeNode; + } + + nodes.Add(typeNode); + + // Нода подкласса + if (_equipmentTypes.Contains(type)) + { + nodes.Add(Schemas["Equipment"]); + } + + return nodes; + } + + protected override ICollection GetSchemaNodes(AbstractCompendiumItem item) + { + List nodes = [item.Type]; + + // Нода подкласса + if (_equipmentTypes.Contains(item.Type)) + { + nodes.Add("Equipment"); + } + + return nodes; + } +} diff --git a/Pf2eDataScrapper/Importers/Implementations/Pf2eFoundry/SchemaBuilder/CompendiumSchemaTypeResolver.cs b/Pf2eDataScrapper/Importers/Implementations/FoundryEn/Processors/Preparation/SchemaTypeResolver.cs similarity index 91% rename from Pf2eDataScrapper/Importers/Implementations/Pf2eFoundry/SchemaBuilder/CompendiumSchemaTypeResolver.cs rename to Pf2eDataScrapper/Importers/Implementations/FoundryEn/Processors/Preparation/SchemaTypeResolver.cs index b77f11b..a469666 100644 --- a/Pf2eDataScrapper/Importers/Implementations/Pf2eFoundry/SchemaBuilder/CompendiumSchemaTypeResolver.cs +++ b/Pf2eDataScrapper/Importers/Implementations/FoundryEn/Processors/Preparation/SchemaTypeResolver.cs @@ -1,10 +1,11 @@ -using Newtonsoft.Json.Linq; +using System.Collections.Generic; +using Newtonsoft.Json.Linq; using Pf2eDataScrapper.SchemaBuilder; using Pf2eDataScrapper.SchemaBuilder.Types; -namespace Pf2eDataScrapper.Importers.Implementations.Pf2eFoundry.SchemaBuilder; +namespace Pf2eDataScrapper.Importers.Implementations.FoundryEn.Processors.Preparation; -internal class CompendiumSchemaTypeResolver : TypeResolver +internal class SchemaTypeResolver : TypeResolver { public class FoundryRulesSchemaType(SchemaNode parent) : IgnoreSchemaType(parent) { diff --git a/Pf2eDataScrapper/Importers/Implementations/Pf2eFoundry/Compendium/CompendiumFolderCollection.cs b/Pf2eDataScrapper/Importers/Implementations/Pf2eFoundry/Compendium/CompendiumFolderCollection.cs deleted file mode 100644 index 04c0381..0000000 --- a/Pf2eDataScrapper/Importers/Implementations/Pf2eFoundry/Compendium/CompendiumFolderCollection.cs +++ /dev/null @@ -1,26 +0,0 @@ -namespace Pf2eDataScrapper.Importers.Implementations.Pf2eFoundry.Compendium; - -/// -/// Коллекция папок компендиума -/// -internal class CompendiumFolderCollection : List -{ - /// - /// Получение папки по идентификатору - /// - /// Искомый идентификатор - /// Искомая папка - public CompendiumFolder? GetById(string id) - { - return this.FirstOrDefault(x => x.Id == id); - } - - /// - /// Фильтрация требуемых папок компендиума. - /// - /// - public CompendiumFolderCollection Filter() - { - return [.. this.FindAll(x => x.Type == CompendiumDocumentType.Item)]; - } -} diff --git a/Pf2eDataScrapper/Importers/Implementations/Pf2eFoundry/CompendiumLoader.cs b/Pf2eDataScrapper/Importers/Implementations/Pf2eFoundry/CompendiumLoader.cs deleted file mode 100644 index 7010191..0000000 --- a/Pf2eDataScrapper/Importers/Implementations/Pf2eFoundry/CompendiumLoader.cs +++ /dev/null @@ -1,178 +0,0 @@ -using Newtonsoft.Json.Linq; -using Pf2eDataScrapper.Importers.Implementations.Pf2eFoundry.Compendium; - -namespace Pf2eDataScrapper.Importers.Implementations.Pf2eFoundry; - -/// -/// Загрузчик данных компендиума -/// -/// Импортёр -internal class CompendiumLoader(Pf2EFoundryImporter importer) -{ - /// - /// Импортёр - /// - public readonly Pf2EFoundryImporter Importer = importer; - - /// - /// Набор папок компендиума - /// - public CompendiumFolderCollection Collection = []; - - /// - /// Счётчик папок - /// - private int _folderCount; - - /// - /// Общее количество элементов в компендиуме - /// - public int ItemCount { get; protected set; } - - /// - /// Обработка папок компендиума в поле `packFolders`. - /// - /// - /// - protected void ProcessPackFolders(JArray folders, CompendiumFolder? parent) - { - foreach (JToken token in folders) - { - JObject obj = (JObject)token; - - string id = $"folder-{_folderCount++}"; - string name = obj["name"]!.ToString(); - - CompendiumFolder folder = new(id, name) { Parent = parent }; - Collection.Add(folder); - - if (obj.TryGetValue("packs", out JToken? packs)) - { - foreach (JToken jToken in packs) - { - string packId = jToken.ToString(); - CompendiumFolder? child = Collection.GetById(packId); - - if (child is not null) - { - child.Parent = folder; - } - } - } - - if (obj.TryGetValue("folders", out JToken? innerFolders)) - { - ProcessPackFolders((JArray)innerFolders, folder); - } - } - - Collection = Collection.Filter(); - } - - /// - /// Подготовка набора папок компендиума - /// - public void Prepare() - { - using StreamReader systemFile = new(Path.Combine(Importer.Dir, "static", "system.json")); - JObject systemData = JObject.Parse(systemFile.ReadToEnd()); - - foreach (JToken pack in systemData["packs"]!) - { - CompendiumFolder folder = new((JObject)pack); - - Collection.Add(folder); - } - - if (systemData.TryGetValue("packFolders", out JToken? packFolders)) - { - ProcessPackFolders((JArray)packFolders, null); - } - - // Поиск _folders.json - foreach (CompendiumFolder parent in Collection.ToList()) - { - if (parent.Path is null) - { - continue; - } - - string dirPath = Path.Combine(Importer.Dir, parent.Path); - - ItemCount += Directory.GetFiles(dirPath, "*.json", SearchOption.AllDirectories).Length; - - foreach ( - string foldersFilePath in Directory.GetFiles( - dirPath, - "_folders.json", - SearchOption.AllDirectories - ) - ) - { - ItemCount--; - using StreamReader file = new(foldersFilePath); - JArray data = JArray.Parse(file.ReadToEnd()); - - foreach (JToken pack in data) - { - CompendiumFolder folder = new((JObject)pack) { Parent = parent }; - Collection.Add(folder); - } - } - } - - // foreach (var folder in Collection) - // { - // Console.WriteLine(folder); - // } - - Collection = Collection.Filter(); - - Console.WriteLine($"Total items: {ItemCount}"); - } - - public IEnumerable Enrties() - { - foreach (CompendiumFolder folder in Collection.FindAll(f => f.Path is not null)) - { - string dirPath = Path.Combine(Importer.Dir, folder.Path!); - - foreach ( - string filePath in Directory.GetFiles( - dirPath, - "*.json", - SearchOption.AllDirectories - ) - ) - { - FileInfo file = new(filePath); - - if (file.Name == "_folders.json") - { - continue; - } - - using StreamReader reader = new(file.FullName); - JObject itemJson = JObject.Parse(reader.ReadToEnd()); - - CompendiumFolder? itemFolder = folder; - if (itemJson.TryGetValue("folder", out JToken? itemJsonFolder)) - { - itemFolder = Collection.GetById(itemJsonFolder.ToString()); - } - - yield return new LoaderEnrty(file, itemJson, itemFolder ?? folder); - } - } - } - - public class LoaderEnrty(FileInfo file, JObject itemJson, CompendiumFolder folder) - { - public FileInfo File { get; } = file; - public JObject Json { get; } = itemJson; - public CompendiumFolder Folder { get; } = folder; - public string Type { get; } = - itemJson["type"]?.ToString() - ?? throw new Exception($"Expected to have `type` field in file {file.FullName}"); - } -} diff --git a/Pf2eDataScrapper/Importers/Implementations/Pf2eFoundry/DataBuilder/PF2eFoundryDataBuilder.cs b/Pf2eDataScrapper/Importers/Implementations/Pf2eFoundry/DataBuilder/PF2eFoundryDataBuilder.cs deleted file mode 100644 index 0249020..0000000 --- a/Pf2eDataScrapper/Importers/Implementations/Pf2eFoundry/DataBuilder/PF2eFoundryDataBuilder.cs +++ /dev/null @@ -1,85 +0,0 @@ -using System.Reflection; -using Konsole; -using Newtonsoft.Json.Linq; -using Pf2eDataScrapper.Importers.Implementations.Pf2eFoundry.Compendium; - -namespace Pf2eDataScrapper.Importers.Implementations.Pf2eFoundry.DataBuilder; - -internal class PF2eFoundryDataBuilder -{ - public Pf2eDatabase Database = Pf2eDatabase.Instance; - - /// - /// Загрузчик данных. - /// - public readonly CompendiumLoader Loader; - - /// - /// Коллекция папок компендиума. - /// - public CompendiumFolderCollection Collection => Loader.Collection; - - public Dictionary Processors = []; - - public PF2eFoundryDataBuilder(CompendiumLoader loader) - { - Loader = loader; - PrepareProcessors(); - } - - public void PrepareProcessors() - { - foreach (Type type in Assembly.GetExecutingAssembly().GetTypes()) - { - if (type.GetCustomAttributes(typeof(Pf2eTypeProcessor), true).Length <= 0) - { - continue; - } - Pf2eTypeProcessor? attribute = type.GetCustomAttribute(); - Processors.Add(attribute!.Type, type.GetConstructor([typeof(ProcessorInput)])!); - } - } - - public AbstractProcessor? GetProcessor(string type, JObject input) - { - return Processors.TryGetValue(type, out ConstructorInfo? constructor) - ? (AbstractProcessor)constructor.Invoke([new ProcessorInput(input)]) - : null; - } - - public void TruncateTables() - { - Console.WriteLine("Truncating all old data..."); - - Database.ExecuteCommand("SELECT f_truncate_tables();"); - - Console.WriteLine("Truncation completed!"); - } - - public void Build() - { - Console.WriteLine("Building data..."); - - ProgressBar bar = new(Loader.ItemCount); - int i = 0; - - foreach (CompendiumLoader.LoaderEnrty entry in Loader.Enrties()) - { - bar.Refresh(i++, $"{entry.Folder.Name}/{entry.File.Name}"); - - AbstractProcessor? processor = GetProcessor( - $"{entry.Folder.Type}.{entry.Type}", - entry.Json - ); - if (processor is null) - { - continue; - } - - processor.Process(); - processor.Save(); - } - - bar.Refresh(Loader.ItemCount, "Done!"); - } -} diff --git a/Pf2eDataScrapper/Importers/Implementations/Pf2eFoundry/DataBuilder/Pf2eTypeProcessor.cs b/Pf2eDataScrapper/Importers/Implementations/Pf2eFoundry/DataBuilder/Pf2eTypeProcessor.cs deleted file mode 100644 index 7e5e37a..0000000 --- a/Pf2eDataScrapper/Importers/Implementations/Pf2eFoundry/DataBuilder/Pf2eTypeProcessor.cs +++ /dev/null @@ -1,9 +0,0 @@ -namespace Pf2eDataScrapper.Importers.Implementations.Pf2eFoundry.DataBuilder; - -[AttributeUsage(AttributeTargets.Class)] -internal class Pf2eTypeProcessor(string type, int priority = 0) : Attribute -{ - public readonly string Type = type; - - public readonly int Priority = priority; -} diff --git a/Pf2eDataScrapper/Importers/Implementations/Pf2eFoundry/Pf2eFoundryImporter.cs b/Pf2eDataScrapper/Importers/Implementations/Pf2eFoundry/Pf2eFoundryImporter.cs deleted file mode 100644 index b98dd8b..0000000 --- a/Pf2eDataScrapper/Importers/Implementations/Pf2eFoundry/Pf2eFoundryImporter.cs +++ /dev/null @@ -1,67 +0,0 @@ -using Pf2eDataScrapper.Importers.Implementations.Pf2eFoundry.DataBuilder; -using Pf2eDataScrapper.Importers.Implementations.Pf2eFoundry.SchemaBuilder; -using Pf2eDataScrapper.Importers.Repositories; - -namespace Pf2eDataScrapper.Importers.Implementations.Pf2eFoundry; - -/// -/// Импортёр для модуля Pf2e FoundryVTT. -/// -internal class Pf2EFoundryImporter : AbstractImporter -{ - /// - /// Отображаемое имя импортёра. - /// - public override string Name => "Pf2e FoundryVTT module"; - - /// - /// Короткое имя импортёра. - /// - public override string Slug => "pf2e"; - - public override AbstractImporterRepository Repository => - new GitRepository(this, "https://github.com/foundryvtt/pf2e.git"); - - /// - /// Загрузчик данных компендиума. - /// - public CompendiumLoader Loader { get; } - - /// - /// Конструктор импортёра. - /// - public Pf2EFoundryImporter() - { - Loader = new CompendiumLoader(this); - } - - /// - /// Метод подготовки данных для импорта. - /// - public override void Prepare() - { - Loader.Prepare(); - } - - /// - /// Импорт данных. - /// - public override void Import() - { - PF2eFoundryDataBuilder builder = new(Loader); - - builder.TruncateTables(); - builder.Build(); - } - - /// - /// Построение схем данных - /// - public override void BuildSchemas() - { - CompendiumSchemaBuilder builder = new(Loader); - - builder.BuildSchemas(); - builder.Save(EnvSettings.OutputDir); - } -} diff --git a/Pf2eDataScrapper/Importers/Implementations/Pf2eFoundry/SchemaBuilder/CompendiumSchemaBuilder.cs b/Pf2eDataScrapper/Importers/Implementations/Pf2eFoundry/SchemaBuilder/CompendiumSchemaBuilder.cs deleted file mode 100644 index 01392f8..0000000 --- a/Pf2eDataScrapper/Importers/Implementations/Pf2eFoundry/SchemaBuilder/CompendiumSchemaBuilder.cs +++ /dev/null @@ -1,197 +0,0 @@ -using Konsole; -using Pf2eDataScrapper.Importers.Implementations.Pf2eFoundry.Compendium; -using Pf2eDataScrapper.SchemaBuilder; - -namespace Pf2eDataScrapper.Importers.Implementations.Pf2eFoundry.SchemaBuilder; - -/// -/// Класс построения схемы компендиумов. -/// -/// Загрузчик данных. -internal class CompendiumSchemaBuilder(CompendiumLoader loader) -{ - /// - /// Загрузчик данных. - /// - public CompendiumLoader Loader = loader; - - /// - /// Коллекция папок компендиума. - /// - public CompendiumFolderCollection Collection = loader.Collection; - - /// - /// Объект для определения типов полей в компендиумах PF2E. - /// - public CompendiumSchemaTypeResolver Resolver = new(); - - /// - /// Схемы данных по папкам. - /// - public Dictionary PackSchemas = []; - - /// - /// Схемы данных по типам. - /// - public Dictionary TypeSchemas = []; - - private readonly string[] _equipmentTypes = - [ - "equipment", - "armor", - "backpack", - "consumable", - "kit", - "shield", - "treasure", - "weapon", - ]; - - private SchemaNode GetPackSchema(CompendiumFolder folder) - { - if (!PackSchemas.TryGetValue(folder, out SchemaNode? value)) - { - value = new SchemaNode() { Resolver = Resolver, Path = folder.Name }; - PackSchemas[folder] = value; - } - - return value; - } - - private SchemaNode GetTypeSchema(string key) - { - if (!TypeSchemas.TryGetValue(key, out SchemaNode? value)) - { - value = new SchemaNode() { Resolver = Resolver, Path = key }; - TypeSchemas[key] = value; - } - - return value; - } - - /// - /// Получение набора схем, к которым относится проверяемый объект. - /// - /// Папка компендиума, в которой находится объект. - /// Указанный тип объекта. - /// - protected List GetItemSchemas(CompendiumFolder folder, string? itemType) - { - string key = folder.Type.ToString() + (itemType is not null ? $".{itemType}" : ""); - - return _equipmentTypes.Contains(itemType) - ? [GetPackSchema(folder), GetTypeSchema(key), GetTypeSchema("Equipment")] - : [GetPackSchema(folder), GetTypeSchema(key)]; - } - - /// - /// Построение схем данных. - /// - public void BuildSchemas() - { - Console.WriteLine("Building schemas..."); - - ProgressBar bar = new(Loader.ItemCount); - int i = 0; - - foreach (CompendiumLoader.LoaderEnrty entry in Loader.Enrties()) - { - bar.Refresh(i++, entry.Folder.Name); - - List schemas = GetItemSchemas(entry.Folder, entry.Type); - - foreach (SchemaNode schema in schemas) - { - schema.AddValue(entry.Json); - } - } - - bar.Refresh(Loader.ItemCount, "Done!"); - } - - /// - /// Сохранение данных. - /// - /// Папка для сохранения. - public void Save(string targetDir) - { - Console.WriteLine("Dumping schemas..."); - - ProgressBar bar = new(PackSchemas.Count + TypeSchemas.Count); - int i = 0; - - targetDir = Path.Combine(targetDir, Loader.Importer.Slug); - - if (!Directory.Exists(targetDir)) - { - Directory.CreateDirectory(targetDir); - } - Array.ForEach(Directory.GetFiles(@targetDir), File.Delete); - - // Packs - string packsDir = Path.Combine(targetDir, "packs"); - Directory.CreateDirectory(packsDir); - - foreach (KeyValuePair pair in PackSchemas) - { - bar.Refresh(i++, pair.Key.Name); - SaveSchema(packsDir, pair.Key.Name, pair.Value); - } - - // Types - string typesDir = Path.Combine(targetDir, "types"); - Directory.CreateDirectory(typesDir); - foreach (KeyValuePair pair in TypeSchemas) - { - bar.Refresh(i++, pair.Key); - SaveSchema(typesDir, pair.Key, pair.Value); - } - - Console.WriteLine("Done!"); - } - - /// - /// Сохранение конкретной схемы. - /// - /// Корневая папка для сохранения этой категории схем. - /// Название сохраняемой схемы. - /// Сохраняемая схема. - protected void SaveSchema(string dir, string name, SchemaNode schema) - { - char[] invalids = Path.GetInvalidFileNameChars(); - string fileName = string.Join( - "_", - schema.Path.Split(invalids, StringSplitOptions.RemoveEmptyEntries) - ) - .TrimEnd('.'); - - string path = Path.Combine(dir, fileName + ".yaml"); - - string? dirPath = Path.GetDirectoryName(path); - - if (dirPath is not null && !Directory.Exists(dirPath)) - { - Directory.CreateDirectory(dirPath); - } - - using StreamWriter writer = new(path); - - schema.Beautify(); - - writer.WriteLine( - SchemaNode.FormatYaml( - new Dictionary() - { - ["name"] = name, - ["values"] = schema.Values.ToString(), - }, - schema.Types[0].GetYamlData() - ) - ); - - //writer.WriteLine(name); - //writer.WriteLine($"Different values: {schema.Values}"); - //writer.WriteLine("====================================="); - //writer.Write(schema.ToString()); - } -} diff --git a/Pf2eDataScrapper/Importers/Repositories/AbstractImporterRepository.cs b/Pf2eDataScrapper/Importers/Repositories/AbstractImporterRepository.cs index a3dedef..b05659f 100644 --- a/Pf2eDataScrapper/Importers/Repositories/AbstractImporterRepository.cs +++ b/Pf2eDataScrapper/Importers/Repositories/AbstractImporterRepository.cs @@ -1,4 +1,7 @@ -namespace Pf2eDataScrapper.Importers.Repositories; +using System.IO; +using Pf2eDataScrapper.Helpers; + +namespace Pf2eDataScrapper.Importers.Repositories; /// /// Класс абстрактного репозитория. @@ -22,5 +25,5 @@ internal abstract class AbstractImporterRepository(AbstractImporter importer) /// /// Обновление данных в репозитории. /// - public abstract void Update(); + public abstract void Update(ProcessProgress progress); } diff --git a/Pf2eDataScrapper/Importers/Repositories/GitRepository.cs b/Pf2eDataScrapper/Importers/Repositories/GitRepository.cs index d0974eb..1fa47af 100644 --- a/Pf2eDataScrapper/Importers/Repositories/GitRepository.cs +++ b/Pf2eDataScrapper/Importers/Repositories/GitRepository.cs @@ -1,4 +1,6 @@ using System.Diagnostics; +using System.IO; +using Pf2eDataScrapper.Helpers; namespace Pf2eDataScrapper.Importers.Repositories; @@ -16,11 +18,14 @@ internal class GitRepository(AbstractImporter importer, string url) public string Url { get; } = url; /// - public override void Update() + public override void Update(ProcessProgress progress) { + progress.Local.Reset(1); + if (Directory.Exists(RepositoryDirPath)) { - // git pull + progress.Local.Start("git pull"); + Process process = new() { StartInfo = new() @@ -34,7 +39,8 @@ internal class GitRepository(AbstractImporter importer, string url) } else { - // git clone + progress.Local.Start("git clone"); + Process process = new() { StartInfo = new() @@ -46,5 +52,7 @@ internal class GitRepository(AbstractImporter importer, string url) }; process.Start(); } + + progress.Local.Complete(); } } diff --git a/Pf2eDataScrapper/Pf2eDataScrapper.csproj b/Pf2eDataScrapper/Pf2eDataScrapper.csproj index a61becb..3d53295 100644 --- a/Pf2eDataScrapper/Pf2eDataScrapper.csproj +++ b/Pf2eDataScrapper/Pf2eDataScrapper.csproj @@ -1,19 +1,29 @@  - 13.0 - Exe - net9.0 - enable + WinExe + net9.0-windows7.0 enable + False + disable + True + true + ..\Documentation\$(MSBuildProjectName) + Name + + + + + + - + - - + + runtime; build; native; contentfiles; analyzers; buildtransitive all @@ -29,6 +39,9 @@ Always + + Always + Always diff --git a/Pf2eDataScrapper/Pf2eDatabase.cs b/Pf2eDataScrapper/Pf2eDatabase.cs deleted file mode 100644 index b3197f6..0000000 --- a/Pf2eDataScrapper/Pf2eDatabase.cs +++ /dev/null @@ -1,152 +0,0 @@ -using System.Text.RegularExpressions; -using Npgsql; - -namespace Pf2eDataScrapper; - -/// -/// Main class for database connection and operations. -/// -public partial class Pf2eDatabase -{ - /// - /// Подключение к базе данных. - /// - public readonly NpgsqlConnection Connection; - - /// - /// Имя пользователя для подключения к базе данных. - /// - public readonly string Username; - - /// - /// Название базы данных. - /// - public readonly string DatabaseName; - - private Pf2eDatabase() - { - Username = UsernamePattern().Match(EnvSettings.DatabaseConnection).Groups[1].Value; - DatabaseName = DatabaseNamePattern().Match(EnvSettings.DatabaseConnection).Groups[1].Value; - - Connection = new(EnvSettings.DatabaseConnection); - Connection.Open(); - } - - ~Pf2eDatabase() - { - Connection.Close(); - } - - /// - /// Singleton instance of the database connection manager. - /// - public static Pf2eDatabase Instance { get; } = new(); - - /// - /// Current transaction associated with this database connection. - /// - public NpgsqlTransaction? Transaction { get; private set; } - - /// - /// Begin a new transaction on the database connection. - /// - public void StartTransaction() - { - if (Transaction != null) - { - throw new InvalidOperationException("Transaction already started."); - } - - Transaction = Connection.BeginTransaction(); - } - - /// - /// Commit the current transaction to the database. - /// - public void Commit() - { - if (Transaction == null) - { - throw new InvalidOperationException("No transaction started."); - } - - Transaction.Commit(); - } - - /// - /// Execute a SQL command against the database. - /// - /// The SQL command to execute - public void ExecuteCommand(string sql) - { - NpgsqlCommand command = GetCommand(sql); - - command.ExecuteNonQuery(); - } - - /// - /// Creates a new SQL command for the database connection. - /// - /// The SQL command string - /// A new NpgsqlCommand object - public NpgsqlCommand GetCommand(string sql) - { - return new(sql, Connection); - } - - /* - public void RebuildDatabase() - { - // Закрываем текущее соединение - Connection.Close(); - - // Получение имён - var databaseNamePattern = DatabaseNamePattern(); - var userConnection = databaseNamePattern.Replace(EnvSettings.DatabaseConnection, ";"); - var databaseName = databaseNamePattern.Match(EnvSettings.DatabaseConnection).Groups[1].Value; - var username = UserNamePattern().Match(EnvSettings.DatabaseConnection).Groups[1].Value; - - // Временное подключение к базе данных - NpgsqlConnection tmpConnection = new(userConnection); - tmpConnection.Open(); - - // Удаляем базу данных - NpgsqlCommand dropCommand = new($"DROP DATABASE \"{databaseName}\";", tmpConnection); - dropCommand.ExecuteNonQuery(); - - // Создаём новую базу данных - NpgsqlCommand createCommand = new($@" - CREATE DATABASE {databaseName} - WITH OWNER = {username} - ENCODING = 'UTF8' - CONNECTION LIMIT = -1; - ", tmpConnection); - createCommand.ExecuteNonQuery(); - - string[] permissionCommands = [ - $"GRANT TEMPORARY, CONNECT ON DATABASE {databaseName} TO PUBLIC;", - $"GRANT ALL ON DATABASE {databaseName} TO {username} WITH GRANT OPTION;", - $"GRANT ALL ON DATABASE {databaseName} TO postgres;" - ]; - - foreach (var command in permissionCommands) - { - NpgsqlCommand permissionCommand = new(command, tmpConnection); - permissionCommand.ExecuteNonQuery(); - } - - // Закрываем временное соединение - tmpConnection.Close(); - - // Заново создаём соединение - Connection = new NpgsqlConnection(EnvSettings.DatabaseConnection); - } - - */ - - [GeneratedRegex(@"(?:^|;)Database=(.*?)(?:$|;)")] - private static partial Regex DatabaseNamePattern(); - - [GeneratedRegex(@"(?:^|;)User=(.*?)(?:$|;)")] - private static partial Regex UsernamePattern(); -} diff --git a/Pf2eDataScrapper/Processors/Attributes/AbstractProcessorAttribute.cs b/Pf2eDataScrapper/Processors/Attributes/AbstractProcessorAttribute.cs new file mode 100644 index 0000000..22c7f87 --- /dev/null +++ b/Pf2eDataScrapper/Processors/Attributes/AbstractProcessorAttribute.cs @@ -0,0 +1,35 @@ +using System; + +namespace Pf2eDataScrapper.Processors.Attributes; + +/// +/// Абстрактный аттрибут обработчика. +/// +[AttributeUsage(AttributeTargets.Class)] +internal class AbstractProcessorAttribute(string name) : Attribute +{ + /// + /// Название обработчика. + /// + public string Name { get; } = name; + + /// + /// Описание обработчика. + /// + public string Description { get; init; } = name; + + /// + /// Группа обработчиков, к которому относится обработчик. + /// + public ProcessorGroupEnum Group { get; init; } = ProcessorGroupEnum.General; + + /// + /// Процессор включён по умолчанию. + /// + public bool Active { get; init; } = true; + + /// + /// Разрешить выполнять процессов в параллельном режиме + /// + public bool Parallel { get; init; } = false; +} diff --git a/Pf2eDataScrapper/Processors/Attributes/ProcessorAttribute.cs b/Pf2eDataScrapper/Processors/Attributes/ProcessorAttribute.cs new file mode 100644 index 0000000..213a9bf --- /dev/null +++ b/Pf2eDataScrapper/Processors/Attributes/ProcessorAttribute.cs @@ -0,0 +1,10 @@ +using System; + +namespace Pf2eDataScrapper.Processors.Attributes; + +/// +/// Общий аттрибут обработчика. +/// +/// Название обработчика. +[AttributeUsage(AttributeTargets.Class)] +internal class ProcessorAttribute(string name) : AbstractProcessorAttribute(name) { } diff --git a/Pf2eDataScrapper/Processors/Attributes/ProcessorCollectionAttribute.cs b/Pf2eDataScrapper/Processors/Attributes/ProcessorCollectionAttribute.cs new file mode 100644 index 0000000..a6d47cd --- /dev/null +++ b/Pf2eDataScrapper/Processors/Attributes/ProcessorCollectionAttribute.cs @@ -0,0 +1,22 @@ +using System; + +namespace Pf2eDataScrapper.Processors.Attributes; + +/// +/// Аттрибут обработчика набор элементов. +/// +/// Название обработчика. +[AttributeUsage(AttributeTargets.Class)] +internal class ProcessorCollectionAttribute(string name) : AbstractProcessorAttribute(name) +{ + /// + /// Название типов, который обрабатывает этот оброботчик. + /// null - обработать все типы. + /// + public required string? InnerType { get; init; } + + /// + /// Тип используемого компендиума. + /// + public required ProcessorCompendiumEnum CompendiumType { get; init; } +} diff --git a/Pf2eDataScrapper/Processors/Attributes/ProcessorDependenciesAttribute.cs b/Pf2eDataScrapper/Processors/Attributes/ProcessorDependenciesAttribute.cs new file mode 100644 index 0000000..7f0b620 --- /dev/null +++ b/Pf2eDataScrapper/Processors/Attributes/ProcessorDependenciesAttribute.cs @@ -0,0 +1,17 @@ +using System; +using System.Collections.Generic; + +namespace Pf2eDataScrapper.Processors.Attributes; + +/// +/// Аттрибут зависимостей обработчика. +/// +/// Коллекция названий обработчиков, которые должны быть выполнены до этого оброботчика. +[AttributeUsage(AttributeTargets.Class)] +public class ProcessorDependenciesAttribute(string[] dependencies) : Attribute +{ + /// + /// Коллекция названий обработчиков, которые должны быть выполнены до этого оброботчика. + /// + public ICollection Dependencies { get; } = dependencies; +} diff --git a/Pf2eDataScrapper/Processors/Attributes/ProcessorFactoryAttribute.cs b/Pf2eDataScrapper/Processors/Attributes/ProcessorFactoryAttribute.cs new file mode 100644 index 0000000..fd25403 --- /dev/null +++ b/Pf2eDataScrapper/Processors/Attributes/ProcessorFactoryAttribute.cs @@ -0,0 +1,11 @@ +using System; + +namespace Pf2eDataScrapper.Processors.Attributes; + +internal class ProcessorFactoryAttribute(string name) : AbstractProcessorAttribute(name) +{ + /// + /// Тип обрабатывающего процессора + /// + public required Type ProcessorType { get; init; } +} diff --git a/Pf2eDataScrapper/Processors/Attributes/ProcessorGroupEnum.cs b/Pf2eDataScrapper/Processors/Attributes/ProcessorGroupEnum.cs new file mode 100644 index 0000000..41c56b2 --- /dev/null +++ b/Pf2eDataScrapper/Processors/Attributes/ProcessorGroupEnum.cs @@ -0,0 +1,109 @@ +using System.ComponentModel; +using System.Reflection; + +namespace Pf2eDataScrapper.Processors.Attributes; + +/// +/// Перечисление для групп обработчиков. +/// +public enum ProcessorGroupEnum +{ + /// + /// Общий обработчик. + /// + [Description("Общие процессоры")] + General, + + /// + /// Обработчик для подготовки данных с сайта Archives of Nethys Pathfinder 2e. + /// + [Description("Архивы Нефиса: Подготовка")] + AonprdPreparation, + + /// + /// Обработчик основных сущностей с сайта Archives of Nethys Pathfinder 2e. + /// + [Description("Архивы Нефиса: Основные сущности")] + AonprdEntities, + + /// + /// Обработчик подклассов с сайта Archives of Nethys Pathfinder 2e. + /// + [Description("Архивы Нефиса: Подклассы")] + AonprdSubclasses, + + /// + /// Обработчик для завершения обработки данных с сайта Archives of Nethys Pathfinder 2e. + /// + [Description("Архивы Нефиса: Завершение")] + AonprdFinalization, + + /// + /// Обработчик для подготовки данных из модуля pf2e для FoundryVTT. + /// + [Description("Foundry EN: Подготовка")] + FoundryEnPreparation, + + /// + /// Обработчик основных сущностей из модуля pf2e для FoundryVTT. + /// + [Description("Foundry EN: Основные сущности")] + FoundryEnEntities, +} + +/// +/// Перечисление для типов компендиумов обработчиков. +/// +public enum ProcessorCompendiumEnum +{ + /// + /// Компедиум Архивов Нефиса. + /// + Aonprd, + + /// + /// Компедиум Foundry EN. + /// + FoundryEn, +} + +/// +/// Перечисление для типов фабрик обработчиков. +/// +public enum ProcessorFactoryTypeEnum +{ + /// + /// Простая фабрика одиночного обработчика. + /// + Simple, + + /// + /// Фабрика для создания обработчиков, которые могут обрабатывать типы данных компедиума. + /// + Compendium, + + /// + /// Фабрика для создания обработчиков, которые могут обрабатывать итераторы данных. + /// + Iterator, +} + +/// +/// Расширение для перечисления . +/// +public static class ProcessorGroupEnumExtension +{ + /// + /// Получает описание группы обработчика из атрибута . + /// + /// Перечисление группы обработчика. + /// Строка с описанием группы обработчика. + public static string GetDescription(this ProcessorGroupEnum group) + { + return group + .GetType() + .GetField(group.ToString()) + ?.GetCustomAttribute() + ?.Description ?? group.ToString(); + } +} diff --git a/Pf2eDataScrapper/Processors/Collection/ProcessorCollection.cs b/Pf2eDataScrapper/Processors/Collection/ProcessorCollection.cs new file mode 100644 index 0000000..f174806 --- /dev/null +++ b/Pf2eDataScrapper/Processors/Collection/ProcessorCollection.cs @@ -0,0 +1,296 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Reflection; +using LinqToDB; +using Microsoft.Extensions.DependencyInjection; +using Pf2eDataScrapper.Processors.Attributes; +using Pf2eDataScrapper.Processors.Definitions; +using Pf2eDataScrapper.Processors.Factory; + +namespace Pf2eDataScrapper.Processors.Collection; + +/// +/// Класс с коллекцией обработчиков. +/// +internal class ProcessorCollection +{ + public IServiceProvider ServiceProvider { get; } + + /// + /// Коллекция всех доступных обработчиков. + /// + public ICollection AllItems { get; } = []; + + /// + /// Коллекция обработчиков, которые будут обрабатываться. + /// Для изменения необходимо использовать . + /// + public List Items { get; private set; } = []; + + /// + /// Обеспечение доступа к элементам обработчиков. + /// + /// + /// + public ProcessorRecord this[string name] => AllItems.First(item => item.Name == name); + + /// + /// Конструктор класса . + /// + public ProcessorCollection(IServiceProvider serviceProvider) + { + ServiceProvider = serviceProvider; + Assembly assembly = Assembly.GetExecutingAssembly(); + + foreach (Type type in assembly.GetTypes()) + { + ProcessType(type, type.GetCustomAttribute()); + } + + CheckDependencies(); + FilterProcessors([]); + } + + private void ProcessType(Type type, AbstractProcessorAttribute? attribute) + { + switch (attribute) + { + case null: + break; + + case ProcessorAttribute processorAttribute: + ProcessType(type, processorAttribute); + break; + + case ProcessorCollectionAttribute processorCollectionAttribute: + ProcessType(type, processorCollectionAttribute); + break; + + case ProcessorFactoryAttribute processorFactoryAttribute: + ProcessType(type, processorFactoryAttribute); + break; + + default: + throw new( + $"Неизвестная реализация класса {typeof(AbstractProcessorAttribute)} - {attribute.GetType()}" + ); + } + } + + private void ProcessType(Type type, ProcessorAttribute? attribute) + { + if (attribute is null) + { + return; + } + + if (!type.IsAssignableTo(typeof(IProcessor))) + { + throw new( + $"Процессор {type}, которому установлен аттрибут {attribute.GetType()}, не представляет интерфейс {typeof(IProcessor)}" + ); + } + + ProcessorDependenciesAttribute? dependenciesAttribute = + type.GetCustomAttribute(); + + ProcessorRecord item = new() + { + Name = attribute.Name, + Type = type, + Description = attribute.Description, + Group = attribute.Group, + Dependencies = dependenciesAttribute?.Dependencies ?? [], + Active = attribute.Active, + Parallel = attribute.Parallel, + }; + + item.Factory = ActivatorUtilities.CreateInstance( + ServiceProvider, + item + ); + + AllItems.Add(item); + } + + private void ProcessType(Type type, ProcessorCollectionAttribute? attribute) + { + if (attribute is null) + { + return; + } + + if (!type.IsAssignableTo(typeof(AbstractInputProcessor))) + { + throw new( + $"Процессор {type}, которому установлен аттрибут {attribute.GetType()}, не реализует класс {typeof(AbstractInputProcessor)}." + ); + } + + ProcessorDependenciesAttribute? dependenciesAttribute = + type.GetCustomAttribute(); + + ProcessorRecord item = new() + { + Name = attribute.Name, + Type = type, + Description = attribute.Description, + Group = attribute.Group, + Dependencies = dependenciesAttribute?.Dependencies ?? [], + Active = attribute.Active, + Parallel = attribute.Parallel, + }; + + CompendiumProcessorFactory factory = + ActivatorUtilities.CreateInstance(ServiceProvider, item); + + factory.CompendiumType = attribute.CompendiumType; + factory.InnerType = attribute.InnerType; + + item.Factory = factory; + + AllItems.Add(item); + } + + private void ProcessType(Type type, ProcessorFactoryAttribute? attribute) + { + if (attribute is null) + { + return; + } + + if (!type.IsAssignableTo(typeof(AbstractProcessorFactory))) + { + throw new( + $"Процессор {type}, которому установлен аттрибут {attribute.GetType()}, не реализует класс {typeof(AbstractProcessorFactory)}." + ); + } + + ProcessorDependenciesAttribute? dependenciesAttribute = + type.GetCustomAttribute(); + + ProcessorRecord item = new() + { + Name = attribute.Name, + Type = attribute.ProcessorType, + Description = attribute.Description, + Group = attribute.Group, + Dependencies = dependenciesAttribute?.Dependencies ?? [], + Active = attribute.Active, + Parallel = attribute.Parallel, + Factory = (AbstractProcessorFactory) + ActivatorUtilities.CreateInstance(ServiceProvider, type), + }; + + AllItems.Add(item); + } + + /// + /// Проверка, что все зависимости всех обработчиков могут быть удовлетворены. + /// + private void CheckDependencies() + { + foreach (ProcessorRecord item in Items) + { + foreach (string dependency in item.Dependencies) + { + if (Items.All(i => i.Name != dependency)) + { + throw new($"Dependency '{dependency}' for processor '{item.Name}' not found."); + } + } + } + } + + /// + /// Сортировать обработчики в соответсвии со всеми зависимостями. + /// + public void SortItems() + { + Items.ForEach(item => item.Priority = -1); + + Dictionary priorities = []; + + while (priorities.Count < Items.Count) + { + foreach (ProcessorRecord item in Items) + { + if (item.Priority >= 0) + { + continue; + } + + IEnumerable dependencyPriorities = item.Dependencies.Select(d => + priorities.GetValueOrDefault(d, -1) + ); + + if (dependencyPriorities.Any(p => p == -1)) + { + continue; + } + + item.Priority = Math.Max( + dependencyPriorities.Any() ? dependencyPriorities.Max() + 1 : 1, + (int)item.Group * 100 + ); + priorities.Add(item.Name, item.Priority); + } + } + + Items.Sort((a, b) => a.Priority - b.Priority); + } + + /// + /// Ограничить список используемых обработчиков по названию. + /// Автоматически включает все обработчики, от которых зависят указанные в аргументе обработчики. + /// + /// Коллекция названиий требуемых обработчиков. + public void FilterProcessors(ICollection processorNames) + { + if (processorNames.Count == 0) + { + Items = [.. AllItems]; + SortItems(); + return; + } + + Dictionary nameFlags = processorNames.ToDictionary(name => name, _ => false); + + while (nameFlags.Values.Any(v => !v)) + { + foreach ( + KeyValuePair pair in nameFlags.Where(pair => !pair.Value).ToList() + ) + { + ProcessorRecord item = AllItems.First(item => item.Name == pair.Key); + + foreach (string dependency in item.Dependencies) + { + nameFlags.TryAdd(dependency, false); + } + + nameFlags[pair.Key] = true; + } + } + + Items = AllItems.Where(item => nameFlags.ContainsKey(item.Name)).ToList(); + } + + /// + /// Получить список типов, которые обрабатываются в компендиуме. + /// + /// Тип компендиума. + /// Набор типов. + public ICollection GetTypesOfCompendium(ProcessorCompendiumEnum compendium) => + Items + .Where(item => + item.Factory.GetType().IsAssignableTo(typeof(CompendiumProcessorFactory)) + ) + .Where(item => + (item.Factory as CompendiumProcessorFactory)!.CompendiumType == compendium + ) + .Select(item => (item.Factory as CompendiumProcessorFactory)!.InnerType) + .OfType() + .ToList(); +} diff --git a/Pf2eDataScrapper/Processors/Collection/ProcessorRecord.cs b/Pf2eDataScrapper/Processors/Collection/ProcessorRecord.cs new file mode 100644 index 0000000..93bd2d2 --- /dev/null +++ b/Pf2eDataScrapper/Processors/Collection/ProcessorRecord.cs @@ -0,0 +1,57 @@ +using System; +using System.Collections.Generic; +using Pf2eDataScrapper.Processors.Attributes; +using Pf2eDataScrapper.Processors.Factory; + +namespace Pf2eDataScrapper.Processors.Collection; + +/// +/// Элемент коллекции обработчиков. +/// +internal class ProcessorRecord +{ + /// + /// Название обработчика. + /// + public required string Name { get; init; } + + /// + /// Тип класса обработчика. + /// + public required Type Type { get; init; } + + /// + /// Описание обработчика. + /// + public string Description { get; init; } = ""; + + /// + /// Фабрика обработчиков. + /// + public AbstractProcessorFactory Factory { get; set; } = null!; + + /// + /// Группа обработчика. + /// + public required ProcessorGroupEnum Group { get; init; } + + /// + /// Коллекция названий обработчиков, после которых должен выполняться обработчик. + /// + public ICollection Dependencies { get; init; } = []; + + /// + /// Процессор включён по умолчанию. + /// + public bool Active { get; init; } = true; + + /// + /// Приоритет выполнения обработчика. + /// + public int Priority { get; set; } = -1; + + /// + /// Разрешить выполнять процессов в параллельном режиме + /// + public bool Parallel { get; init; } = true; +} diff --git a/Pf2eDataScrapper/Processors/Definitions/AbstractInputProcessor.cs b/Pf2eDataScrapper/Processors/Definitions/AbstractInputProcessor.cs new file mode 100644 index 0000000..17fc8f2 --- /dev/null +++ b/Pf2eDataScrapper/Processors/Definitions/AbstractInputProcessor.cs @@ -0,0 +1,28 @@ +using Pf2eDataScrapper.Processors.Attributes; + +namespace Pf2eDataScrapper.Processors.Definitions; + +/// +/// Абстрактный класс-обработчик данных, полученных из Архивов Нефиса. +/// Класс предназначен для обработки данных с помощью различных обработчиков, +/// для которых указан атрибут . +/// +/// Входные данные обработчика. +/// +internal abstract class AbstractInputProcessor(ProcessorInput input) : IProcessor +{ + /// + /// Входные данные обработчика. + /// + public ProcessorInput Input { get; } = input; + + /// + /// Основной метод обработки данных. + /// + public abstract void Process(); + + /// + /// Метод для сохранения изменений в базе данных. + /// + public abstract void Save(); +} diff --git a/Pf2eDataScrapper/Processors/Definitions/AbstractSimpleProcessor.cs b/Pf2eDataScrapper/Processors/Definitions/AbstractSimpleProcessor.cs new file mode 100644 index 0000000..3cab212 --- /dev/null +++ b/Pf2eDataScrapper/Processors/Definitions/AbstractSimpleProcessor.cs @@ -0,0 +1,22 @@ +using Pf2eDataScrapper.Processors.Attributes; + +namespace Pf2eDataScrapper.Processors.Definitions; + +/// +/// Абстрактный класс-обработчик данных, полученных из Архивов Нефиса. +/// Класс предназначен для обработки данных с помощью различных обработчиков, +/// для которых указан атрибут . +/// +/// +internal abstract class AbstractSimpleProcessor : IProcessor +{ + /// + /// Основной метод обработки данных. + /// + public abstract void Process(); + + /// + /// Метод для сохранения изменений в базе данных. + /// + public abstract void Save(); +} diff --git a/Pf2eDataScrapper/Processors/Definitions/IProcessor.cs b/Pf2eDataScrapper/Processors/Definitions/IProcessor.cs new file mode 100644 index 0000000..f51074d --- /dev/null +++ b/Pf2eDataScrapper/Processors/Definitions/IProcessor.cs @@ -0,0 +1,17 @@ +namespace Pf2eDataScrapper.Processors.Definitions; + +/// +/// Интерфейс для обработчиков данных. +/// +public interface IProcessor +{ + /// + /// Основной метод обработки данных. + /// + void Process(); + + /// + /// Метод для сохранения изменений в базе данных. + /// + void Save(); +} diff --git a/Pf2eDataScrapper/Processors/Factory/AbstractProcessorFactory.cs b/Pf2eDataScrapper/Processors/Factory/AbstractProcessorFactory.cs new file mode 100644 index 0000000..672b4fe --- /dev/null +++ b/Pf2eDataScrapper/Processors/Factory/AbstractProcessorFactory.cs @@ -0,0 +1,29 @@ +using System; +using System.Collections.Generic; +using Pf2eDataScrapper.Processors.Collection; +using Pf2eDataScrapper.Processors.Definitions; + +namespace Pf2eDataScrapper.Processors.Factory; + +/// +/// Абстрактная фабрика создания процессоров. +/// +internal abstract class AbstractProcessorFactory +{ + /// + /// Подготовить фабрику к работе. + /// + public virtual void Prepare() { } + + /// + /// Количество элеметов для итерирования. + /// + /// Количество элеметов + public abstract int Count(); + + /// + /// Итератор процессоров. + /// + /// Пара значений: [0] - описание элемента процессор, [1] - процессор. + public abstract IEnumerable> GetEnumerator(); +} diff --git a/Pf2eDataScrapper/Processors/Factory/CompendiumProcessorFactory.cs b/Pf2eDataScrapper/Processors/Factory/CompendiumProcessorFactory.cs new file mode 100644 index 0000000..bb2b5dc --- /dev/null +++ b/Pf2eDataScrapper/Processors/Factory/CompendiumProcessorFactory.cs @@ -0,0 +1,71 @@ +using System; +using System.Collections.Generic; +using Microsoft.Extensions.DependencyInjection; +using Newtonsoft.Json.Linq; +using Pf2eDataScrapper.Importers; +using Pf2eDataScrapper.Importers.Implementations.Aonprd.Compendium; +using Pf2eDataScrapper.Importers.Implementations.FoundryEn.Compendium; +using Pf2eDataScrapper.Processors.Attributes; +using Pf2eDataScrapper.Processors.Collection; +using Pf2eDataScrapper.Processors.Definitions; + +namespace Pf2eDataScrapper.Processors.Factory; + +internal class CompendiumProcessorFactory(ProcessorRecord item, IServiceProvider serviceProvider) + : AbstractProcessorFactory +{ + public ProcessorRecord Item { get; } = item; + public IServiceProvider ServiceProvider { get; } = serviceProvider; + + public ProcessorCompendiumEnum? CompendiumType { get; set; } = null; + public string? InnerType { get; set; } = null; + + public AbstractCompendium Compendium { get; private set; } = null!; + public ICollection Types { get; private set; } = []; + + public override void Prepare() + { + if (CompendiumType is null) + { + throw new ArgumentNullException(nameof(CompendiumType)); + } + + base.Prepare(); + + ProcessorCollection collection = + ServiceProvider.GetService() ?? throw new(); + + Compendium = + CompendiumType switch + { + ProcessorCompendiumEnum.Aonprd => ServiceProvider.GetService(), + ProcessorCompendiumEnum.FoundryEn => + ServiceProvider.GetService(), + _ => (AbstractCompendium?)null, + } ?? throw new($"Не могу выбрать импортёр для группы {Item.Group}"); + + Types = InnerType is null + ? collection.GetTypesOfCompendium(CompendiumType ?? throw new()) + : [InnerType]; + } + + public override int Count() => Compendium.Count(Types); + + public override IEnumerable> GetEnumerator() + { + foreach ((AbstractCompendiumItem compendiumItem, JObject json) in Compendium.Iterate(Types)) + { + ProcessorInput processorInput = ActivatorUtilities.CreateInstance( + ServiceProvider, + compendiumItem.Id, + json + ); + + yield return new( + compendiumItem.Id, + (IProcessor) + ActivatorUtilities.CreateInstance(ServiceProvider, Item.Type, processorInput) + ); + } + } +} diff --git a/Pf2eDataScrapper/Processors/Factory/SimpleProcessorFactory.cs b/Pf2eDataScrapper/Processors/Factory/SimpleProcessorFactory.cs new file mode 100644 index 0000000..04188f5 --- /dev/null +++ b/Pf2eDataScrapper/Processors/Factory/SimpleProcessorFactory.cs @@ -0,0 +1,24 @@ +using System; +using System.Collections.Generic; +using Microsoft.Extensions.DependencyInjection; +using Pf2eDataScrapper.Processors.Collection; +using Pf2eDataScrapper.Processors.Definitions; + +namespace Pf2eDataScrapper.Processors.Factory; + +internal class SimpleProcessorFactory(ProcessorRecord item, IServiceProvider serviceProvider) + : AbstractProcessorFactory +{ + public ProcessorRecord Item { get; } = item; + public IServiceProvider ServiceProvider { get; } = serviceProvider; + + public override int Count() => 1; + + public override IEnumerable> GetEnumerator() + { + yield return new( + Item.Description, + (IProcessor)ActivatorUtilities.CreateInstance(ServiceProvider, Item.Type) + ); + } +} diff --git a/Pf2eDataScrapper/Processors/General/DatabaseTruncateProcessor.cs b/Pf2eDataScrapper/Processors/General/DatabaseTruncateProcessor.cs new file mode 100644 index 0000000..64e7d11 --- /dev/null +++ b/Pf2eDataScrapper/Processors/General/DatabaseTruncateProcessor.cs @@ -0,0 +1,17 @@ +using Pf2eDataScrapper.Processors.Attributes; +using Pf2eDataScrapper.Processors.Definitions; +using Pf2eModel; + +namespace Pf2eDataScrapper.Processors.General; + +[Processor("truncate", Description = "Отчистка таблиц БД", Group = ProcessorGroupEnum.General)] +internal class DatabaseTruncateProcessor : IProcessor +{ + public void Process() + { + using Pf2eDbContext context = new(); + string _ = context.Entities.Truncate() + "\n" + context.TruncateAll(); + } + + public void Save() { } +} diff --git a/Pf2eDataScrapper/Processors/ProcessorExecutor.cs b/Pf2eDataScrapper/Processors/ProcessorExecutor.cs new file mode 100644 index 0000000..09f0a8e --- /dev/null +++ b/Pf2eDataScrapper/Processors/ProcessorExecutor.cs @@ -0,0 +1,127 @@ +using System; +using System.Collections.Generic; +using System.ComponentModel; +using System.Threading.Tasks; +using Pf2eDataScrapper.Helpers; +using Pf2eDataScrapper.Processors.Collection; +using Pf2eDataScrapper.Processors.Definitions; +using Pf2eDataScrapper.Processors.Factory; + +namespace Pf2eDataScrapper.Processors; + +internal sealed class ProcessorExecutor( + ProcessorCollection collection, + ProcessProgress progress, + ApplicationSettings settings +) +{ + public ProcessorCollection Collection { get; } = collection; + public ProcessProgress Progress { get; } = progress; + public ApplicationSettings Settings { get; } = settings; + + public void Start() + { + Collection.SortItems(); + + Progress.Processors.Reset(Collection.Items.Count); + + StartItem(); + } + + private int _currentIndex; + + private AbstractProcessorFactory CurrentFactory { get; set; } = null!; + + private void StartItem() + { + ProcessorRecord item = Collection.Items[_currentIndex]; + + Progress.Processors.Start(item.Description); + Progress.Progress(Progress.Processors.ToString()); + + BackgroundWorker worker = new(); + + CurrentFactory = item.Factory; + CurrentFactory.Prepare(); + + worker.DoWork += (_, _) => + { + Parallel.ForEach( + IterateProcessors(), + new() { MaxDegreeOfParallelism = item.Parallel ? Settings.MaxThreads : 1 }, + RunProcessor + ); + }; + + worker.RunWorkerCompleted += (_, _) => Continue(); + + worker.RunWorkerAsync(); + } + + private void RunProcessor(IProcessor processor, ParallelLoopState state, long arg3) + { + try + { + processor.Process(); + processor.Save(); + } + catch (SkipItemException exception) + { + Progress.Information(exception.Message); + } + catch (SilentSkipItemException) + { + // + } + } + + private void Continue() + { + Progress.Processors.End(); + _currentIndex++; + + if (_currentIndex < Collection.Items.Count) + { + StartItem(); + } + else + { + Progress.Processors.Complete(); + } + } + + private IEnumerable IterateProcessors() + { + Progress.Local.Reset(CurrentFactory.Count()); + + foreach ((string title, IProcessor processor) in CurrentFactory.GetEnumerator()) + { + Progress.Local.Start(title); + + yield return processor; + + Progress.Local.End(); + } + + Progress.Local.Complete(); + } +} + +/// +/// Исключение, показывающее, что обработка сущности пропускается как устаревшая. +/// +/// Название сущности. +public class LegacyItemException(string name) : SkipItemException(name, "Устаревший элемент") { } + +/// +/// Исключение, показывающее, что обработка сущности пропускается. +/// +/// Название сущности. +/// Причина пропуска. +public class SkipItemException(string name, string reason) + : Exception($"Пропускаю элемент '{name}', указана причина: {reason}.") { } + +/// +/// Исключение, показывающее, что обработка сущности пропускается без вывода сообщения. +/// +public class SilentSkipItemException : Exception { } diff --git a/Pf2eDataScrapper/Importers/ProcessorInput.cs b/Pf2eDataScrapper/Processors/ProcessorInput.cs similarity index 69% rename from Pf2eDataScrapper/Importers/ProcessorInput.cs rename to Pf2eDataScrapper/Processors/ProcessorInput.cs index 85081e7..38e66c2 100644 --- a/Pf2eDataScrapper/Importers/ProcessorInput.cs +++ b/Pf2eDataScrapper/Processors/ProcessorInput.cs @@ -1,20 +1,37 @@ -using Newtonsoft.Json.Linq; +using System; +using System.Collections.Generic; +using System.Linq; +using System.Security.Cryptography; +using System.Text; +using Newtonsoft.Json.Linq; using NpgsqlTypes; using Pf2eModel.Model.Common.I18n; -namespace Pf2eDataScrapper.Importers; +namespace Pf2eDataScrapper.Processors; /// /// Класс для работы с JSON-объектом. /// +/// Название объекта, ассоциированного с вводом. /// JSON-объект, который будет использоваться для доступа к данным. -internal class ProcessorInput(JObject input) +/// [DI] Набор интерфейсов, разрешающих значения перечислений. +internal class ProcessorInput(string name, JObject input, IEnumerable enumSolvers) { + /// + /// Название объекта, ассоциированного с вводом. + /// + public string Name { get; } = name; + /// /// Входящий JSON-объект, который содержит данные для обработки. /// public JObject Input { get; } = input; + /// + /// Интерфейсы, разрешающие значения перечислений. + /// + public IEnumerable EnumSolvers { get; } = enumSolvers; + /// /// Значение из JSON по заданному пути, которое обязательно должно существовать. /// @@ -135,6 +152,20 @@ internal class ProcessorInput(JObject input) public virtual T Enum(string value) where T : Enum { + IEnumerable> solvers = EnumSolvers + .Where(solver => solver.GetType().IsAssignableTo(typeof(EnumSolver))) + .Cast>(); + + foreach (EnumSolver solver in solvers) + { + T? result = solver.SolveEnum(value); + + if (result is not null) + { + return result; + } + } + foreach (System.Reflection.FieldInfo field in typeof(T).GetFields()) { List variants = [field.Name]; @@ -156,6 +187,18 @@ internal class ProcessorInput(JObject input) throw new InvalidEnumStringException(typeof(T), value); } + /// + /// Создание контрольной суммы объекта. + /// + /// Использовать шестнадцатеричные цифры в нижнем регистре. + /// Контрольная сумма объекта. + public string Md5(bool isLowercase = false) + { + byte[] byteHash = MD5.HashData(Encoding.UTF8.GetBytes(Input.ToString())); + string hash = Convert.ToHexString(byteHash).Replace("-", ""); + return isLowercase ? hash.ToLower() : hash; + } + /// /// Исключение при неверном значении для перечисленния. /// @@ -164,3 +207,31 @@ internal class ProcessorInput(JObject input) public class InvalidEnumStringException(Type type, string value) : Exception($"Invalid value '{value}' for enum type {type.FullName}.") { } } + +/// +/// Интерфейс для решения значений перечислений. +/// +internal interface IEnumSolver { } + +/// +/// Абстрактный класс для разрешения значений перечислений. +/// +/// Тип перечисления, который будет разрешаться. +public abstract class EnumSolver : IEnumSolver + where TEnum : Enum +{ + /// + /// Словарь, содержащий данные для разрешения значений перечислений. + /// + public abstract Dictionary Data { get; } + + /// + /// Метод для разрешения значения перечисления по строковому вводу. + /// + /// Строка, представляющая значение перечисления. + /// Элемент перечисления , если найден; иначе null. + public TEnum? SolveEnum(string input) + { + return Data.GetValueOrDefault(input); + } +} diff --git a/Pf2eDataScrapper/Program.cs b/Pf2eDataScrapper/Program.cs index d32ba97..b6dd3a8 100644 --- a/Pf2eDataScrapper/Program.cs +++ b/Pf2eDataScrapper/Program.cs @@ -1,18 +1,53 @@ -using Pf2eDataScrapper; +using System; +using System.Windows; +using Microsoft.Extensions.DependencyInjection; using Pf2eDataScrapper.Importers.Implementations.Aonprd; +using Pf2eDataScrapper.Importers.Implementations.FoundryEn; +using Pf2eDataScrapper.WPF; -// Console.SetWindowSize(Console.LargestWindowWidth - 20, Console.LargestWindowHeight - 10); +namespace Pf2eDataScrapper; -EnvSettings.Load(); +internal static class Program +{ + /// + /// The main entry point for the application. + /// + [STAThread] + public static void Main() + { + // To customize application configuration such as set high DPI settings or default font, + // see https://aka.ms/applicationconfiguration. + ApplicationConfiguration.Initialize(); -/* -Pf2EFoundryImporter importer = new(); -*/ + // Application.SetHighDpiMode(HighDpiMode.SystemAware); + /* +#pragma warning disable WFO5001 + Application.SetColorMode(SystemColorMode.System); +#pragma warning restore WFO5001 + */ + IServiceCollection services = RegisterServices(); -AonprdImporter importer = new(); + IServiceProvider serviceProvider = services.BuildServiceProvider(); -// importer.ProcessorNames = ["rules", "rules-order"]; + ImportApplication app = ActivatorUtilities.CreateInstance( + serviceProvider + ); -importer.Prepare(); -importer.Import(); -// importer.BuildSchemas(); + app.Run(); + // Application.Run(app); + } + + private static IServiceCollection RegisterServices() + { + IServiceCollection services = new ServiceCollection(); + + services.RegisterWpfServices(); + + ImportApplication.RegisterServices(services); + + AonprdImporter.RegisterServices(services); + FoundryEnImporter.RegisterServices(services); + + return services; + } +} diff --git a/Pf2eDataScrapper/Resources/ImportAdaptation.json b/Pf2eDataScrapper/Resources/ImportAdaptation.json new file mode 100644 index 0000000..e5bbed8 --- /dev/null +++ b/Pf2eDataScrapper/Resources/ImportAdaptation.json @@ -0,0 +1,114 @@ +{ + "Aonprd": { + "SlugSuffixes": { + "feat-455": "initial", + "spell-843": "initial", + "feat-2664": "archetype", + "feat-3247": "game-hunter", + "feat-3477": "undead-slayer", + "feat-3549": "vampire", + "feat-4344": "archetype", + "feat-4380": "stonebound", + "feat-5730": "dragonblood", + "feat-5737": "dragonblood", + "feat-5997": "legacy", + "feat-6209": "investigator", + "feat-6469": "general", + "feat-6477": "undead-slayer", + "feat-6883": "kitsune", + "feat-7004": "yaoguai", + "feat-7380": "mythic", + "feat-7637": "dandy" + }, + "LegacyRemasterExtra": { + "action-14": "action-2273", + "action-15": "action-2275", + "action-558": "action-2277", + + "archetype-83": "archetype-129", + "archetype-86": "archetype-198", + + "feat-455": "feat-6007", + "feat-480": "feat-4850", + "feat-936": "feat-2269", + "feat-1177": "feat-4553", + "feat-1753": "feat-6031", + "feat-2117": "feat-7577", + "feat-2729": "feat-4077", + "feat-2742": "feat-4078", + "feat-2743": "feat-4079", + "feat-2986": "feat-4340", + "feat-2987": "feat-4341", + "feat-2989": "feat-4343", + "feat-2990": "feat-4346", + "feat-2991": "feat-4349", + "feat-2992": "feat-4350", + "feat-2993": "feat-4352", + "feat-4088": "feat-5491", + "feat-5997": "feat-7108", + + "language-91": "language-180", + + "ritual-31": "ritual-191", + + "spell-641": "spell-1413", + "spell-646": "spell-1394", + "spell-841": "spell-1107", + "spell-843": "spell-2376", + "spell-1052": "spell-1309", + "spell-1053": "spell-1306", + "spell-1054": "spell-1305", + "spell-1055": "spell-1311", + "spell-1056": "spell-1310", + "spell-1057": "spell-1307", + "spell-1058": "spell-1304", + "spell-1059": "spell-1308" + }, + "MergeSources": { + "feat-963": "feat-4519", + "feat-1167": "feat-5880", + "feat-1169": "feat-5055", + "feat-1171": "feat-4858", + + "spell-551": "spell-2003", + "spell-553": "spell-2012", + "spell-559": "spell-2417", + "spell-560": "spell-2418", + "spell-571": "spell-1975", + "spell-578": "spell-1566", + "spell-654": "spell-819" + }, + "SubclassGroups": { + "Research Field": "Alchemist", + "Apparition": "Animist", + "Practice": "Animist", + "Instinct": "Barbarian", + "Muse": "Bard", + "Cause": "Champion", + "Tenet": "Champion", + "Doctrine": "Cleric", + "Druidic Order": "Druid", + "Methodology": "Investigator", + "Element": "Kineticist", + "Hybrid Study": "Magus", + "Mystery": "Oracle", + "Conscious Mind": "Psychic", + "Subconscious Mind": "Psychic", + "Hunters Edge": "Ranger", + "Racket": "Rogue", + "Bloodline": "Sorcerer", + "Style": "Swashbuckler", + "Implement": "Thaumaturge", + "Lesson": "Witch", + "Patron": "Witch", + "Arcane School": "Wizard", + "Arcane Thesis": "Wizard", + "Way": "Gunslinger", + "Innovation": "Innovator", + "Ikon": "Exemplar", + "Epithet": "Exemplar", + "Hellknight Order": "_null", + "Eidolon": "_null" + } + } +} \ No newline at end of file diff --git a/Pf2eDataScrapper/SchemaBuilder/AbstractSchemaBuildProcessor.cs b/Pf2eDataScrapper/SchemaBuilder/AbstractSchemaBuildProcessor.cs new file mode 100644 index 0000000..879a554 --- /dev/null +++ b/Pf2eDataScrapper/SchemaBuilder/AbstractSchemaBuildProcessor.cs @@ -0,0 +1,121 @@ +using System; +using System.Collections.Generic; +using System.IO; +using Newtonsoft.Json.Linq; +using Pf2eDataScrapper.Helpers; +using Pf2eDataScrapper.Importers; +using Pf2eDataScrapper.Processors.Definitions; + +namespace Pf2eDataScrapper.SchemaBuilder; + +internal abstract class AbstractSchemaBuildProcessor : IProcessor +{ + /// + /// Связаный компендиум + /// + protected abstract AbstractCompendium Compendium { get; } + + /// + protected abstract ProcessProgress Progress { get; } + + /// + /// Определитель типов данных. + /// + protected abstract TypeResolver Resolver { get; } + + /// + /// Путь к каталогу для сохранения вывода. + /// + protected abstract string SavePath { get; } + + /// + /// Набор схем данных. + /// + protected Dictionary Schemas { get; } = []; + + /// + /// Получить список названий элементов структуры данных на основе вводимого элемента. + /// + /// Вводимый элемент + /// Коллекция названий элементов структуры данных/ + protected abstract ICollection GetSchemaNodes(AbstractCompendiumItem item); + + /// + /// Построение схемы данных. + /// + public void Process() + { + Progress.Local.Reset(Compendium.Count()); + + foreach ((AbstractCompendiumItem reference, JObject json) in Compendium.Iterate()) + { + Progress.Local.Start(reference.ToString()!); + + foreach (string nodeName in GetSchemaNodes(reference)) + { + if (!Schemas.TryGetValue(nodeName, out SchemaNode? node)) + { + node = new() { Path = nodeName, Resolver = Resolver }; + Schemas.Add(nodeName, node); + } + + node.AddValue(json); + } + + Progress.Local.End(); + } + + Progress.Local.Complete(); + } + + /// + /// Сохранение постренных схем данных. + /// + public void Save() + { + string targetDir = SavePath; + + foreach (KeyValuePair kvp in Schemas) + { + SaveSchema(targetDir, kvp.Key, kvp.Value); + } + } + + /// + /// Сохранение отдельной схемы данных. + /// + /// Целевой каталог. + /// Название схемы. + /// Сохраняемая схема. + protected void SaveSchema(string dir, string name, SchemaNode schema) + { + char[] invalids = Path.GetInvalidFileNameChars(); + string fileName = string.Join( + "_", + schema.Path.Split(invalids, StringSplitOptions.RemoveEmptyEntries) + ) + .TrimEnd('.'); + string path = Path.Combine(dir, fileName + ".yaml"); + + string? dirPath = Path.GetDirectoryName(path); + if (dirPath is not null && !Directory.Exists(dirPath)) + { + Directory.CreateDirectory(dirPath); + } + + using StreamWriter writer = new(path); + + schema.Beautify(); + + writer.WriteLine( + SchemaNode.FormatYaml( + new Dictionary() + { + ["name"] = name, + ["values"] = schema.Values.ToString(), + }, + schema.Types[0].GetYamlData() + ) + ); + } +} diff --git a/Pf2eDataScrapper/SchemaBuilder/SchemaNode.cs b/Pf2eDataScrapper/SchemaBuilder/SchemaNode.cs index cd7792f..27cde43 100644 --- a/Pf2eDataScrapper/SchemaBuilder/SchemaNode.cs +++ b/Pf2eDataScrapper/SchemaBuilder/SchemaNode.cs @@ -1,4 +1,6 @@ -using Newtonsoft.Json.Linq; +using System.Collections.Generic; +using System.Linq; +using Newtonsoft.Json.Linq; using Pf2eDataScrapper.SchemaBuilder.Types; namespace Pf2eDataScrapper.SchemaBuilder; @@ -6,6 +8,14 @@ namespace Pf2eDataScrapper.SchemaBuilder; /// /// Элемент схемы данных. /// +/// +/// Пример использования: +/// +/// SchemaNode schema = new (); // Создание схемы данных +/// data = JObject.Parse(reader.ReadToEnd()); // Загрузка данных +/// schema.AddValue(data); // Добавление данных +/// +/// internal class SchemaNode { /// diff --git a/Pf2eDataScrapper/SchemaBuilder/TypeResolver.cs b/Pf2eDataScrapper/SchemaBuilder/TypeResolver.cs index b436c9d..47a69db 100644 --- a/Pf2eDataScrapper/SchemaBuilder/TypeResolver.cs +++ b/Pf2eDataScrapper/SchemaBuilder/TypeResolver.cs @@ -1,4 +1,7 @@ -using Newtonsoft.Json.Linq; +using System; +using System.Collections.Generic; +using System.Linq; +using Newtonsoft.Json.Linq; using Pf2eDataScrapper.SchemaBuilder.Types; namespace Pf2eDataScrapper.SchemaBuilder; diff --git a/Pf2eDataScrapper/SchemaBuilder/Types/AbstractSchemaType.cs b/Pf2eDataScrapper/SchemaBuilder/Types/AbstractSchemaType.cs index af83044..d56d83f 100644 --- a/Pf2eDataScrapper/SchemaBuilder/Types/AbstractSchemaType.cs +++ b/Pf2eDataScrapper/SchemaBuilder/Types/AbstractSchemaType.cs @@ -1,4 +1,5 @@ -using Newtonsoft.Json.Linq; +using System.Collections.Generic; +using Newtonsoft.Json.Linq; namespace Pf2eDataScrapper.SchemaBuilder.Types; diff --git a/Pf2eDataScrapper/SchemaBuilder/Types/ArraySchemaType.cs b/Pf2eDataScrapper/SchemaBuilder/Types/ArraySchemaType.cs index 3c928d5..aaaf7f7 100644 --- a/Pf2eDataScrapper/SchemaBuilder/Types/ArraySchemaType.cs +++ b/Pf2eDataScrapper/SchemaBuilder/Types/ArraySchemaType.cs @@ -1,4 +1,6 @@ -using Newtonsoft.Json.Linq; +using System; +using System.Collections.Generic; +using Newtonsoft.Json.Linq; namespace Pf2eDataScrapper.SchemaBuilder.Types; diff --git a/Pf2eDataScrapper/SchemaBuilder/Types/DictionarySchemaType.cs b/Pf2eDataScrapper/SchemaBuilder/Types/DictionarySchemaType.cs index cce825d..8506386 100644 --- a/Pf2eDataScrapper/SchemaBuilder/Types/DictionarySchemaType.cs +++ b/Pf2eDataScrapper/SchemaBuilder/Types/DictionarySchemaType.cs @@ -1,4 +1,5 @@ -using Newtonsoft.Json.Linq; +using System.Collections.Generic; +using Newtonsoft.Json.Linq; namespace Pf2eDataScrapper.SchemaBuilder.Types; diff --git a/Pf2eDataScrapper/SchemaBuilder/Types/IgnoreSchemaType.cs b/Pf2eDataScrapper/SchemaBuilder/Types/IgnoreSchemaType.cs index 698fed7..3fff5d7 100644 --- a/Pf2eDataScrapper/SchemaBuilder/Types/IgnoreSchemaType.cs +++ b/Pf2eDataScrapper/SchemaBuilder/Types/IgnoreSchemaType.cs @@ -1,4 +1,5 @@ -using Newtonsoft.Json.Linq; +using System.Collections.Generic; +using Newtonsoft.Json.Linq; namespace Pf2eDataScrapper.SchemaBuilder.Types; diff --git a/Pf2eDataScrapper/SchemaBuilder/Types/ObjectSchemaType.cs b/Pf2eDataScrapper/SchemaBuilder/Types/ObjectSchemaType.cs index e573405..7385f7a 100644 --- a/Pf2eDataScrapper/SchemaBuilder/Types/ObjectSchemaType.cs +++ b/Pf2eDataScrapper/SchemaBuilder/Types/ObjectSchemaType.cs @@ -1,4 +1,7 @@ -using Newtonsoft.Json.Linq; +using System; +using System.Collections.Generic; +using System.Linq; +using Newtonsoft.Json.Linq; namespace Pf2eDataScrapper.SchemaBuilder.Types; diff --git a/Pf2eDataScrapper/SchemaBuilder/Types/StaticSchemaType.cs b/Pf2eDataScrapper/SchemaBuilder/Types/StaticSchemaType.cs index 76a5498..3ca17a5 100644 --- a/Pf2eDataScrapper/SchemaBuilder/Types/StaticSchemaType.cs +++ b/Pf2eDataScrapper/SchemaBuilder/Types/StaticSchemaType.cs @@ -1,4 +1,6 @@ -using Newtonsoft.Json.Linq; +using System.Collections.Generic; +using System.Linq; +using Newtonsoft.Json.Linq; namespace Pf2eDataScrapper.SchemaBuilder.Types; diff --git a/Pf2eDataScrapper/WPF/EntityViewer/Component/EntityListControl.xaml b/Pf2eDataScrapper/WPF/EntityViewer/Component/EntityListControl.xaml new file mode 100644 index 0000000..88ee49e --- /dev/null +++ b/Pf2eDataScrapper/WPF/EntityViewer/Component/EntityListControl.xaml @@ -0,0 +1,106 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/Pf2eDataScrapper/WPF/EntityViewer/Component/ViewControl.xaml.cs b/Pf2eDataScrapper/WPF/EntityViewer/Component/ViewControl.xaml.cs new file mode 100644 index 0000000..d7f9e98 --- /dev/null +++ b/Pf2eDataScrapper/WPF/EntityViewer/Component/ViewControl.xaml.cs @@ -0,0 +1,102 @@ +using System; +using System.Collections.Generic; +using System.ComponentModel; +using System.Linq; +using System.Text; +using System.Threading.Tasks; +using System.Windows; +using System.Windows.Controls; +using System.Windows.Data; +using System.Windows.Documents; +using System.Windows.Input; +using System.Windows.Media; +using System.Windows.Media.Imaging; +using System.Windows.Navigation; +using System.Windows.Shapes; +using Pf2eDataScrapper.Helpers; + +namespace Pf2eDataScrapper.WPF.EntityViewer.Component; + +internal partial class ViewControl : UserControl +{ + #region "Поля элемента управления" + + /// + /// Высота строки поля структуры. + /// + [DesignerSerializationVisibility(DesignerSerializationVisibility.Visible)] + [Category("Entity Render")] + [Description("The height of each item in the tree view.")] + public double ItemHeight + { + get { return (double)GetValue(ItemHeightProperty); } + set { SetValue(ItemHeightProperty, value); } + } + public static readonly DependencyProperty ItemHeightProperty = DependencyProperty.Register( + "ItemHeight", + typeof(double), + typeof(ViewControl), + new PropertyMetadata(20.0) + ); + + /// + /// Ширина отступа глубины. + /// + [DesignerSerializationVisibility(DesignerSerializationVisibility.Visible)] + [Category("Entity Render")] + [Description("The size of tab.")] + public double DepthSize + { + get { return (double)GetValue(DepthSizeProperty); } + set { SetValue(DepthSizeProperty, value); } + } + public static readonly DependencyProperty DepthSizeProperty = DependencyProperty.Register( + "DepthSize", + typeof(double), + typeof(ViewControl), + new PropertyMetadata(20.0) + ); + + /// + /// Размер шрифта типа поля сущности. + /// + [DesignerSerializationVisibility(DesignerSerializationVisibility.Visible)] + [Category("Entity Render")] + [Description("The size of tab.")] + public double TypeFontSize + { + get { return (double)GetValue(TypeFontSizeProperty); } + set { SetValue(TypeFontSizeProperty, value); } + } + public static readonly DependencyProperty TypeFontSizeProperty = DependencyProperty.Register( + "TypeFontSize", + typeof(double), + typeof(ViewControl), + new PropertyMetadata(9.5) + ); + + /// + /// Размер кнопки плюс/минус. + /// + [DesignerSerializationVisibility(DesignerSerializationVisibility.Visible)] + [Category("Entity Render")] + [Description("The size of plus/minus button.")] + public double ButtonSize + { + get { return (double)GetValue(ButtonSizeProperty); } + set { SetValue(ButtonSizeProperty, value); } + } + public static readonly DependencyProperty ButtonSizeProperty = DependencyProperty.Register( + "ButtonSize", + typeof(double), + typeof(ViewControl), + new PropertyMetadata(12.0) + ); + + #endregion + + public ViewControl() + { + InitializeComponent(); + } +} diff --git a/Pf2eDataScrapper/WPF/EntityViewer/Component/ViewLadder.xaml b/Pf2eDataScrapper/WPF/EntityViewer/Component/ViewLadder.xaml new file mode 100644 index 0000000..3d77178 --- /dev/null +++ b/Pf2eDataScrapper/WPF/EntityViewer/Component/ViewLadder.xaml @@ -0,0 +1,13 @@ + + + diff --git a/Pf2eDataScrapper/WPF/EntityViewer/Component/ViewLadder.xaml.cs b/Pf2eDataScrapper/WPF/EntityViewer/Component/ViewLadder.xaml.cs new file mode 100644 index 0000000..860e638 --- /dev/null +++ b/Pf2eDataScrapper/WPF/EntityViewer/Component/ViewLadder.xaml.cs @@ -0,0 +1,140 @@ +using System; +using System.Collections.Generic; +using System.ComponentModel; +using System.Linq; +using System.Text; +using System.Threading.Tasks; +using System.Windows; +using System.Windows.Controls; +using System.Windows.Data; +using System.Windows.Documents; +using System.Windows.Input; +using System.Windows.Media; +using System.Windows.Media.Imaging; +using System.Windows.Navigation; +using System.Windows.Shapes; +using Pf2eDataScrapper.WPF.EntityViewer; +using Pf2eDataScrapper.WPF.EntityViewer.EntityViewStructure; + +namespace Pf2eDataScrapper.WPF.EntityViewer.Component; + +/// +/// Логика взаимодействия для ViewLadder.xaml +/// +internal partial class ViewLadder : UserControl +{ + /// + /// Ширина отступа глубины. + /// + [DesignerSerializationVisibility(DesignerSerializationVisibility.Visible)] + [Category("Entity Render")] + [Description("The size of tab.")] + public double DepthSize + { + get { return (double)GetValue(DepthSizeProperty); } + set { SetValue(DepthSizeProperty, value); } + } + public static readonly DependencyProperty DepthSizeProperty = DependencyProperty.Register( + "DepthSize", + typeof(double), + typeof(ViewLadder), + new FrameworkPropertyMetadata(20.0, new PropertyChangedCallback(OnValueChanged)) + ); + + public IEnumerable Ladder + { + get { return (IEnumerable)GetValue(LadderProperty); } + set + { + SetValue(LadderProperty, value); + } + } + public static readonly DependencyProperty LadderProperty = DependencyProperty.Register( + "Ladder", + typeof(IEnumerable), + typeof(ViewLadder), + new FrameworkPropertyMetadata(Array.Empty(), new PropertyChangedCallback(OnValueChanged)) + ); + + private static void OnValueChanged(DependencyObject obj, DependencyPropertyChangedEventArgs args) + { + ViewLadder control = (ViewLadder)obj; + control.Rebuild(); + } + + public ViewLadder() + { + InitializeComponent(); + } + + public void Rebuild() + { + int n = Ladder.Count(); + Width = n * DepthSize; + + DrawingGroup result = new(); + + result.Children.Add( + new GeometryDrawing() + { + Geometry = new RectangleGeometry(new(0, 0, n * DepthSize, Height)), + Pen = new(Brushes.Transparent, 0), + } + ); + + result.Children.Add( + new GeometryDrawing() + { + Geometry = GetLadderGeometryGroup(Ladder, DepthSize, Height), + Pen = new(Brushes.Black, 1), + } + ); + + TargetCanvas.Background = new DrawingBrush(result); + } + + private GeometryGroup GetLadderGeometryGroup(IEnumerable ladder, double w, double h) + { + GeometryGroup geometryGroup = new(); + double w2 = w / 2; + double h2 = h / 2; + int i = 0; + + foreach (LadderType ladderType in ladder) + { + switch (ladderType) + { + case LadderType.Empty: + break; + case LadderType.Last: + geometryGroup.Children.Add( + new LineGeometry(new(i * w + w2, 0), new(i * w + w2, h2)) + ); + geometryGroup.Children.Add( + new LineGeometry(new(i * w + w2, h2), new(i * w + w, h2)) + ); + break; + + case LadderType.Through: + geometryGroup.Children.Add( + new LineGeometry(new(i * w + w2, 0), new(i * w + w2, h)) + ); + + if (i == ladder.Count() - 1) + { + geometryGroup.Children.Add( + new LineGeometry(new(i * w + w2, h2), new(i * w + w, h2)) + ); + } + break; + + default: + throw new ArgumentOutOfRangeException(nameof(ladder)); + } + + i++; + } + + return geometryGroup; + } +} diff --git a/Pf2eDataScrapper/WPF/EntityViewer/EntityForm.xaml b/Pf2eDataScrapper/WPF/EntityViewer/EntityForm.xaml new file mode 100644 index 0000000..6132c5f --- /dev/null +++ b/Pf2eDataScrapper/WPF/EntityViewer/EntityForm.xaml @@ -0,0 +1,88 @@ + + + + + + + + + + + + + + + + + + + + +