"privileges" container
From TrainzOnline
(Difference between revisions)
Jamesmoody (Talk | contribs) m |
m (Remove reference to DRM; the container as a whole basically has nothing to do with DRM (the 'is-payware-content' being the exception.)) |
||
| (5 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
| − | The privileges container is a top-level [[config.txt file]] entry used by [[KIND TrainzBaseSpec]] and all derived assets. | + | {{ORP-top}}The privileges container is a top-level [[config.txt file]] entry used by [[KIND TrainzBaseSpec]] and all derived assets. |
==Supported Tags== | ==Supported Tags== | ||
| Line 10: | Line 10: | ||
permit-edit 1 | permit-edit 1 | ||
permit-listing 1 | permit-listing 1 | ||
| + | is-payware-content 0 | ||
} | } | ||
| − | It should be noted that this container only takes effect when content is packaged for distribution with Trainz or an official Trainz addon pack. | + | It should be noted that, with the exception of permit-listing, this container only takes effect when content is packaged for distribution with Trainz or an official Trainz addon pack. |
====permit-commit==== | ====permit-commit==== | ||
| Line 26: | Line 27: | ||
:Desc: Controls whether the asset shows in in-game listings. The asset will always show in [[Content Manager]] listings, regardless of this setting. | :Desc: Controls whether the asset shows in in-game listings. The asset will always show in [[Content Manager]] listings, regardless of this setting. | ||
| + | ====is-payware-content==== | ||
| + | :Type: Boolean | ||
| + | :Desc: Indicates whether the asset is an N3V-distributed payware asset. This is not related to the licensing of the asset, but instead is a technical copy-protection mechanism. Setting this flag causes the game to expect that certain file types within the asset will be in special payware-specific file formats. The setting of this flag must match the actual format of the included files, or the game will be unable to load the files. When this flag is set, the asset is considered payware and requires purchase authorisation before the user is able to utilise the asset in-game. | ||
==Example privileges container== | ==Example privileges container== | ||
| Line 31: | Line 35: | ||
''TBD'' | ''TBD'' | ||
| − | [[Category:Config Container]] | + | [[Category:Config Container|privileges]] |
| + | [[Category:TBD]] | ||
| + | {{ORP-bot|privileges}} | ||
Latest revision as of 15:23, 16 August 2016
The privileges container is a top-level config.txt file entry used by KIND TrainzBaseSpec and all derived assets.
Contents |
[edit] Supported Tags
The privileges container supports the following tags. Each tag is show here with its default value.
privileges
{
permit-commit 1
permit-edit 1
permit-listing 1
is-payware-content 0
}
It should be noted that, with the exception of permit-listing, this container only takes effect when content is packaged for distribution with Trainz or an official Trainz addon pack.
[edit] permit-commit
- Type: Boolean
- Desc: Controls whether local modifications to this asset can be committed. Note: base assets can never have modifications committed in order to prevent corruption of the core program.
[edit] permit-edit
- Type: Boolean
- Desc: Controls whether a user may open this asset for editing. This is mainly used to prevent simple viewing of content which resides in archive files, where the content creator wishes to protect their techniques against prying eyes.
[edit] permit-listing
- Type: Boolean
- Desc: Controls whether the asset shows in in-game listings. The asset will always show in Content Manager listings, regardless of this setting.
[edit] is-payware-content
- Type: Boolean
- Desc: Indicates whether the asset is an N3V-distributed payware asset. This is not related to the licensing of the asset, but instead is a technical copy-protection mechanism. Setting this flag causes the game to expect that certain file types within the asset will be in special payware-specific file formats. The setting of this flag must match the actual format of the included files, or the game will be unable to load the files. When this flag is set, the asset is considered payware and requires purchase authorisation before the user is able to utilise the asset in-game.
[edit] Example privileges container
TBD
