LOOT API

Generated by Doxygen 1.8.10

Sat Sep 26 2015 08:36:12

CONTENTS

Contents
1

Main Page

1.1

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

1.2

Credits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

1.3

Version History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Data Structure Index

2.1

Data Structures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

File Index

3.1

File List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Data Structure Documentation

4.1

loot_message Struct Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

4.1.1

Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

4.1.2

Field Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

File Documentation

5.1

api.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

5.1.1

Detailed Description

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

5.1.2

Variable Types

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

5.1.3

Memory Management

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

5.1.4

Typedef Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

5.1.5

Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

5.1.6

Variable Documentation

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Index

13
17

Main Page

Author
WrinklyNinja
Version
0.8.1
Copyright
The LOOT API is distributed under the GNU General Public License v3.0. For the full text of the license, see
the "GNU GPL v3.txt" file included in the source archive.

1.1

Introduction

LOOT is a utility that helps users avoid serious conflicts between their mods by setting their plugins in an optimal
load order. It also provides tens of thousands of plugin-specific messages, including usage notes, requirements,

Generated on Sat Sep 26 2015 08:36:12 for LOOT API by Doxygen

CONTENTS

incompatibilities, bug warnings and installation mistake notifications, and thousands of Bash Tag suggestions.
This metadata that LOOT supplies is stored in its masterlist, which is maintained by the LOOT team using information provided by mod authors and users. Users can also add to and modify the metadata used by LOOT through
the use of userlist files. The LOOT API provides a way for third-party developers to access this metadata for use in
their own programs.
All further API documentation is contained within the documentation for api.h.

1.2

Credits

The LOOT API is written by WrinklyNinja in C/C++ and makes use of the Boost, libespm, libgit2,
libloadorder, Pseudosem and yaml-cpp libraries. Copyright license information for all these may be
found in the "docs/licenses/Licenses.txt" file.

1.3

Version History

0.8.1 - 27 September 2015

Fixed crash when loading plugins due to lack of thread safety.
Fixed masterlist updater and validator not checking for valid condition and regex syntax.
Check for safe file paths when parsing conditions.
Updated Boost (1.59.0), libgit2 (0.23.2) and CEF (branch 2454) dependencies. This fixes the masterlist
updater not working correctly for Windows Vista users.

0.8.0 - 22 July 2015

Fixed many miscellaneous bugs, including initialisation crashes and incorrect metadata input/output handling.
Fixed LOOT silently discarding some non-unique metadata: an error will now occur when loading or attempting to apply such metadata.
Fixed and improved LOOT's version comparison behaviour for a wide variety of version string formats. This
involved removing LOOT's usage of the Alphanum code library.
Improved plugin loading performance for computers with weaker multithreading capabilities (eg.
hyperthreaded dual-core or single-core CPUs).

non-

LOOT no longer outputs validity warnings for inactive plugins.

Metadata syntax support changes, see the metadata syntax document for details.
Updated libgit2 to v0.23.0.

0.7.1 - 22 June 2015

Fixed "No existing load order position" errors when sorting.
Fixed output of Bash Tag removal suggestions in loot_write_minimal_list().

0.7.0 - 20 May 2015

Initial API release.

Generated on Sat Sep 26 2015 08:36:12 for LOOT API by Doxygen

2 Data Structure Index

Data Structure Index

2.1

Data Structures

Here are the data structures with brief descriptions:

loot_message
A structure that holds the type of a message and the message string itself

File Index

3.1

File List

Here is a list of all documented files with brief descriptions:

api.h
This file contains the API frontend

Data Structure Documentation

4.1

loot_message Struct Reference

A structure that holds the type of a message and the message string itself.

#include <api.h>

Data Fields
unsigned int type
const char message

4.1.1

Detailed Description

A structure that holds the type of a message and the message string itself.

4.1.2

Field Documentation

4.1.2.1

message

The message string, which may be formatted using GitHub Flavored Markdown.
4.1.2.2

type

The type of the message, specified using one of the message type codes.
The documentation for this struct was generated from the following file:
api.h

File Documentation

Generated on Sat Sep 26 2015 08:36:12 for LOOT API by Doxygen

5.1

CONTENTS

api.h File Reference

This file contains the API frontend.

#include <stddef.h>
#include <stdbool.h>

Data Structures
struct loot_message
A structure that holds the type of a message and the message string itself.

Typedefs
typedef struct _loot_db_int loot_db
A structure that holds all game-specific data used by the API.

Functions
Error Handling Functions
unsigned int loot_get_error_message (const char const message)
Returns the message for the last error or warning encountered.

void loot_cleanup ()
Frees the memory allocated to the last error details string.

Version Functions
bool loot_is_compatible (const unsigned int versionMajor, const unsigned int versionMinor, const unsigned
int versionPatch)
Checks for API compatibility.

unsigned int loot_get_version (unsigned int const versionMajor, unsigned int const versionMinor, unsigned int const versionPatch)
Gets the API version.

unsigned int loot_get_build_id (const char const revision)

Get the Git revision of the code from which the binary was built.

Lifecycle Management Functions

unsigned int loot_create_db (loot_db const db, const unsigned int clientGame, const char const gamePath, const char const gameLocalPath)
Initialise a new database handle.

void loot_destroy_db (loot_db db)

Destroy an existing database handle.

Database Loading Functions

unsigned int loot_load_lists (loot_db db, const char const masterlistPath, const char const userlistPath)
Loads the masterlist and userlist from the paths specified.

unsigned int loot_eval_lists (loot_db db, const unsigned int language)

Evaluates all conditions and regular expression metadata entries.

LOOT Functionality Functions

unsigned int loot_sort_plugins (loot_db db, char const sortedPlugins, size_t const numPlugins)

Generated on Sat Sep 26 2015 08:36:12 for LOOT API by Doxygen

5.1

api.h File Reference

Calculates a new load order for the game's installed plugins (including inactive plugins) and outputs the sorted
order.

unsigned int loot_apply_load_order (loot_db db, const char const const loadOrder, const size_t numPlugins)
Applies the given load order.

unsigned int loot_update_masterlist (loot_db db, const char const masterlistPath, const char const
remoteURL, const char const remoteBranch, bool const updated)
Update the given masterlist.

unsigned int loot_get_masterlist_revision (loot_db db, const char const masterlistPath, const bool getShortID, char const revisionID, char const revisionDate, bool const isModified)
Get the given masterlist's revision.

Database Access Functions

unsigned int loot_get_tag_map (loot_db db, char const tagMap, size_t const numTags)
Outputs an array of the Bash Tags that are suggested in the database.

unsigned int loot_get_plugin_tags (loot_db db, const char const plugin, unsigned int const tags_added,
size_t const numTags_added, unsigned int const tags_removed, size_t const numTags_removed,
bool const userlistModified)
Outputs the Bash Tags suggested for addition and removal by the database for the given plugin.

unsigned int loot_get_plugin_messages (loot_db db, const char const plugin, loot_message const messages, size_t const numMessages)
Outputs the messages associated with the given plugin in the database.

unsigned int loot_get_dirty_info (loot_db db, const char const plugin, unsigned int const needsCleaning)
Determines the database's knowledge of a plugin's dirtiness.

unsigned int loot_write_minimal_list (loot_db db, const char const outputFile, const bool overwrite)
Writes a minimal metadata file that only contains plugins with Bash Tag suggestions and/or dirty info, plus the
suggestions and info themselves.

Variables
Return Codes
Error codes signify an issue that caused a function to exit prematurely. If a function exits prematurely, a reversal
of any changes made during its execution is attempted before it exits.

const unsigned int loot_ok

const unsigned int loot_error_liblo_error
const unsigned int loot_error_file_write_fail
const unsigned int loot_error_parse_fail
const unsigned int loot_error_condition_eval_fail
const unsigned int loot_error_regex_eval_fail
const unsigned int loot_error_no_mem
const unsigned int loot_error_invalid_args
const unsigned int loot_error_no_tag_map
const unsigned int loot_error_path_not_found
const unsigned int loot_error_no_game_detected
const unsigned int loot_error_git_error
const unsigned int loot_error_windows_error
const unsigned int loot_error_sorting_error
const unsigned int loot_return_max
Matches the value of the highest-numbered return code.

Game Codes
Used with loot_create_db().

const unsigned int loot_game_tes4

const unsigned int loot_game_tes5
const unsigned int loot_game_fo3
const unsigned int loot_game_fonv

Generated on Sat Sep 26 2015 08:36:12 for LOOT API by Doxygen

CONTENTS

Message Type Codes

Used with the loot_message structure.
const unsigned int loot_message_say
const unsigned int loot_message_warn
const unsigned int loot_message_error
Message Language Codes
Used with loot_eval_lists().

const unsigned int loot_lang_any

const unsigned int loot_lang_english
const unsigned int loot_lang_spanish
const unsigned int loot_lang_russian
const unsigned int loot_lang_french
const unsigned int loot_lang_chinese
const unsigned int loot_lang_polish
const unsigned int loot_lang_brazilian_portuguese
const unsigned int loot_lang_finnish
const unsigned int loot_lang_german
const unsigned int loot_lang_danish
const unsigned int loot_lang_korean

Plugin Cleanliness Codes

Used with loot_get_dirty_info().
const unsigned int loot_needs_cleaning_no
const unsigned int loot_needs_cleaning_yes
const unsigned int loot_needs_cleaning_unknown

5.1.1

Detailed Description

This file contains the API frontend.

Note
The LOOT API is not thread safe. Thread safety is a goal, but one that has not yet been achieved. Bear this
in mind if using it in a multi-threaded client.

5.1.2

Variable Types

The LOOT API uses character strings and integers for information input/output.
All strings are null-terminated byte character strings encoded in UTF-8.
All codes are unsigned integers at least 16 bits in size.
All array sizes are unsigned integers at least 16 bits in size.
File paths are case-sensitive if and only if the underlying file system is case-sensitive.

5.1.3

Memory Management

The LOOT API manages the memory of strings and arrays it returns, so such strings and arrays should not be
deallocated by the client.
Data returned by a function lasts until a function is called which returns data of the same type (eg. a string is
stored until the client calls another function which returns a string, an integer array lasts until another integer array
is returned, etc.).
All allocated memory is freed when loot_destroy_db() is called, except the string allocated by loot_get_error_message(), which must be freed by calling loot_cleanup().

Generated on Sat Sep 26 2015 08:36:12 for LOOT API by Doxygen

5.1

api.h File Reference

5.1.4

Typedef Documentation
typedef struct _loot_db_int loot_db

5.1.4.1

A structure that holds all game-specific data used by the API.

Types
Used to keep each game's data independent. Abstracts the definition of the API's internal state while still providing
type safety across the library. Multiple handles can also be made for each game, though it should be kept in mind
that the API is not thread-safe.

5.1.5

Function Documentation
unsigned int loot_apply_load_order ( loot_db db, const char const const loadOrder, const size_t numPlugins )

5.1.5.1

Applies the given load order.

Parameters
db
loadOrder
numPlugins

The database the function acts on.

An array of plugin filenames in the load order to be set.
The size of the inputted array.

Returns
A return code.

5.1.5.2

unsigned int loot_create_db ( loot_db const db, const unsigned int clientGame, const char const gamePath, const
char const gameLocalPath )

Initialise a new database handle.

Creates a handle for a database, which is then used by all database functions.
Parameters
db
clientGame
gamePath
gameLocalPath

A pointer to the handle that is created by the function.

A game code for which to create the handle.
The relative or absolute path to the game folder, or NULL. If NULL, the API will attempt to
detect the data path of the specified game.
The relative or absolute path to the game's folder in LOCALAPPDATA%, or NULL. If NULL, the API will attempt to look up the path that LOCALAPPDATA% corresponds to. This
parameter is provided so that systems lacking that environmental variable (eg. Linux) can
still use the API.

Returns
A return code.

5.1.5.3

void loot_destroy_db ( loot_db db )

Destroy an existing database handle.

Destroys the given database handle, freeing up memory allocated during its use, excluding any memory allocated
to error messages.

Generated on Sat Sep 26 2015 08:36:12 for LOOT API by Doxygen

CONTENTS

Parameters
db

5.1.5.4

The database handle to destroy.

unsigned int loot_eval_lists ( loot_db db, const unsigned int language )

Evaluates all conditions and regular expression metadata entries.

Repeated calls re-evaluate the metadata from scratch. This function affects the output of all the database access
functions.
Parameters
db
language

The database the function acts on.

The language code that is used for message language comparisons.

Returns
A return code.

5.1.5.5

unsigned int loot_get_build_id ( const char const revision )

Get the Git revision of the code from which the binary was built.
Parameters
revision

A pointer to the shortened Git revision ID string.

Returns
A return code.

5.1.5.6

unsigned int loot_get_dirty_info ( loot_db db, const char const plugin, unsigned int const needsCleaning )

Determines the database's knowledge of a plugin's dirtiness.

Outputs whether the plugin should be cleaned or not, or if no data is available. The mechanism used to determine
that a plugin should not be cleaned is not very reliable, and is likely to fail if loot_eval_lists() was called
with a language other than English. As such, some plugins that should not be cleaned may have the loot_needs_cleaning_unknown code outputted.
Parameters
db
plugin
needsCleaning

The database the function acts on.

The plugin to look up dirty status information for.
A pointer to a plugin cleanliness code.

Returns
A return code.

5.1.5.7

unsigned int loot_get_error_message ( const char const message )

Returns the message for the last error or warning encountered.

Outputs a string giving the a message containing the details of the last error or warning encountered by a function.
Each time this function is called, the memory for the previous message is freed, so only one error message is
available at any one time.

Generated on Sat Sep 26 2015 08:36:12 for LOOT API by Doxygen

5.1

api.h File Reference

Parameters
message

A pointer to the error details string outputted by the function.

Returns
A return code.

unsigned int loot_get_masterlist_revision ( loot_db db, const char const masterlistPath, const bool getShortID,
char const revisionID, char const revisionDate, bool const isModified )

5.1.5.8

Get the given masterlist's revision.

Getting a masterlist's revision is only possible if it is found inside a local Git repository.
Parameters
db
masterlistPath
getShortID
revisionID
revisionDate
isModified

The database the function acts on.

A string containing the relative or absolute path to the masterlist file that should be queried.
If true, the shortest unique hexadecimal revision hash that is at least 7 characters long will
be outputted. Otherwise, the full 40 character hash will be outputted.
A pointer to a string containing the outputted revision hash for the masterlist. If the masterlist
doesn't exist, or there is no Git repository at its location, this will be NULL.
A pointer to a string containing the ISO 8601 formatted revision date, ie. YYYY-MM-DD. If the
masterlist doesn't exist, or there is no Git repository at its location, this will be NULL.
A pointer to a boolean that is true if the masterlist has been edited since the outputted
revision, or false if it is at exactly the revision given.

Returns
A return code.

5.1.5.9

unsigned int loot_get_plugin_messages ( loot_db db, const char const plugin, loot_message const messages,
size_t const numMessages )

Outputs the messages associated with the given plugin in the database.
Parameters
db
plugin
messages
numMessages

The database the function acts on.

The filename of the plugin to look up messages for.
A pointer to the outputted array of messages associated with the specified plugin, given as
loot_message structures. NULL if the plugin has no messages associated with it.
A pointer to the size of the outputted array. If no messages are outputted, this will be 0.

Returns
A return code.

5.1.5.10

unsigned int loot_get_plugin_tags ( loot_db db, const char const plugin, unsigned int const tags_added,
size_t const numTags_added, unsigned int const tags_removed, size_t const numTags_removed, bool const
userlistModified )

Outputs the Bash Tags suggested for addition and removal by the database for the given plugin.
loot_get_tag_map() must be called before this to ensure that the Bash Tag UIDs outputted by this function can be
matched up to name strings.

Generated on Sat Sep 26 2015 08:36:12 for LOOT API by Doxygen

10

CONTENTS

Parameters
db
plugin
tags_added
numTags_added
tags_removed
numTags_removed
userlistModified

The database the function acts on.

The filename of the plugin to look up Bash Tag suggestions for.
A pointer to the outputted array of UIDs of the Bash Tags suggested for addition to the specified plugin. NULL if no Bash Tag additions are suggested.
A pointer to the size of the tags_added array. 0 if tags_added is NULL.
A pointer to the outputted array of UIDs of the Bash Tags suggested for removal from the
specified plugin. NULL if no Bash Tag removals are suggested.
A pointer to the size of the tags_removed array. 0 if tags_removed is null.

true if the Bash Tag suggestions were modified by the data in the userlist, false otherwise.

Returns
A return code.

5.1.5.11

unsigned int loot_get_tag_map ( loot_db db, char const tagMap, size_t const numTags )

Outputs an array of the Bash Tags that are suggested in the database.
This function must be called prior to calling loot_get_plugin_tags() to ensure that the latter can return the Tags using
the correct array indicies.
Parameters
db
tagMap

numTags

The database the function acts on.

A pointer to the outputted array of Bash Tags. The array functions as a map where the indicies
are the keys, allowing the API to use them as UIDs for Bash Tags instead of passing their
names as strings every time loot_get_plugin_tags() is called. If no Bash Tags are suggested,
this will be NULL.
A pointer to the size of the outputted array. If no Bash Tags are suggested, this will be 0.

Returns
A return code.

5.1.5.12

unsigned int loot_get_version ( unsigned int const versionMajor, unsigned int const versionMinor, unsigned int

const versionPatch )
Gets the API version.
Outputs the major, minor and patch version numbers for the loaded API. The version numbering used is major.minor.patch.
Parameters
versionMajor
versionMinor
versionPatch

A pointer to the major version number.

A pointer to the minor version number.
A pointer to the patch version number.

Returns
A return code.

5.1.5.13

bool loot_is_compatible ( const unsigned int versionMajor, const unsigned int versionMinor, const unsigned int
versionPatch )

Checks for API compatibility.

Generated on Sat Sep 26 2015 08:36:12 for LOOT API by Doxygen

5.1

api.h File Reference

11

Checks whether the loaded API is compatible with the given version of the API, abstracting API stability policy away
from clients. The version numbering used is major.minor.patch.

Generated on Sat Sep 26 2015 08:36:12 for LOOT API by Doxygen

12

CONTENTS

Parameters
versionMajor
versionMinor
versionPatch

The major version number to check.

The minor version number to check.
The patch version number to check.

Returns
True if the API versions are compatible, false otherwise.

5.1.5.14

unsigned int loot_load_lists ( loot_db db, const char const masterlistPath, const char const userlistPath )

Loads the masterlist and userlist from the paths specified.

Can be called multiple times, each time replacing the previously-loaded data.
Parameters
db
masterlistPath
userlistPath

The database the function acts on.

A string containing the relative or absolute path to the masterlist file that should be loaded.
A string containing the relative or absolute path to the userlist file that should be loaded, or
NULL. If NULL, no userlist will be loaded.

Returns
A return code.

5.1.5.15

unsigned int loot_sort_plugins ( loot_db db, char const sortedPlugins, size_t const numPlugins )

Calculates a new load order for the game's installed plugins (including inactive plugins) and outputs the sorted order.
Pulls metadata from the masterlist and userlist if they are loaded, and reads the contents of each plugin. No
changes are applied to the load order used by the game. This function does not load or evaluate the masterlist or
userlist.
Parameters
db
sortedPlugins
numPlugins

The database the function acts on.

A pointer to an array of plugin filenames in their sorted load order.
A pointer to the size of the outputted array.

Returns
A return code.

5.1.5.16

unsigned int loot_update_masterlist ( loot_db db, const char const masterlistPath, const char const remoteURL,
const char const remoteBranch, bool const updated )

Update the given masterlist.

Uses Git to update the given masterlist to a given remote. If the masterlist doesn't exist, this will create it. This
function also initialises a Git repository in the given masterlist's parent folder. If the masterlist was not already
up-to-date, it will be re-loaded, but not re-evaluated.
If a Git repository is already present, it will be used to perform a diff-only update, but if for any reason a fast-forward
merge update is not possible, the existing repository will be deleted and a new repository cloned from the given
remote.

Generated on Sat Sep 26 2015 08:36:12 for LOOT API by Doxygen

5.1

api.h File Reference

13

Parameters
db
masterlistPath

remoteURL
remoteBranch
updated

The database the function acts on.

A string containing the relative or absolute path to the masterlist file that should be updated.
The filename must match the filename of the masterlist file in the given remote repository,
otherwise it will not be updated correctly. Although LOOT itself expects this filename to be
"masterlist.yaml", the API does not check for any specific filename.
The URL of the remote from which to fetch updates. This can also be a relative or absolute
path to a local repository.
The branch of the remote from which to apply updates.
true if the masterlist was updated. false if no update was necessary, ie. it was already
up-to-date. If true, the masterlist will have been re-loaded, but will need to be re-evaluated
separately.

Returns
A return code.

5.1.5.17

unsigned int loot_write_minimal_list ( loot_db db, const char const outputFile, const bool overwrite )

Writes a minimal metadata file that only contains plugins with Bash Tag suggestions and/or dirty info, plus the
suggestions and info themselves.
Parameters
db
outputFile
overwrite

The database the function acts on.

The path to which the file shall be written.
If false and outputFile already exists, no data will be written. Otherwise, data will be
written.

Returns
A return code.

5.1.6
5.1.6.1

Variable Documentation
const unsigned int loot_error_condition_eval_fail

There was an error evaluating the conditionals in a metadata file.

5.1.6.2

const unsigned int loot_error_file_write_fail

A file could not be written to.

5.1.6.3

const unsigned int loot_error_git_error

An error occurred while performing a git operation (updating or getting the masterlist version).
5.1.6.4

const unsigned int loot_error_invalid_args

Invalid arguments were given for the function.

5.1.6.5

const unsigned int loot_error_liblo_error

There was an error in performing a load order operation.

5.1.6.6

const unsigned int loot_error_no_game_detected

The given game could not be found.

Generated on Sat Sep 26 2015 08:36:12 for LOOT API by Doxygen

14

5.1.6.7

CONTENTS

const unsigned int loot_error_no_mem

The API was unable to allocate the required memory.

5.1.6.8

const unsigned int loot_error_no_tag_map

No Bash Tag map has been generated yet.

5.1.6.9

const unsigned int loot_error_parse_fail

There was an error parsing the file.

5.1.6.10

const unsigned int loot_error_path_not_found

A file or folder path could not be found.

5.1.6.11

const unsigned int loot_error_regex_eval_fail

There was an error evaluating the regular expressions in a metadata file.

5.1.6.12

const unsigned int loot_error_sorting_error

An error occurred while sorting plugins.

5.1.6.13

const unsigned int loot_error_windows_error

An error occurred during a call to the Windows API.

5.1.6.14

const unsigned int loot_game_fo3

Game code for Fallout 3.

5.1.6.15

const unsigned int loot_game_fonv

Game code for Fallout: New Vegas.

5.1.6.16

const unsigned int loot_game_tes4

Game code for The Elder Scrolls IV: Oblivion.

5.1.6.17

const unsigned int loot_game_tes5

Game code for The Elder Scrolls V: Skyrim.

5.1.6.18

const unsigned int loot_lang_any

Tells the API to select messages of any language.

5.1.6.19

const unsigned int loot_lang_brazilian_portuguese

Tells the API to preferentially select Brazilian Portuguese messages.

5.1.6.20

const unsigned int loot_lang_chinese

Tells the API to preferentially select Chinese messages.

5.1.6.21

const unsigned int loot_lang_danish

Tells the API to preferentially select Danish messages.

Generated on Sat Sep 26 2015 08:36:12 for LOOT API by Doxygen

5.1

api.h File Reference

5.1.6.22

const unsigned int loot_lang_english

Tells the API to preferentially select English messages.

5.1.6.23

const unsigned int loot_lang_finnish

Tells the API to preferentially select Finnish messages.

5.1.6.24

const unsigned int loot_lang_french

Tells the API to preferentially select French messages.

5.1.6.25

const unsigned int loot_lang_german

Tells the API to preferentially select German messages.

5.1.6.26

const unsigned int loot_lang_korean

Tells the API to preferentially select Korean messages.

5.1.6.27

const unsigned int loot_lang_polish

Tells the API to preferentially select Polish messages.

5.1.6.28

const unsigned int loot_lang_russian

Tells the API to preferentially select Russian messages.

5.1.6.29

const unsigned int loot_lang_spanish

Tells the API to preferentially select Spanish messages

5.1.6.30

const unsigned int loot_message_error

Denotes an error message.

5.1.6.31

const unsigned int loot_message_say

Denotes a generic note-type message.

5.1.6.32

const unsigned int loot_message_warn

Denotes a warning message.

5.1.6.33

const unsigned int loot_needs_cleaning_no

Denotes that the plugin queried does not need cleaning.

5.1.6.34

const unsigned int loot_needs_cleaning_unknown

Denotes that the API is unable to determine whether or not the plugin queried needs cleaning.
5.1.6.35

const unsigned int loot_needs_cleaning_yes

Denotes that the plugin queried needs cleaning.

5.1.6.36

const unsigned int loot_ok

The function completed successfully.

Generated on Sat Sep 26 2015 08:36:12 for LOOT API by Doxygen

15

16

5.1.6.37

CONTENTS

const unsigned int loot_return_max

Matches the value of the highest-numbered return code.

Provided in case clients wish to incorporate additional return codes in their implementation and desire some method
of avoiding value conflicts.

Generated on Sat Sep 26 2015 08:36:12 for LOOT API by Doxygen

Index
api.h, 4
loot_apply_load_order, 7
loot_create_db, 7
loot_db, 7
loot_destroy_db, 7
loot_error_condition_eval_fail, 13
loot_error_file_write_fail, 13
loot_error_git_error, 13
loot_error_invalid_args, 13
loot_error_liblo_error, 13
loot_error_no_game_detected, 13
loot_error_no_mem, 13
loot_error_no_tag_map, 14
loot_error_parse_fail, 14
loot_error_path_not_found, 14
loot_error_regex_eval_fail, 14
loot_error_sorting_error, 14
loot_error_windows_error, 14
loot_eval_lists, 8
loot_game_fo3, 14
loot_game_fonv, 14
loot_game_tes4, 14
loot_game_tes5, 14
loot_get_build_id, 8
loot_get_dirty_info, 8
loot_get_error_message, 8
loot_get_masterlist_revision, 9
loot_get_plugin_messages, 9
loot_get_plugin_tags, 9
loot_get_tag_map, 10
loot_get_version, 10
loot_is_compatible, 10
loot_lang_any, 14
loot_lang_brazilian_portuguese, 14
loot_lang_chinese, 14
loot_lang_danish, 14
loot_lang_english, 14
loot_lang_finnish, 15
loot_lang_french, 15
loot_lang_german, 15
loot_lang_korean, 15
loot_lang_polish, 15
loot_lang_russian, 15
loot_lang_spanish, 15
loot_load_lists, 12
loot_message_error, 15
loot_message_say, 15
loot_message_warn, 15
loot_needs_cleaning_no, 15
loot_needs_cleaning_unknown, 15
loot_needs_cleaning_yes, 15
loot_ok, 15
loot_return_max, 15
loot_sort_plugins, 12
loot_update_masterlist, 12

loot_write_minimal_list, 13
loot_apply_load_order
api.h, 7
loot_create_db
api.h, 7
loot_db
api.h, 7
loot_destroy_db
api.h, 7
loot_error_condition_eval_fail
api.h, 13
loot_error_file_write_fail
api.h, 13
loot_error_git_error
api.h, 13
loot_error_invalid_args
api.h, 13
loot_error_liblo_error
api.h, 13
loot_error_no_game_detected
api.h, 13
loot_error_no_mem
api.h, 13
loot_error_no_tag_map
api.h, 14
loot_error_parse_fail
api.h, 14
loot_error_path_not_found
api.h, 14
loot_error_regex_eval_fail
api.h, 14
loot_error_sorting_error
api.h, 14
loot_error_windows_error
api.h, 14
loot_eval_lists
api.h, 8
loot_game_fo3
api.h, 14
loot_game_fonv
api.h, 14
loot_game_tes4
api.h, 14
loot_game_tes5
api.h, 14
loot_get_build_id
api.h, 8
loot_get_dirty_info
api.h, 8
loot_get_error_message
api.h, 8
loot_get_masterlist_revision
api.h, 9
loot_get_plugin_messages

18

api.h, 9
loot_get_plugin_tags
api.h, 9
loot_get_tag_map
api.h, 10
loot_get_version
api.h, 10
loot_is_compatible
api.h, 10
loot_lang_any
api.h, 14
loot_lang_brazilian_portuguese
api.h, 14
loot_lang_chinese
api.h, 14
loot_lang_danish
api.h, 14
loot_lang_english
api.h, 14
loot_lang_finnish
api.h, 15
loot_lang_french
api.h, 15
loot_lang_german
api.h, 15
loot_lang_korean
api.h, 15
loot_lang_polish
api.h, 15
loot_lang_russian
api.h, 15
loot_lang_spanish
api.h, 15
loot_load_lists
api.h, 12
loot_message, 3
message, 3
type, 3
loot_message_error
api.h, 15
loot_message_say
api.h, 15
loot_message_warn
api.h, 15
loot_needs_cleaning_no
api.h, 15
loot_needs_cleaning_unknown
api.h, 15
loot_needs_cleaning_yes
api.h, 15
loot_ok
api.h, 15
loot_return_max
api.h, 15
loot_sort_plugins
api.h, 12
loot_update_masterlist
api.h, 12

INDEX

loot_write_minimal_list
api.h, 13
message
loot_message, 3
type
loot_message, 3

Generated on Sat Sep 26 2015 08:36:12 for LOOT API by Doxygen