addonscript/addonscript-spec
addonscript/addonscript-spec
1
1
Fork 2
Code Issues 3 Pull requests 1 Projects Releases 3 Wiki Activity
addonscript-spec/docs/concepts/flags.md
Timo Ley 2a3d340b20
All checks were successful
continuous-integration/drone/push Build is passing
Details
Improve included flag specification
2022-06-10 23:57:15 +02:00

2.5 KiB
Raw Blame History

Flags

Side flags

These are flags, which specify, for which side a version, a file or a relation was made. If a file has no side flags set, it will inherit them from the version object, while a version is required to have side flags set.

  • client This flag specifies, that the version, relation or file can be installed on the client side
  • server This flag specifies, that the version, relation or file can be installed on the server side

Version flags

These are flags, which can be set for versions.

  • instance This flag specifies, that this is a version of an instance addon. Instance addons represent instances of Minecraft itself, while non-instance addons have to be installed into an existing instance of Minecraft.

Relational flags

These are flags, which describe the relation between the addon and related addons or files.

  • required This flag specifies, that the related addon or file is required for the addon. If the addon gets installed, than any relation or file, which has this flag set, also has to be installed.
  • optional This flag specifies, that the related addon or file is optional for this addon. If the addon gets installed, the user should be able to choose, whether he wants to install the relation or file with this flag, or not.

Relation specific

These are relational flags, which can only be used for relations.

  • included This flag specifies, that the related addon is included in this one. This also means, that if some addon requires the related addon, it can also be installed with this addon instead. Relations with this flag must have an exact version specified, a version range, which includes multiple versions is not allowed. If this flag is used together with required or optional, the files of the related addon will be installed like if the relation wouldn't have this flag, relations of the related addon will however be ignored since AddonScript assumes, that they are already covered by this addon.
  • incompatible This flag specifies, that the related addon is incompatible to this one. This means, that they can't be installed together in the same instance.
  • launch This flag specifies, that the related addon should take care of the Minecraft launch process. It can only be used, if both this and the related addon are instance addons.