Open main menu

Changes

Documentation/Engine/Units/package version info

1,076 bytes added, 20:13, 17 February 2017
Using new 'UnitDef' template
'''Package version info ''' is a [[Documentation/Engine/Units|unit ]] containing version informations workshop mod package information, such like as the name of the folder or archive with content and the array of compatible game versions. It is used in each workshop mod's [[Documentation/Tools/SCS_Workshop_Uploader/versions.sii|versions.sii]].
The == Special Case: Universal Version ==Each workshop mod's versions.sii file may have a ''single'' package version info without any defined compatible_versions is , called the “universal version. This version ” The associated package will be used for all game versions that are not explictly defined by another package version info unit inside the versions.sii file. '''package_version_info unit attributes:'''
== Attributes ==
{| class="wikitable"
!|Type
!|Name
!|[[Documentation/Engine/Units#Attribute_types|Type]]
!|Required/Optional
!|Description
|-
|string
|package_name
|style="text-align:center;"|string|style="text-align:center;"|Required|The name of the folder or archive with the version-specific mod content. This For zip archives, package_name is required attributejust the file name without the extension.
|-
|string array
|compatible_versions
|style="text-align:center;"|string array|style="text-align:center;"|Optional|The array containg set of versions that are compatible with this version definition. This attribute is optional, if If not specified this version package will be used for all of the game versions - you not explicitly defined for other packages. <BR />'''Important:''' Each workshop mod's versions.sii can only have contain ''one '' `package_version_info` with unit without this parameter not specified in versions.sii|-|informational|style="text-align:center;"|bool|style="text-align:center;"|Optional|When true, indicates that the package contains information only. If unspecified, defaults to false.
|}
{{UnitDef|def=<nowiki> "package_version_info":{
"superclass":"unit",
"attrs":{
"package_name":{
"type": "string"
},
"compatible_versions":{
"type": "string_array"
},
"informational":{
"type": "bool"
}
}</nowiki>}}
[[Category:Documentation]][[Category:Units]]== See Also ==[[CategoryTutorials/SCS_Workshop_Uploader/How_to_use_mod_versioning|Tutorial:SCS Workshop UploaderHow to Use Mod Versioning]]
309
edits