mirror of
https://github.com/loot/libloot.git
synced 2026-07-27 14:16:01 -07:00
39 lines
883 B
ReStructuredText
39 lines
883 B
ReStructuredText
Location
|
|
========
|
|
|
|
This data structure is used to hold information on where a plugin is hosted online. It has two forms: a key-value string map and a scalar string.
|
|
|
|
Map Form
|
|
--------
|
|
|
|
.. describe:: link
|
|
|
|
**Required.** A URL at which the plugin is found.
|
|
|
|
.. describe:: name
|
|
|
|
A descriptive name for the URL, which may be used as hyperlink text. If undefined, defaults to an empty string.
|
|
|
|
Scalar Form
|
|
-----------
|
|
|
|
The scalar form is simply the value of the map form's ``link`` key. Using the scalar form is equivalent to using the map form with an undefined ``name`` key.
|
|
|
|
Equality
|
|
--------
|
|
|
|
Two location data structures are equal if all their fields are equal. Field
|
|
equality is case-sensitive.
|
|
|
|
Examples
|
|
--------
|
|
|
|
Scalar form::
|
|
|
|
'https://www.nexusmods.com/skyrim/mods/71214'
|
|
|
|
Map form::
|
|
|
|
link: 'https://www.nexusmods.com/skyrim/mods/71214'
|
|
name: 'USLEEP on Skyrim Nexus'
|