addonscript-spec/docs/schema/relation.md

33 lines
849 B
Markdown
Raw Normal View History

2021-06-23 22:06:21 +02:00
# Relation Object
```json
{
"id": "namespace:othermod",
"version": "[1.0,)",
"flags": [],
"conditions": {}
2021-06-23 22:06:21 +02:00
}
```
## Required properties
### id
2021-07-18 12:32:57 +02:00
This is the ID or namespaced ID of the addon this relation refers to.
2021-06-23 22:06:21 +02:00
### version
This is a [maven version range](https://maven.apache.org/enforcer/enforcer-rules/versionRanges.html) of supported versions of this relation.
## Optional properties
### flags
This is an array of [flags](../flags.md) for this relation. If this property is not present in a relation object, the relation
2021-07-18 12:32:57 +02:00
will have the flags which are set as default for relations or, if no default was set, it will inherit the flags
which are applicable for relations from the associated version.
### conditions
This is a [conditions object](conditions.md). It can only be used, if the [optional flag](../flags.md) was set.