com.elestrago.unity.package-tools 2.2.2 → 2.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CAHNGELOG.md +22 -0
- package/Documentation~/api.md +230 -198
- package/Documentation~/manual.md +19 -19
- package/Documentation~/samples.md +44 -10
- package/Editor/Tools/FileTools.cs +11 -5
- package/README.md +39 -172
- package/Samples~/ClaudeSkills/unity-package-docs/SKILL.md +50 -8
- package/Samples~/ClaudeSkills/unity-package-docs/assets/api-chunk.md.template +10 -4
- package/Samples~/ClaudeSkills/unity-package-docs/assets/api.md.template +13 -4
- package/Samples~/ClaudeSkills/unity-package-docs/scripts/scan_package.py +55 -7
- package/package.json +4 -4
- package/Samples~/ClaudeSkills/unity-package-docs/unity-package-docs/SKILL.md +0 -309
- package/Samples~/ClaudeSkills/unity-package-docs/unity-package-docs/assets/README.md.template +0 -42
- package/Samples~/ClaudeSkills/unity-package-docs/unity-package-docs/assets/api-chunk.md.template +0 -41
- package/Samples~/ClaudeSkills/unity-package-docs/unity-package-docs/assets/api-index.md.template +0 -26
- package/Samples~/ClaudeSkills/unity-package-docs/unity-package-docs/assets/api.md.template +0 -43
- package/Samples~/ClaudeSkills/unity-package-docs/unity-package-docs/assets/manual.md.template +0 -57
- package/Samples~/ClaudeSkills/unity-package-docs/unity-package-docs/assets/samples.md.template +0 -56
- package/Samples~/ClaudeSkills/unity-package-docs/unity-package-docs/scripts/scan_package.py +0 -504
package/Documentation~/api.md
CHANGED
|
@@ -22,16 +22,16 @@ Root namespace. Hosts the `PackageManifestConfig` ScriptableObject, the editor c
|
|
|
22
22
|
public static class CIUtils
|
|
23
23
|
```
|
|
24
24
|
|
|
25
|
-
**Source:** `Assets/Package/PackageTool/Editor/CIUtils.cs:14`
|
|
25
|
+
**Source:** `Assets/Package/PackageTool/Editor/CIUtils.cs:14` (md5: `916a690462c237734b0cbceb4a8d3de1`, lines: 247)
|
|
26
26
|
|
|
27
27
|
Continuous-integration API for package tools.
|
|
28
28
|
|
|
29
29
|
**Members:**
|
|
30
30
|
|
|
31
|
-
| Kind | Name | Signature | Summary |
|
|
32
|
-
|
|
33
|
-
| method | `Generate` | `public static void Generate()` | Attempts to use zero or more `PackageManifestConfig` assets to generate legacy Unity packages and Unity source. |
|
|
34
|
-
| method | `PrepareDll` | `public static void PrepareDll()` | |
|
|
31
|
+
| Kind | Name | Signature | Line | Summary |
|
|
32
|
+
|------|------|-----------|------|---------|
|
|
33
|
+
| method | `Generate` | `public static void Generate()` | 65 | Attempts to use zero or more `PackageManifestConfig` assets to generate legacy Unity packages and Unity source. |
|
|
34
|
+
| method | `PrepareDll` | `public static void PrepareDll()` | 197 | |
|
|
35
35
|
|
|
36
36
|
### EditorConstants
|
|
37
37
|
|
|
@@ -39,59 +39,59 @@ Continuous-integration API for package tools.
|
|
|
39
39
|
internal static class EditorConstants
|
|
40
40
|
```
|
|
41
41
|
|
|
42
|
-
**Source:** `Assets/Package/PackageTool/Editor/EditorConstants.cs:32`
|
|
42
|
+
**Source:** `Assets/Package/PackageTool/Editor/EditorConstants.cs:32` (md5: `5b132575f223010b4d75c5d1a9a76596`, lines: 125)
|
|
43
43
|
|
|
44
44
|
Internal constants and readonly fields for package tools usage.
|
|
45
45
|
|
|
46
46
|
**Members:**
|
|
47
47
|
|
|
48
|
-
| Kind | Name | Signature | Summary |
|
|
49
|
-
|
|
50
|
-
| field | `DEFAULT_PACKAGE_VERSION` | `public const string DEFAULT_PACKAGE_VERSION` | |
|
|
51
|
-
| field | `DEFAULT_UNITY_VERSION` | `public const string DEFAULT_UNITY_VERSION` | |
|
|
52
|
-
| field | `PACKAGE_JSON_FILENAME` | `public const string PACKAGE_JSON_FILENAME` | |
|
|
53
|
-
| field | `WILDCARD_FILTER` | `public const string WILDCARD_FILTER` | |
|
|
54
|
-
| field | `ASSET_EXTENSION` | `public const string ASSET_EXTENSION` | |
|
|
55
|
-
| field | `META_EXTENSION` | `public const string META_EXTENSION` | |
|
|
56
|
-
| field | `META_FORMAT` | `public const string META_FORMAT` | |
|
|
57
|
-
| field | `GENERATED_FOLDER_NAME` | `public const string GENERATED_FOLDER_NAME` | |
|
|
58
|
-
| field | `UNITY_PACKAGE_NAME_FORMAT` | `public const string UNITY_PACKAGE_NAME_FORMAT` | |
|
|
59
|
-
| field | `EMPTY_SPACE` | `public const char EMPTY_SPACE` | |
|
|
60
|
-
| field | `UNDERSCORE` | `public const char UNDERSCORE` | |
|
|
61
|
-
| field | `GROUP_BOX` | `public const string GROUP_BOX` | |
|
|
62
|
-
| field | `EDITOR_FOLDER_ICON` | `public const string EDITOR_FOLDER_ICON` | |
|
|
63
|
-
| field | `EDITOR_FILE_ICON` | `public const string EDITOR_FILE_ICON` | |
|
|
64
|
-
| field | `PACKAGE_JSON_HEADER` | `public const string PACKAGE_JSON_HEADER` | |
|
|
65
|
-
| field | `PACKAGE_CONTENT_HEADER` | `public const string PACKAGE_CONTENT_HEADER` | |
|
|
66
|
-
| field | `PACKAGE_ACTIONS_HEADER` | `public const string PACKAGE_ACTIONS_HEADER` | |
|
|
67
|
-
| field | `SOURCE_PATHS_HEADER_LABEL` | `public const string SOURCE_PATHS_HEADER_LABEL` | |
|
|
68
|
-
| field | `SOURCE_PATH_ELEMENT_LABEL_FORMAT` | `public const string SOURCE_PATH_ELEMENT_LABEL_FORMAT` | |
|
|
69
|
-
| field | `IGNORE_PATHS_HEADER_LABEL` | `public const string IGNORE_PATHS_HEADER_LABEL` | |
|
|
70
|
-
| field | `KEYWORDS_HEADER_LABEL` | `public const string KEYWORDS_HEADER_LABEL` | |
|
|
71
|
-
| field | `KEYWORD_ELEMENT_LABEL_FORMAT` | `public const string KEYWORD_ELEMENT_LABEL_FORMAT` | |
|
|
72
|
-
| field | `DEPENDENCY_HEADER_LABEL` | `public const string DEPENDENCY_HEADER_LABEL` | |
|
|
73
|
-
| field | `DEPENDENCY_ELEMENT_LABEL_FORMAT` | `public const string DEPENDENCY_ELEMENT_LABEL_FORMAT` | |
|
|
74
|
-
| field | `GENERATE_VERSION_CONSTANTS_BUTTON_TEXT` | `public const string GENERATE_VERSION_CONSTANTS_BUTTON_TEXT` | |
|
|
75
|
-
| field | `UPDATE_PACKAGE_BUTTON_TEXT` | `public const string UPDATE_PACKAGE_BUTTON_TEXT` | |
|
|
76
|
-
| field | `EXPORT_LEGACY_PACKAGE_BUTTON_TEXT` | `public const string EXPORT_LEGACY_PACKAGE_BUTTON_TEXT` | |
|
|
77
|
-
| field | `SELECT_SOURCE_PATH_FILE_PICKER_TITLE` | `public const string SELECT_SOURCE_PATH_FILE_PICKER_TITLE` | |
|
|
78
|
-
| field | `SELECT_SOURCE_PATH_PICKER_FOLDER_TITLE` | `public const string SELECT_SOURCE_PATH_PICKER_FOLDER_TITLE` | |
|
|
79
|
-
| field | `SELECT_PACKAGE_EXPORT_PATH_PICKER_TITLE` | `public const string SELECT_PACKAGE_EXPORT_PATH_PICKER_TITLE` | |
|
|
80
|
-
| field | `SELECT_VERSION_CONSTANTS_PATH_PICKER_TITLE` | `public const string SELECT_VERSION_CONSTANTS_PATH_PICKER_TITLE` | |
|
|
81
|
-
| field | `SELECT_SAMPLES_PATH_FOLDER_TITLE` | `public const string SELECT_SAMPLES_PATH_FOLDER_TITLE` | |
|
|
82
|
-
| field | `PROGRESS_BAR_TITLE` | `public const string PROGRESS_BAR_TITLE` | |
|
|
83
|
-
| field | `PROGRESS_BAR_TITLE_LEGACY` | `public const string PROGRESS_BAR_TITLE_LEGACY` | |
|
|
84
|
-
| field | `COMPILING_PROGRESS_MESSAGE` | `public const string COMPILING_PROGRESS_MESSAGE` | |
|
|
85
|
-
| field | `FOLDER_PATH_PICKER_HEIGHT` | `public const float FOLDER_PATH_PICKER_HEIGHT` | |
|
|
86
|
-
| field | `FOLDER_PATH_PICKER_BUFFER` | `public const float FOLDER_PATH_PICKER_BUFFER` | |
|
|
87
|
-
| field | `SAMPLES_FOLDER_NAME` | `public const string SAMPLES_FOLDER_NAME` | |
|
|
88
|
-
| field | `SAMPLES_HEADER_LABEL` | `public const string SAMPLES_HEADER_LABEL` | |
|
|
89
|
-
| field | `SAMPLES_ELEMENT_LABEL_FORMAT` | `public const string SAMPLES_ELEMENT_LABEL_FORMAT` | |
|
|
90
|
-
| field | `COPY_ENTRIES_HEADER_LABEL` | `public const string COPY_ENTRIES_HEADER_LABEL` | |
|
|
91
|
-
| field | `COPY_ENTRY_ELEMENT_LABEL_FORMAT` | `public const string COPY_ENTRY_ELEMENT_LABEL_FORMAT` | |
|
|
92
|
-
| field | `COPY_ENTRY_SOURCE_LABEL` | `public const string COPY_ENTRY_SOURCE_LABEL` | |
|
|
93
|
-
| field | `COPY_ENTRY_DESTINATION_LABEL` | `public const string COPY_ENTRY_DESTINATION_LABEL` | |
|
|
94
|
-
| field | `SELECT_COPY_DESTINATION_FOLDER_PICKER_TITLE` | `public const string SELECT_COPY_DESTINATION_FOLDER_PICKER_TITLE` | |
|
|
48
|
+
| Kind | Name | Signature | Line | Summary |
|
|
49
|
+
|------|------|-----------|------|---------|
|
|
50
|
+
| field | `DEFAULT_PACKAGE_VERSION` | `public const string DEFAULT_PACKAGE_VERSION` | 35 | |
|
|
51
|
+
| field | `DEFAULT_UNITY_VERSION` | `public const string DEFAULT_UNITY_VERSION` | 36 | |
|
|
52
|
+
| field | `PACKAGE_JSON_FILENAME` | `public const string PACKAGE_JSON_FILENAME` | 39 | |
|
|
53
|
+
| field | `WILDCARD_FILTER` | `public const string WILDCARD_FILTER` | 40 | |
|
|
54
|
+
| field | `ASSET_EXTENSION` | `public const string ASSET_EXTENSION` | 41 | |
|
|
55
|
+
| field | `META_EXTENSION` | `public const string META_EXTENSION` | 42 | |
|
|
56
|
+
| field | `META_FORMAT` | `public const string META_FORMAT` | 43 | |
|
|
57
|
+
| field | `GENERATED_FOLDER_NAME` | `public const string GENERATED_FOLDER_NAME` | 44 | |
|
|
58
|
+
| field | `UNITY_PACKAGE_NAME_FORMAT` | `public const string UNITY_PACKAGE_NAME_FORMAT` | 45 | |
|
|
59
|
+
| field | `EMPTY_SPACE` | `public const char EMPTY_SPACE` | 46 | |
|
|
60
|
+
| field | `UNDERSCORE` | `public const char UNDERSCORE` | 47 | |
|
|
61
|
+
| field | `GROUP_BOX` | `public const string GROUP_BOX` | 53 | |
|
|
62
|
+
| field | `EDITOR_FOLDER_ICON` | `public const string EDITOR_FOLDER_ICON` | 60 | |
|
|
63
|
+
| field | `EDITOR_FILE_ICON` | `public const string EDITOR_FILE_ICON` | 61 | |
|
|
64
|
+
| field | `PACKAGE_JSON_HEADER` | `public const string PACKAGE_JSON_HEADER` | 64 | |
|
|
65
|
+
| field | `PACKAGE_CONTENT_HEADER` | `public const string PACKAGE_CONTENT_HEADER` | 65 | |
|
|
66
|
+
| field | `PACKAGE_ACTIONS_HEADER` | `public const string PACKAGE_ACTIONS_HEADER` | 66 | |
|
|
67
|
+
| field | `SOURCE_PATHS_HEADER_LABEL` | `public const string SOURCE_PATHS_HEADER_LABEL` | 68 | |
|
|
68
|
+
| field | `SOURCE_PATH_ELEMENT_LABEL_FORMAT` | `public const string SOURCE_PATH_ELEMENT_LABEL_FORMAT` | 69 | |
|
|
69
|
+
| field | `IGNORE_PATHS_HEADER_LABEL` | `public const string IGNORE_PATHS_HEADER_LABEL` | 71 | |
|
|
70
|
+
| field | `KEYWORDS_HEADER_LABEL` | `public const string KEYWORDS_HEADER_LABEL` | 73 | |
|
|
71
|
+
| field | `KEYWORD_ELEMENT_LABEL_FORMAT` | `public const string KEYWORD_ELEMENT_LABEL_FORMAT` | 74 | |
|
|
72
|
+
| field | `DEPENDENCY_HEADER_LABEL` | `public const string DEPENDENCY_HEADER_LABEL` | 76 | |
|
|
73
|
+
| field | `DEPENDENCY_ELEMENT_LABEL_FORMAT` | `public const string DEPENDENCY_ELEMENT_LABEL_FORMAT` | 77 | |
|
|
74
|
+
| field | `GENERATE_VERSION_CONSTANTS_BUTTON_TEXT` | `public const string GENERATE_VERSION_CONSTANTS_BUTTON_TEXT` | 79 | |
|
|
75
|
+
| field | `UPDATE_PACKAGE_BUTTON_TEXT` | `public const string UPDATE_PACKAGE_BUTTON_TEXT` | 86 | |
|
|
76
|
+
| field | `EXPORT_LEGACY_PACKAGE_BUTTON_TEXT` | `public const string EXPORT_LEGACY_PACKAGE_BUTTON_TEXT` | 87 | |
|
|
77
|
+
| field | `SELECT_SOURCE_PATH_FILE_PICKER_TITLE` | `public const string SELECT_SOURCE_PATH_FILE_PICKER_TITLE` | 89 | |
|
|
78
|
+
| field | `SELECT_SOURCE_PATH_PICKER_FOLDER_TITLE` | `public const string SELECT_SOURCE_PATH_PICKER_FOLDER_TITLE` | 90 | |
|
|
79
|
+
| field | `SELECT_PACKAGE_EXPORT_PATH_PICKER_TITLE` | `public const string SELECT_PACKAGE_EXPORT_PATH_PICKER_TITLE` | 91 | |
|
|
80
|
+
| field | `SELECT_VERSION_CONSTANTS_PATH_PICKER_TITLE` | `public const string SELECT_VERSION_CONSTANTS_PATH_PICKER_TITLE` | 92 | |
|
|
81
|
+
| field | `SELECT_SAMPLES_PATH_FOLDER_TITLE` | `public const string SELECT_SAMPLES_PATH_FOLDER_TITLE` | 93 | |
|
|
82
|
+
| field | `PROGRESS_BAR_TITLE` | `public const string PROGRESS_BAR_TITLE` | 94 | |
|
|
83
|
+
| field | `PROGRESS_BAR_TITLE_LEGACY` | `public const string PROGRESS_BAR_TITLE_LEGACY` | 95 | |
|
|
84
|
+
| field | `COMPILING_PROGRESS_MESSAGE` | `public const string COMPILING_PROGRESS_MESSAGE` | 96 | |
|
|
85
|
+
| field | `FOLDER_PATH_PICKER_HEIGHT` | `public const float FOLDER_PATH_PICKER_HEIGHT` | 98 | |
|
|
86
|
+
| field | `FOLDER_PATH_PICKER_BUFFER` | `public const float FOLDER_PATH_PICKER_BUFFER` | 99 | |
|
|
87
|
+
| field | `SAMPLES_FOLDER_NAME` | `public const string SAMPLES_FOLDER_NAME` | 115 | |
|
|
88
|
+
| field | `SAMPLES_HEADER_LABEL` | `public const string SAMPLES_HEADER_LABEL` | 116 | |
|
|
89
|
+
| field | `SAMPLES_ELEMENT_LABEL_FORMAT` | `public const string SAMPLES_ELEMENT_LABEL_FORMAT` | 117 | |
|
|
90
|
+
| field | `COPY_ENTRIES_HEADER_LABEL` | `public const string COPY_ENTRIES_HEADER_LABEL` | 119 | |
|
|
91
|
+
| field | `COPY_ENTRY_ELEMENT_LABEL_FORMAT` | `public const string COPY_ENTRY_ELEMENT_LABEL_FORMAT` | 120 | |
|
|
92
|
+
| field | `COPY_ENTRY_SOURCE_LABEL` | `public const string COPY_ENTRY_SOURCE_LABEL` | 121 | |
|
|
93
|
+
| field | `COPY_ENTRY_DESTINATION_LABEL` | `public const string COPY_ENTRY_DESTINATION_LABEL` | 122 | |
|
|
94
|
+
| field | `SELECT_COPY_DESTINATION_FOLDER_PICKER_TITLE` | `public const string SELECT_COPY_DESTINATION_FOLDER_PICKER_TITLE` | 123 | |
|
|
95
95
|
|
|
96
96
|
### MenuItems
|
|
97
97
|
|
|
@@ -99,7 +99,7 @@ Internal constants and readonly fields for package tools usage.
|
|
|
99
99
|
internal static class MenuItems
|
|
100
100
|
```
|
|
101
101
|
|
|
102
|
-
**Source:** `Assets/Package/PackageTool/Editor/MenuItems.cs:6`
|
|
102
|
+
**Source:** `Assets/Package/PackageTool/Editor/MenuItems.cs:6` (md5: `589a3e2956a9873db82d9d8193237c25`, lines: 11)
|
|
103
103
|
|
|
104
104
|
### PackageManifestConfig
|
|
105
105
|
|
|
@@ -107,7 +107,7 @@ internal static class MenuItems
|
|
|
107
107
|
public sealed class PackageManifestConfig : ScriptableObject
|
|
108
108
|
```
|
|
109
109
|
|
|
110
|
-
**Source:** `Assets/Package/PackageTool/Editor/PackageManifestConfig.cs:37`
|
|
110
|
+
**Source:** `Assets/Package/PackageTool/Editor/PackageManifestConfig.cs:37` (md5: `9d8366eaac0ad5bf7c6b136491d72d44`, lines: 214)
|
|
111
111
|
**Attributes:** `[CreateAssetMenu(fileName = "PackageManifestConfig", menuName = "JCMG/PackageTools/PackageManifestConfig")]`
|
|
112
112
|
**Base:** `ScriptableObject`
|
|
113
113
|
|
|
@@ -115,108 +115,108 @@ public sealed class PackageManifestConfig : ScriptableObject
|
|
|
115
115
|
|
|
116
116
|
**Members:**
|
|
117
117
|
|
|
118
|
-
| Kind | Name | Signature | Summary |
|
|
119
|
-
|
|
120
|
-
| property | `Id` | `public string Id` | A unique id for this `PackageManifestConfig` instance. |
|
|
121
|
-
| field | `homepage` | `public string homepage` | |
|
|
122
|
-
| field | `sourcePath` | `public string sourcePath` | A collection of paths to folders and files for the source for the package. |
|
|
123
|
-
| field | `documentationPath` | `public string documentationPath` | |
|
|
124
|
-
| field | `readmePath` | `public string readmePath` | |
|
|
125
|
-
| field | `changelogPath` | `public string changelogPath` | |
|
|
126
|
-
| field | `licensePath` | `public string licensePath` | |
|
|
127
|
-
| field | `license` | `public string license` | |
|
|
128
|
-
| field | `packageIgnorePaths` | `public string[] packageIgnorePaths` | A collection of file/folder paths to exclude from the package. |
|
|
129
|
-
| field | `packageDestinationPath` | `public string packageDestinationPath` | A path to the package source distribution contents. |
|
|
130
|
-
| field | `legacyPackageDestinationPath` | `public string legacyPackageDestinationPath` | The relative path to the folder where the legacy package will be exported to. |
|
|
131
|
-
| field | `packageName` | `public string packageName` | The fully-qualified package name. |
|
|
132
|
-
| field | `displayName` | `public string displayName` | The package name as it appears in the Package Manager window. |
|
|
133
|
-
| field | `packageVersion` | `public string packageVersion` | The semantic version of the package in MAJOR.MINOR.PATCH format. |
|
|
134
|
-
| field | `unityVersion` | `public string unityVersion` | The version of Unity in semantic version format like 2018.1. |
|
|
135
|
-
| field | `description` | `public string description` | A description of the package. |
|
|
136
|
-
| field | `category` | `public string category` | The category the package belongs in. |
|
|
137
|
-
| field | `author` | `public Author author` | The author of this package. |
|
|
138
|
-
| field | `keywords` | `public string[] keywords` | A collection of keywords that describe the package. |
|
|
139
|
-
| field | `dependencies` | `public Dependency[] dependencies` | A collection of packages that this package depends on. |
|
|
140
|
-
| field | `samples` | `public Sample[] samples` | |
|
|
141
|
-
| field | `copyEntries` | `public CopyEntry[] copyEntries` | A collection of additional source-to-destination copy operations performed during export. |
|
|
142
|
-
| field | `versionConstantsPath` | `public string versionConstantsPath` | A path to the where the VersionConstants.cs file should be created/updated |
|
|
143
|
-
| field | `versionConstantsNamespace` | `public string versionConstantsNamespace` | The namespace the generated VersionConstants class will be in. If left blank, this will be the global namespace. |
|
|
144
|
-
| method | `GenerateJson` | `public string GenerateJson()` | Returns a Json `string` representation. |
|
|
118
|
+
| Kind | Name | Signature | Line | Summary |
|
|
119
|
+
|------|------|-----------|------|---------|
|
|
120
|
+
| property | `Id` | `public string Id` | 103 | A unique id for this `PackageManifestConfig` instance. |
|
|
121
|
+
| field | `homepage` | `public string homepage` | 105 | |
|
|
122
|
+
| field | `sourcePath` | `public string sourcePath` | 110 | A collection of paths to folders and files for the source for the package. |
|
|
123
|
+
| field | `documentationPath` | `public string documentationPath` | 112 | |
|
|
124
|
+
| field | `readmePath` | `public string readmePath` | 113 | |
|
|
125
|
+
| field | `changelogPath` | `public string changelogPath` | 114 | |
|
|
126
|
+
| field | `licensePath` | `public string licensePath` | 115 | |
|
|
127
|
+
| field | `license` | `public string license` | 116 | |
|
|
128
|
+
| field | `packageIgnorePaths` | `public string[] packageIgnorePaths` | 121 | A collection of file/folder paths to exclude from the package. |
|
|
129
|
+
| field | `packageDestinationPath` | `public string packageDestinationPath` | 126 | A path to the package source distribution contents. |
|
|
130
|
+
| field | `legacyPackageDestinationPath` | `public string legacyPackageDestinationPath` | 131 | The relative path to the folder where the legacy package will be exported to. |
|
|
131
|
+
| field | `packageName` | `public string packageName` | 136 | The fully-qualified package name. |
|
|
132
|
+
| field | `displayName` | `public string displayName` | 141 | The package name as it appears in the Package Manager window. |
|
|
133
|
+
| field | `packageVersion` | `public string packageVersion` | 146 | The semantic version of the package in MAJOR.MINOR.PATCH format. |
|
|
134
|
+
| field | `unityVersion` | `public string unityVersion` | 151 | The version of Unity in semantic version format like 2018.1. |
|
|
135
|
+
| field | `description` | `public string description` | 156 | A description of the package. |
|
|
136
|
+
| field | `category` | `public string category` | 161 | The category the package belongs in. |
|
|
137
|
+
| field | `author` | `public Author author` | 166 | The author of this package. |
|
|
138
|
+
| field | `keywords` | `public string[] keywords` | 171 | A collection of keywords that describe the package. |
|
|
139
|
+
| field | `dependencies` | `public Dependency[] dependencies` | 176 | A collection of packages that this package depends on. |
|
|
140
|
+
| field | `samples` | `public Sample[] samples` | 178 | |
|
|
141
|
+
| field | `copyEntries` | `public CopyEntry[] copyEntries` | 183 | A collection of additional source-to-destination copy operations performed during export. |
|
|
142
|
+
| field | `versionConstantsPath` | `public string versionConstantsPath` | 188 | A path to the where the VersionConstants.cs file should be created/updated |
|
|
143
|
+
| field | `versionConstantsNamespace` | `public string versionConstantsNamespace` | 194 | The namespace the generated VersionConstants class will be in. If left blank, this will be the global namespace. |
|
|
144
|
+
| method | `GenerateJson` | `public string GenerateJson()` | 202 | Returns a Json `string` representation. |
|
|
145
145
|
|
|
146
|
-
### PackageManifestConfig.
|
|
146
|
+
### PackageManifestConfig.Dependency
|
|
147
147
|
|
|
148
148
|
```csharp
|
|
149
|
-
public sealed class
|
|
149
|
+
public sealed class Dependency
|
|
150
150
|
```
|
|
151
151
|
|
|
152
|
-
**Source:** `Assets/Package/PackageTool/Editor/PackageManifestConfig.cs:
|
|
152
|
+
**Source:** `Assets/Package/PackageTool/Editor/PackageManifestConfig.cs:43` (md5: `9d8366eaac0ad5bf7c6b136491d72d44`, lines: 214)
|
|
153
153
|
**Attributes:** `[Serializable]`
|
|
154
154
|
|
|
155
|
-
Describes
|
|
155
|
+
Describes a dependency that this package requires.
|
|
156
156
|
|
|
157
157
|
**Members:**
|
|
158
158
|
|
|
159
|
-
| Kind | Name | Signature | Summary |
|
|
160
|
-
|
|
161
|
-
| field | `
|
|
162
|
-
| field | `
|
|
163
|
-
| field | `url` | `public string url` | |
|
|
159
|
+
| Kind | Name | Signature | Line | Summary |
|
|
160
|
+
|------|------|-----------|------|---------|
|
|
161
|
+
| field | `packageName` | `public string packageName` | 48 | The name of the dependent package. |
|
|
162
|
+
| field | `packageVersion` | `public string packageVersion` | 53 | The semantic version of the dependent package in MAJOR.MINOR.PATCH format. |
|
|
164
163
|
|
|
165
|
-
### PackageManifestConfig.
|
|
164
|
+
### PackageManifestConfig.Author
|
|
166
165
|
|
|
167
166
|
```csharp
|
|
168
|
-
public sealed class
|
|
167
|
+
public sealed class Author
|
|
169
168
|
```
|
|
170
169
|
|
|
171
|
-
**Source:** `Assets/Package/PackageTool/Editor/PackageManifestConfig.cs:
|
|
170
|
+
**Source:** `Assets/Package/PackageTool/Editor/PackageManifestConfig.cs:62` (md5: `9d8366eaac0ad5bf7c6b136491d72d44`, lines: 214)
|
|
172
171
|
**Attributes:** `[Serializable]`
|
|
173
172
|
|
|
174
|
-
Describes
|
|
173
|
+
Describes the author of this package.
|
|
175
174
|
|
|
176
175
|
**Members:**
|
|
177
176
|
|
|
178
|
-
| Kind | Name | Signature | Summary |
|
|
179
|
-
|
|
180
|
-
| field | `
|
|
181
|
-
| field | `
|
|
177
|
+
| Kind | Name | Signature | Line | Summary |
|
|
178
|
+
|------|------|-----------|------|---------|
|
|
179
|
+
| field | `name` | `public string name` | 64 | |
|
|
180
|
+
| field | `email` | `public string email` | 65 | |
|
|
181
|
+
| field | `url` | `public string url` | 66 | |
|
|
182
182
|
|
|
183
|
-
### PackageManifestConfig.
|
|
183
|
+
### PackageManifestConfig.Sample
|
|
184
184
|
|
|
185
185
|
```csharp
|
|
186
|
-
public sealed class
|
|
186
|
+
public sealed class Sample
|
|
187
187
|
```
|
|
188
188
|
|
|
189
|
-
**Source:** `Assets/Package/PackageTool/Editor/PackageManifestConfig.cs:
|
|
189
|
+
**Source:** `Assets/Package/PackageTool/Editor/PackageManifestConfig.cs:73` (md5: `9d8366eaac0ad5bf7c6b136491d72d44`, lines: 214)
|
|
190
190
|
**Attributes:** `[Serializable]`
|
|
191
191
|
|
|
192
|
-
Describes
|
|
192
|
+
Describes the samples of this package.
|
|
193
193
|
|
|
194
194
|
**Members:**
|
|
195
195
|
|
|
196
|
-
| Kind | Name | Signature | Summary |
|
|
197
|
-
|
|
198
|
-
| field | `
|
|
199
|
-
| field | `
|
|
196
|
+
| Kind | Name | Signature | Line | Summary |
|
|
197
|
+
|------|------|-----------|------|---------|
|
|
198
|
+
| field | `sourcePath` | `public string sourcePath` | 75 | |
|
|
199
|
+
| field | `displayName` | `public string displayName` | 76 | |
|
|
200
|
+
| field | `description` | `public string description` | 77 | |
|
|
201
|
+
| field | `folderName` | `public string folderName` | 78 | |
|
|
200
202
|
|
|
201
|
-
### PackageManifestConfig.
|
|
203
|
+
### PackageManifestConfig.CopyEntry
|
|
202
204
|
|
|
203
205
|
```csharp
|
|
204
|
-
public sealed class
|
|
206
|
+
public sealed class CopyEntry
|
|
205
207
|
```
|
|
206
208
|
|
|
207
|
-
**Source:** `Assets/Package/PackageTool/Editor/PackageManifestConfig.cs:
|
|
209
|
+
**Source:** `Assets/Package/PackageTool/Editor/PackageManifestConfig.cs:92` (md5: `9d8366eaac0ad5bf7c6b136491d72d44`, lines: 214)
|
|
208
210
|
**Attributes:** `[Serializable]`
|
|
209
211
|
|
|
210
|
-
Describes the
|
|
212
|
+
Describes a copy operation that mirrors a source file or folder into a destination folder inside the project. When the source is a folder, the same-named subfolder of the destination is replaced with the source folder's content. When the source is a file, the same-named file inside the destination folder is replaced. An empty or non-existent destination path falls back to the project root.
|
|
211
213
|
|
|
212
214
|
**Members:**
|
|
213
215
|
|
|
214
|
-
| Kind | Name | Signature | Summary |
|
|
215
|
-
|
|
216
|
-
| field | `sourcePath` | `public string sourcePath` | |
|
|
217
|
-
| field | `
|
|
218
|
-
| field | `description` | `public string description` | |
|
|
219
|
-
| field | `folderName` | `public string folderName` | |
|
|
216
|
+
| Kind | Name | Signature | Line | Summary |
|
|
217
|
+
|------|------|-----------|------|---------|
|
|
218
|
+
| field | `sourcePath` | `public string sourcePath` | 94 | |
|
|
219
|
+
| field | `destinationPath` | `public string destinationPath` | 95 | |
|
|
220
220
|
|
|
221
221
|
## `PackageTool.Drawers`
|
|
222
222
|
|
|
@@ -228,7 +228,7 @@ Describes the samples of this package.
|
|
|
228
228
|
internal sealed class AuthorPropertyDrawer : PropertyDrawer
|
|
229
229
|
```
|
|
230
230
|
|
|
231
|
-
**Source:** `Assets/Package/PackageTool/Editor/Drawers/AuthorPropertyDrawer.cs:34`
|
|
231
|
+
**Source:** `Assets/Package/PackageTool/Editor/Drawers/AuthorPropertyDrawer.cs:34` (md5: `6a2b127393e578eb4d08e95fc7c09eb9`, lines: 82)
|
|
232
232
|
**Attributes:** `[CustomPropertyDrawer(typeof(PackageManifestConfig.Author))]`
|
|
233
233
|
**Base:** `PropertyDrawer`
|
|
234
234
|
|
|
@@ -236,10 +236,10 @@ A property drawer for drawing `Author`
|
|
|
236
236
|
|
|
237
237
|
**Members:**
|
|
238
238
|
|
|
239
|
-
| Kind | Name | Signature | Summary |
|
|
240
|
-
|
|
241
|
-
| method | `OnGUI` | `public override void OnGUI(Rect position, SerializedProperty property, GUIContent label)` | |
|
|
242
|
-
| method | `GetPropertyHeight` | `public override float GetPropertyHeight(SerializedProperty property, GUIContent label)` | |
|
|
239
|
+
| Kind | Name | Signature | Line | Summary |
|
|
240
|
+
|------|------|-----------|------|---------|
|
|
241
|
+
| method | `OnGUI` | `public override void OnGUI(Rect position, SerializedProperty property, GUIContent label)` | 55 | |
|
|
242
|
+
| method | `GetPropertyHeight` | `public override float GetPropertyHeight(SerializedProperty property, GUIContent label)` | 77 | |
|
|
243
243
|
|
|
244
244
|
### CopyEntryPropertyDrawer
|
|
245
245
|
|
|
@@ -247,16 +247,16 @@ A property drawer for drawing `Author`
|
|
|
247
247
|
internal sealed class CopyEntryPropertyDrawer : PropertyDrawer
|
|
248
248
|
```
|
|
249
249
|
|
|
250
|
-
**Source:** `Assets/Package/PackageTool/Editor/Drawers/CopyEntryPropertyDrawer.cs:8`
|
|
250
|
+
**Source:** `Assets/Package/PackageTool/Editor/Drawers/CopyEntryPropertyDrawer.cs:8` (md5: `68154b3129ae05859aab0ec347f417e7`, lines: 95)
|
|
251
251
|
**Attributes:** `[CustomPropertyDrawer(typeof(PackageManifestConfig.CopyEntry))]`
|
|
252
252
|
**Base:** `PropertyDrawer`
|
|
253
253
|
|
|
254
254
|
**Members:**
|
|
255
255
|
|
|
256
|
-
| Kind | Name | Signature | Summary |
|
|
257
|
-
|
|
258
|
-
| method | `OnGUI` | `public override void OnGUI(Rect position, SerializedProperty property, GUIContent label)` | |
|
|
259
|
-
| method | `GetPropertyHeight` | `public override float GetPropertyHeight(SerializedProperty property, GUIContent label)` | |
|
|
256
|
+
| Kind | Name | Signature | Line | Summary |
|
|
257
|
+
|------|------|-----------|------|---------|
|
|
258
|
+
| method | `OnGUI` | `public override void OnGUI(Rect position, SerializedProperty property, GUIContent label)` | 13 | |
|
|
259
|
+
| method | `GetPropertyHeight` | `public override float GetPropertyHeight(SerializedProperty property, GUIContent label)` | 29 | |
|
|
260
260
|
|
|
261
261
|
### DependencyPropertyDrawer
|
|
262
262
|
|
|
@@ -264,7 +264,7 @@ internal sealed class CopyEntryPropertyDrawer : PropertyDrawer
|
|
|
264
264
|
internal sealed class DependencyPropertyDrawer : PropertyDrawer
|
|
265
265
|
```
|
|
266
266
|
|
|
267
|
-
**Source:** `Assets/Package/PackageTool/Editor/Drawers/DependencyPropertyDrawer.cs:34`
|
|
267
|
+
**Source:** `Assets/Package/PackageTool/Editor/Drawers/DependencyPropertyDrawer.cs:34` (md5: `b8f38cb4f6ea7fd5e71aec473f4ce17e`, lines: 60)
|
|
268
268
|
**Attributes:** `[CustomPropertyDrawer(typeof(PackageManifestConfig.Dependency))]`
|
|
269
269
|
**Base:** `PropertyDrawer`
|
|
270
270
|
|
|
@@ -272,10 +272,10 @@ A property drawer for drawing `Dependency`
|
|
|
272
272
|
|
|
273
273
|
**Members:**
|
|
274
274
|
|
|
275
|
-
| Kind | Name | Signature | Summary |
|
|
276
|
-
|
|
277
|
-
| method | `OnGUI` | `public override void OnGUI(Rect position, SerializedProperty property, GUIContent label)` | |
|
|
278
|
-
| method | `GetPropertyHeight` | `public override float GetPropertyHeight(SerializedProperty property, GUIContent label)` | |
|
|
275
|
+
| Kind | Name | Signature | Line | Summary |
|
|
276
|
+
|------|------|-----------|------|---------|
|
|
277
|
+
| method | `OnGUI` | `public override void OnGUI(Rect position, SerializedProperty property, GUIContent label)` | 39 | |
|
|
278
|
+
| method | `GetPropertyHeight` | `public override float GetPropertyHeight(SerializedProperty property, GUIContent label)` | 55 | |
|
|
279
279
|
|
|
280
280
|
### SamplePropertyDrawer
|
|
281
281
|
|
|
@@ -283,16 +283,16 @@ A property drawer for drawing `Dependency`
|
|
|
283
283
|
public class SamplePropertyDrawer : PropertyDrawer
|
|
284
284
|
```
|
|
285
285
|
|
|
286
|
-
**Source:** `Assets/Package/PackageTool/Editor/Drawers/SamplePropertyDrawer.cs:8`
|
|
286
|
+
**Source:** `Assets/Package/PackageTool/Editor/Drawers/SamplePropertyDrawer.cs:8` (md5: `ca4606a206cac4a389f9731173ff9a41`, lines: 68)
|
|
287
287
|
**Attributes:** `[CustomPropertyDrawer(typeof(PackageManifestConfig.Sample))]`
|
|
288
288
|
**Base:** `PropertyDrawer`
|
|
289
289
|
|
|
290
290
|
**Members:**
|
|
291
291
|
|
|
292
|
-
| Kind | Name | Signature | Summary |
|
|
293
|
-
|
|
294
|
-
| method | `OnGUI` | `public override void OnGUI(Rect position, SerializedProperty property, GUIContent label)` | |
|
|
295
|
-
| method | `GetPropertyHeight` | `public override float GetPropertyHeight(SerializedProperty property, GUIContent label)` | |
|
|
292
|
+
| Kind | Name | Signature | Line | Summary |
|
|
293
|
+
|------|------|-----------|------|---------|
|
|
294
|
+
| method | `OnGUI` | `public override void OnGUI(Rect position, SerializedProperty property, GUIContent label)` | 15 | |
|
|
295
|
+
| method | `GetPropertyHeight` | `public override float GetPropertyHeight(SerializedProperty property, GUIContent label)` | 65 | |
|
|
296
296
|
|
|
297
297
|
## `PackageTool.Inspectors`
|
|
298
298
|
|
|
@@ -304,15 +304,15 @@ public class SamplePropertyDrawer : PropertyDrawer
|
|
|
304
304
|
internal sealed class PackageManifestConfigInspector : UnityEditor.Editor
|
|
305
305
|
```
|
|
306
306
|
|
|
307
|
-
**Source:** `Assets/Package/PackageTool/Editor/Inspectors/PackageManifestConfigInspector.cs:33`
|
|
307
|
+
**Source:** `Assets/Package/PackageTool/Editor/Inspectors/PackageManifestConfigInspector.cs:33` (md5: `5dd7983f41776356a8288b1f1505579b`, lines: 435)
|
|
308
308
|
**Attributes:** `[CustomEditor(typeof(PackageManifestConfig))]`
|
|
309
309
|
**Base:** `UnityEditor.Editor`
|
|
310
310
|
|
|
311
311
|
**Members:**
|
|
312
312
|
|
|
313
|
-
| Kind | Name | Signature | Summary |
|
|
314
|
-
|
|
315
|
-
| method | `OnInspectorGUI` | `public override void OnInspectorGUI()` | |
|
|
313
|
+
| Kind | Name | Signature | Line | Summary |
|
|
314
|
+
|------|------|-----------|------|---------|
|
|
315
|
+
| method | `OnInspectorGUI` | `public override void OnInspectorGUI()` | 126 | |
|
|
316
316
|
|
|
317
317
|
## `PackageTool.Tools`
|
|
318
318
|
|
|
@@ -324,15 +324,15 @@ Stateless helpers used during export and code generation: file copy, git probing
|
|
|
324
324
|
internal static class CodeGenTools
|
|
325
325
|
```
|
|
326
326
|
|
|
327
|
-
**Source:** `Assets/Package/PackageTool/Editor/Tools/CodeGenTools.cs:36`
|
|
327
|
+
**Source:** `Assets/Package/PackageTool/Editor/Tools/CodeGenTools.cs:36` (md5: `356a55ac25c4c9b3b20843cfb51bd73d`, lines: 145)
|
|
328
328
|
|
|
329
329
|
Helper methods for code-gen.
|
|
330
330
|
|
|
331
331
|
**Members:**
|
|
332
332
|
|
|
333
|
-
| Kind | Name | Signature | Summary |
|
|
334
|
-
|
|
335
|
-
| method | `GenerateVersionConstants` | `public static void GenerateVersionConstants(PackageManifestConfig config)` | |
|
|
333
|
+
| Kind | Name | Signature | Line | Summary |
|
|
334
|
+
|------|------|-----------|------|---------|
|
|
335
|
+
| method | `GenerateVersionConstants` | `public static void GenerateVersionConstants(PackageManifestConfig config)` | 114 | |
|
|
336
336
|
|
|
337
337
|
### CommandLineTools
|
|
338
338
|
|
|
@@ -340,15 +340,15 @@ Helper methods for code-gen.
|
|
|
340
340
|
public static class CommandLineTools
|
|
341
341
|
```
|
|
342
342
|
|
|
343
|
-
**Source:** `Assets/Package/PackageTool/Editor/Tools/CommandLineTools.cs:33`
|
|
343
|
+
**Source:** `Assets/Package/PackageTool/Editor/Tools/CommandLineTools.cs:33` (md5: `7ab75783e17ff23d3cc1d74328c58b75`, lines: 68)
|
|
344
344
|
|
|
345
345
|
Helper methods for command-line usage
|
|
346
346
|
|
|
347
347
|
**Members:**
|
|
348
348
|
|
|
349
|
-
| Kind | Name | Signature | Summary |
|
|
350
|
-
|
|
351
|
-
| method | `GetKVPCommandLineArguments` | `public static Dictionary<string, object> GetKVPCommandLineArguments()` | Returns a more easily-searchable `Dictionary{TKey,TValue}` of command-line arguments. |
|
|
349
|
+
| Kind | Name | Signature | Line | Summary |
|
|
350
|
+
|------|------|-----------|------|---------|
|
|
351
|
+
| method | `GetKVPCommandLineArguments` | `public static Dictionary<string, object> GetKVPCommandLineArguments()` | 43 | Returns a more easily-searchable `Dictionary{TKey,TValue}` of command-line arguments. |
|
|
352
352
|
|
|
353
353
|
### FileTools
|
|
354
354
|
|
|
@@ -356,20 +356,20 @@ Helper methods for command-line usage
|
|
|
356
356
|
internal static class FileTools
|
|
357
357
|
```
|
|
358
358
|
|
|
359
|
-
**Source:** `Assets/Package/PackageTool/Editor/Tools/FileTools.cs:38`
|
|
359
|
+
**Source:** `Assets/Package/PackageTool/Editor/Tools/FileTools.cs:38` (md5: `7fd9c0eb3de4e293bca7dd1aca305340`, lines: 445)
|
|
360
360
|
|
|
361
361
|
Helper methods for dealing with files/directories
|
|
362
362
|
|
|
363
363
|
**Members:**
|
|
364
364
|
|
|
365
|
-
| Kind | Name | Signature | Summary |
|
|
366
|
-
|
|
367
|
-
| method | `ConvertToRelativePath` | `public static string ConvertToRelativePath(string fullFilePath, string referencePath)` | Converts `fullFilePath` into a relative file path from `referencePath`. |
|
|
368
|
-
| method | `CreateOrUpdatePackageSource` | `public static void CreateOrUpdatePackageSource(PackageManifestConfig packageManifest)` | Creates or updates the existing package contents of `PackageManifestConfig` `packageManifest`. |
|
|
369
|
-
| method | `CopyDocumentationToDirectory` | `public static void CopyDocumentationToDirectory(PackageManifestConfig packageManifest)` | |
|
|
370
|
-
| method | `CopyEntriesToProject` | `public static void CopyEntriesToProject(PackageManifestConfig packageManifest)` | Stages each configured `CopyEntry` into the project before the rest of the export runs. A folder source's
|
|
371
|
-
| method | `IsFile` | `public static bool IsFile(string path)` | Returns true if the `path` is for a file, otherwise false. |
|
|
372
|
-
| method | `GetAllFilesRecursively` | `internal static IEnumerable<string> GetAllFilesRecursively(string folderPath)` | Recursive find all files starting at root folder at path `folderPath` and return a list of absolute paths to those files. |
|
|
365
|
+
| Kind | Name | Signature | Line | Summary |
|
|
366
|
+
|------|------|-----------|------|---------|
|
|
367
|
+
| method | `ConvertToRelativePath` | `public static string ConvertToRelativePath(string fullFilePath, string referencePath)` | 46 | Converts `fullFilePath` into a relative file path from `referencePath`. |
|
|
368
|
+
| method | `CreateOrUpdatePackageSource` | `public static void CreateOrUpdatePackageSource(PackageManifestConfig packageManifest)` | 59 | Creates or updates the existing package contents of `PackageManifestConfig` `packageManifest`. |
|
|
369
|
+
| method | `CopyDocumentationToDirectory` | `public static void CopyDocumentationToDirectory(PackageManifestConfig packageManifest)` | 153 | |
|
|
370
|
+
| method | `CopyEntriesToProject` | `public static void CopyEntriesToProject(PackageManifestConfig packageManifest)` | 206 | Stages each configured `CopyEntry` into the project before the rest of the export runs. A folder source replaces the destination's contents — the destination is wiped first, then the source tree is copied in. The exception is a blank destination, which resolves to the project root and merges instead (same-named files overwritten, unrelated files left alone) to avoid wiping the repo. A file source overwrites `destination/{filename}`. A non-blank destination that does not yet exist is created. Missing sources log a warning and are skipped. |
|
|
371
|
+
| method | `IsFile` | `public static bool IsFile(string path)` | 340 | Returns true if the `path` is for a file, otherwise false. |
|
|
372
|
+
| method | `GetAllFilesRecursively` | `internal static IEnumerable<string> GetAllFilesRecursively(string folderPath)` | 428 | Recursive find all files starting at root folder at path `folderPath` and return a list of absolute paths to those files. |
|
|
373
373
|
|
|
374
374
|
### GUILayoutTools
|
|
375
375
|
|
|
@@ -377,19 +377,19 @@ Helper methods for dealing with files/directories
|
|
|
377
377
|
internal static class GUILayoutTools
|
|
378
378
|
```
|
|
379
379
|
|
|
380
|
-
**Source:** `Assets/Package/PackageTool/Editor/Tools/GUILayoutTools.cs:34`
|
|
380
|
+
**Source:** `Assets/Package/PackageTool/Editor/Tools/GUILayoutTools.cs:34` (md5: `78a4d10c988a8fb4213b9f1f99eb6a0a`, lines: 187)
|
|
381
381
|
|
|
382
382
|
Helper methods for Unity Editor GUI.
|
|
383
383
|
|
|
384
384
|
**Members:**
|
|
385
385
|
|
|
386
|
-
| Kind | Name | Signature | Summary |
|
|
387
|
-
|
|
388
|
-
| method | `DrawFolderPicker` | `public static void DrawFolderPicker(Rect rect, SerializedProperty property, string title)` | Draw a folder picker button in `Rect` `rect` that allows setting a relative folder path value on `SerializedProperty` `property`. |
|
|
389
|
-
| method | `DrawSourceFolderPicker` | `public static void DrawSourceFolderPicker(Rect rect, SerializedProperty property, string title)` | |
|
|
390
|
-
| method | `DrawFilePicker` | `public static void DrawFilePicker(Rect rect, SerializedProperty property, string title)` | Draw a file picker button in `Rect` `rect` that allows setting a relative file path value on `SerializedProperty` `property`. |
|
|
391
|
-
| method | `DrawFolderPickerLayout` | `public static void DrawFolderPickerLayout(SerializedProperty property, string title)` | Draw a folder picker button using `GUILayout` that allows setting a relative folder path value on `SerializedProperty` `property`. |
|
|
392
|
-
| method | `DrawFilePickerLayout` | `public static void DrawFilePickerLayout(SerializedProperty property, string title)` | |
|
|
386
|
+
| Kind | Name | Signature | Line | Summary |
|
|
387
|
+
|------|------|-----------|------|---------|
|
|
388
|
+
| method | `DrawFolderPicker` | `public static void DrawFolderPicker(Rect rect, SerializedProperty property, string title)` | 43 | Draw a folder picker button in `Rect` `rect` that allows setting a relative folder path value on `SerializedProperty` `property`. |
|
|
389
|
+
| method | `DrawSourceFolderPicker` | `public static void DrawSourceFolderPicker(Rect rect, SerializedProperty property, string title)` | 68 | |
|
|
390
|
+
| method | `DrawFilePicker` | `public static void DrawFilePicker(Rect rect, SerializedProperty property, string title)` | 103 | Draw a file picker button in `Rect` `rect` that allows setting a relative file path value on `SerializedProperty` `property`. |
|
|
391
|
+
| method | `DrawFolderPickerLayout` | `public static void DrawFolderPickerLayout(SerializedProperty property, string title)` | 134 | Draw a folder picker button using `GUILayout` that allows setting a relative folder path value on `SerializedProperty` `property`. |
|
|
392
|
+
| method | `DrawFilePickerLayout` | `public static void DrawFilePickerLayout(SerializedProperty property, string title)` | 160 | |
|
|
393
393
|
|
|
394
394
|
### GitTools
|
|
395
395
|
|
|
@@ -397,17 +397,17 @@ Helper methods for Unity Editor GUI.
|
|
|
397
397
|
public static class GitTools
|
|
398
398
|
```
|
|
399
399
|
|
|
400
|
-
**Source:** `Assets/Package/PackageTool/Editor/Tools/GitTools.cs:33`
|
|
400
|
+
**Source:** `Assets/Package/PackageTool/Editor/Tools/GitTools.cs:33` (md5: `28905c1ccedf24ceeccd78f8d8403ac2`, lines: 66)
|
|
401
401
|
|
|
402
402
|
Helper methods for retrieving git information
|
|
403
403
|
|
|
404
404
|
**Members:**
|
|
405
405
|
|
|
406
|
-
| Kind | Name | Signature | Summary |
|
|
407
|
-
|
|
408
|
-
| method | `Run` | `public static string Run(string cmd)` | |
|
|
409
|
-
| method | `GetBranch` | `public static string GetBranch()` | |
|
|
410
|
-
| method | `GetLongHeadHash` | `public static string GetLongHeadHash()` | |
|
|
406
|
+
| Kind | Name | Signature | Line | Summary |
|
|
407
|
+
|------|------|-----------|------|---------|
|
|
408
|
+
| method | `Run` | `public static string Run(string cmd)` | 37 | |
|
|
409
|
+
| method | `GetBranch` | `public static string GetBranch()` | 56 | |
|
|
410
|
+
| method | `GetLongHeadHash` | `public static string GetLongHeadHash()` | 61 | |
|
|
411
411
|
|
|
412
412
|
### PackageJsonModel
|
|
413
413
|
|
|
@@ -415,13 +415,45 @@ Helper methods for retrieving git information
|
|
|
415
415
|
public class PackageJsonModel
|
|
416
416
|
```
|
|
417
417
|
|
|
418
|
-
**Source:** `Assets/Package/PackageTool/Editor/Tools/PackageJsonModel.cs:7`
|
|
418
|
+
**Source:** `Assets/Package/PackageTool/Editor/Tools/PackageJsonModel.cs:7` (md5: `68cbea367359a94287086f5d9a5da099`, lines: 149)
|
|
419
419
|
|
|
420
420
|
**Members:**
|
|
421
421
|
|
|
422
|
-
| Kind | Name | Signature | Summary |
|
|
423
|
-
|
|
424
|
-
| method | `CreateFromManifest` | `public static PackageJsonModel CreateFromManifest(PackageManifestConfig manifest)` | |
|
|
422
|
+
| Kind | Name | Signature | Line | Summary |
|
|
423
|
+
|------|------|-----------|------|---------|
|
|
424
|
+
| method | `CreateFromManifest` | `public static PackageJsonModel CreateFromManifest(PackageManifestConfig manifest)` | 28 | |
|
|
425
|
+
|
|
426
|
+
### Author
|
|
427
|
+
|
|
428
|
+
```csharp
|
|
429
|
+
public class Author
|
|
430
|
+
```
|
|
431
|
+
|
|
432
|
+
**Source:** `Assets/Package/PackageTool/Editor/Tools/PackageJsonModel.cs:84` (md5: `68cbea367359a94287086f5d9a5da099`, lines: 149)
|
|
433
|
+
|
|
434
|
+
### Repository
|
|
435
|
+
|
|
436
|
+
```csharp
|
|
437
|
+
public class Repository
|
|
438
|
+
```
|
|
439
|
+
|
|
440
|
+
**Source:** `Assets/Package/PackageTool/Editor/Tools/PackageJsonModel.cs:102` (md5: `68cbea367359a94287086f5d9a5da099`, lines: 149)
|
|
441
|
+
|
|
442
|
+
### Bugs
|
|
443
|
+
|
|
444
|
+
```csharp
|
|
445
|
+
public class Bugs
|
|
446
|
+
```
|
|
447
|
+
|
|
448
|
+
**Source:** `Assets/Package/PackageTool/Editor/Tools/PackageJsonModel.cs:118` (md5: `68cbea367359a94287086f5d9a5da099`, lines: 149)
|
|
449
|
+
|
|
450
|
+
### Sample
|
|
451
|
+
|
|
452
|
+
```csharp
|
|
453
|
+
public class Sample
|
|
454
|
+
```
|
|
455
|
+
|
|
456
|
+
**Source:** `Assets/Package/PackageTool/Editor/Tools/PackageJsonModel.cs:132` (md5: `68cbea367359a94287086f5d9a5da099`, lines: 149)
|
|
425
457
|
|
|
426
458
|
### PackageManifestTools
|
|
427
459
|
|
|
@@ -429,16 +461,16 @@ public class PackageJsonModel
|
|
|
429
461
|
internal static class PackageManifestTools
|
|
430
462
|
```
|
|
431
463
|
|
|
432
|
-
**Source:** `Assets/Package/PackageTool/Editor/Tools/PackageManifestTools.cs:34`
|
|
464
|
+
**Source:** `Assets/Package/PackageTool/Editor/Tools/PackageManifestTools.cs:34` (md5: `3b50f5153f243777d3bdfd5416053c5f`, lines: 77)
|
|
433
465
|
|
|
434
466
|
Helper methods for the Package Manifest Tools
|
|
435
467
|
|
|
436
468
|
**Members:**
|
|
437
469
|
|
|
438
|
-
| Kind | Name | Signature | Summary |
|
|
439
|
-
|
|
440
|
-
| method | `GenerateJson` | `public static string GenerateJson(PackageManifestConfig manifest)` | Returns a Json `string` representation of the `PackageManifestConfig` `manifest`. |
|
|
441
|
-
| method | `GetAllConfigs` | `public static PackageManifestConfig[] GetAllConfigs()` | Retrieves all `PackageManifestConfig` instances in the project. |
|
|
470
|
+
| Kind | Name | Signature | Line | Summary |
|
|
471
|
+
|------|------|-----------|------|---------|
|
|
472
|
+
| method | `GenerateJson` | `public static string GenerateJson(PackageManifestConfig manifest)` | 48 | Returns a Json `string` representation of the `PackageManifestConfig` `manifest`. |
|
|
473
|
+
| method | `GetAllConfigs` | `public static PackageManifestConfig[] GetAllConfigs()` | 57 | Retrieves all `PackageManifestConfig` instances in the project. |
|
|
442
474
|
|
|
443
475
|
### UnityFileTools
|
|
444
476
|
|
|
@@ -446,15 +478,15 @@ Helper methods for the Package Manifest Tools
|
|
|
446
478
|
internal static class UnityFileTools
|
|
447
479
|
```
|
|
448
480
|
|
|
449
|
-
**Source:** `Assets/Package/PackageTool/Editor/Tools/UnityFileTools.cs:36`
|
|
481
|
+
**Source:** `Assets/Package/PackageTool/Editor/Tools/UnityFileTools.cs:36` (md5: `defcab177b5aef78d56ff900f7fd5555`, lines: 132)
|
|
450
482
|
|
|
451
483
|
Helper methods for dealing with files/directories in the Unity Assets folder.
|
|
452
484
|
|
|
453
485
|
**Members:**
|
|
454
486
|
|
|
455
|
-
| Kind | Name | Signature | Summary |
|
|
456
|
-
|
|
457
|
-
| method | `CompileLegacyPackage` | `public static void CompileLegacyPackage(PackageManifestConfig config)` | Gather all of the files/folders for the package and export them to the pre-defined location at `legacyPackageDestinationPath`. |
|
|
487
|
+
| Kind | Name | Signature | Line | Summary |
|
|
488
|
+
|------|------|-----------|------|---------|
|
|
489
|
+
| method | `CompileLegacyPackage` | `public static void CompileLegacyPackage(PackageManifestConfig config)` | 43 | Gather all of the files/folders for the package and export them to the pre-defined location at `legacyPackageDestinationPath`. |
|
|
458
490
|
|
|
459
491
|
## `PackageTool.Utils.PackageInitialize`
|
|
460
492
|
|
|
@@ -466,7 +498,7 @@ The `Init Package` flow — `EditorWindow`, scaffold logic, and template strings
|
|
|
466
498
|
public static class PackageInitializeTemplates
|
|
467
499
|
```
|
|
468
500
|
|
|
469
|
-
**Source:** `Assets/Package/PackageTool/Editor/Utils/PackageInitialize/PackageInitializeTemplates.cs:5`
|
|
501
|
+
**Source:** `Assets/Package/PackageTool/Editor/Utils/PackageInitialize/PackageInitializeTemplates.cs:5` (md5: `b5c41fe3faf6bf6738eec298ef37a51d`, lines: 109)
|
|
470
502
|
|
|
471
503
|
### PackageInitializeUtil
|
|
472
504
|
|
|
@@ -474,17 +506,17 @@ public static class PackageInitializeTemplates
|
|
|
474
506
|
public static class PackageInitializeUtil
|
|
475
507
|
```
|
|
476
508
|
|
|
477
|
-
**Source:** `Assets/Package/PackageTool/Editor/Utils/PackageInitialize/PackageInitializeUtil.cs:7`
|
|
509
|
+
**Source:** `Assets/Package/PackageTool/Editor/Utils/PackageInitialize/PackageInitializeUtil.cs:7` (md5: `28d7079059d3379039c46b76c55dda71`, lines: 106)
|
|
478
510
|
|
|
479
511
|
**Members:**
|
|
480
512
|
|
|
481
|
-
| Kind | Name | Signature | Summary |
|
|
482
|
-
|
|
483
|
-
| field | `ASSETS_FOLDER_NAME` | `public const string ASSETS_FOLDER_NAME` | |
|
|
484
|
-
| field | `RELEASE_FOLDER_NAME` | `public const string RELEASE_FOLDER_NAME` | |
|
|
485
|
-
| method | `Init` | `public static void Init(string scope, PackageManifestConfig config)` | |
|
|
486
|
-
| method | `CreateFolderInProject` | `public static void CreateFolderInProject(string directoryPath)` | |
|
|
487
|
-
| method | `CreateFolderInAssets` | `public static void CreateFolderInAssets(string directoryPath)` | |
|
|
513
|
+
| Kind | Name | Signature | Line | Summary |
|
|
514
|
+
|------|------|-----------|------|---------|
|
|
515
|
+
| field | `ASSETS_FOLDER_NAME` | `public const string ASSETS_FOLDER_NAME` | 9 | |
|
|
516
|
+
| field | `RELEASE_FOLDER_NAME` | `public const string RELEASE_FOLDER_NAME` | 10 | |
|
|
517
|
+
| method | `Init` | `public static void Init(string scope, PackageManifestConfig config)` | 27 | |
|
|
518
|
+
| method | `CreateFolderInProject` | `public static void CreateFolderInProject(string directoryPath)` | 88 | |
|
|
519
|
+
| method | `CreateFolderInAssets` | `public static void CreateFolderInAssets(string directoryPath)` | 97 | |
|
|
488
520
|
|
|
489
521
|
### PackageInitializeWindow
|
|
490
522
|
|
|
@@ -492,11 +524,11 @@ public static class PackageInitializeUtil
|
|
|
492
524
|
public class PackageInitializeWindow : EditorWindow
|
|
493
525
|
```
|
|
494
526
|
|
|
495
|
-
**Source:** `Assets/Package/PackageTool/Editor/Utils/PackageInitialize/PackageInitializeWindow.cs:7`
|
|
527
|
+
**Source:** `Assets/Package/PackageTool/Editor/Utils/PackageInitialize/PackageInitializeWindow.cs:7` (md5: `1ddb72c8c48c828214f36cc5f88aa61e`, lines: 92)
|
|
496
528
|
**Base:** `EditorWindow`
|
|
497
529
|
|
|
498
530
|
**Members:**
|
|
499
531
|
|
|
500
|
-
| Kind | Name | Signature | Summary |
|
|
501
|
-
|
|
502
|
-
| method | `Open` | `public static void Open()` | |
|
|
532
|
+
| Kind | Name | Signature | Line | Summary |
|
|
533
|
+
|------|------|-----------|------|---------|
|
|
534
|
+
| method | `Open` | `public static void Open()` | 23 | |
|