Module commonapi.repos

Repository interface module.

Holds information of game elements like tracks, streets, bridges, tunnels, crossings

Info:

  • Copyright: 2017-2019
  • Author: Oskar Eisemuth

Class Repository

repoobj.getCount () Get count of Entries.
repoobj.getEntries () Return entries.
repoobj.getEntriesFiltered (filters) Return filteded entries.
repoobj.getById (id) Return entry by id.
repoobj.getByName (name) Return entry by name.

Repository Interface

track Track repository
street Street repository
bridge Bridge repository
tunnel Tunnel repository
railroadCrossing Railroad crossing repository

Repos Types

repoentry A repo entry.


Class Repository

Repository Object. Object accessed by repository interface
repoobj.getCount ()
Get count of Entries.
repoobj.getEntries ()
Return entries.

Returns:

    {repoentry,...}
repoobj.getEntriesFiltered (filters)
Return filteded entries.

Parameters:

  • filters {function,...} A list of filters to apply

Returns:

    {repoentry,...}
repoobj.getById (id)
Return entry by id.

Parameters:

  • id integer Id of entry

Returns:

    repoentry Entry
repoobj.getByName (name)
Return entry by name.

Parameters:

Returns:

    repoentry Entry

Repository Interface

Public interface to get specific repositories.
track
Track repository
street
Street repository
bridge
Bridge repository
tunnel
Tunnel repository
railroadCrossing
Railroad crossing repository

See also:

Repos Types

repoentry
A repo entry. Item returned by repository functions

Fields:

  • filename filename (without path)
  • id internal id
  • data Data or nil
generated by LDoc 1.4.6 Last updated 2019-03-10 15:12:25