Skip to content

albumactions.ts

github-actions[bot] edited this page Feb 4, 2024 · 6 revisions

Constants

actionsHTML : string

Represents the album actions HTML code.

Functions

albumLink(element)void

Assigns a link to given element based on the album's PAGENAME. Expects external 'albumLinkGen()' function which returns the PAGENAME of the album.

albumItemType()string

Sets the output value for the album item type (the part directly behind the civ in the heading).

albumDesc()undefined

Updates the album description element on MT pages (after the album macro, used for MT pages).

albumDiscoverer()string

A function that retrieves information about the discoverer of an album.

albumName()void

Sets the name of the album in the global output element.

albumOther()void

Populates the "other" parameter in the album.

albumType()string

Sets the album type in the heading before the "entry".

updateAlbumData()

Updates the album data in the UI based on the page data.

albumFunctions()void

This function contains several sub-functions which are called only when the album is completely loaded. If the album is already loaded, then the sub-functions will execute immediately. If not, the function listens for the 'albumLoaded' event to trigger and then executes the sub-functions.

albumData()void

Calls all functions related to album creation and updating.

actionsHTML : string

Represents the album actions HTML code.

Kind: global constant

albumLink(element) ⇒ void

Assigns a link to given element based on the album's PAGENAME. Expects external 'albumLinkGen()' function which returns the PAGENAME of the album.

Kind: global function

Param Type Description
element Element

The element to assign the link to.

albumItemType() ⇒ string

Sets the output value for the album item type (the part directly behind the civ in the heading).

Kind: global function
Returns: string -

The type of album item.


albumDesc() ⇒ undefined

Updates the album description element on MT pages (after the album macro, used for MT pages).

Kind: global function

albumDiscoverer() ⇒ string

A function that retrieves information about the discoverer of an album.

Kind: global function
Returns: string -

  • Returns the discoverer of an album, or a link to the wiki page if available.
**Example** ```js // Sample usage albumDiscoverer(); ```

albumName() ⇒ void

Sets the name of the album in the global output element.

Kind: global function

albumOther() ⇒ void

Populates the "other" parameter in the album.

Kind: global function

albumType() ⇒ string

Sets the album type in the heading before the "entry".

Kind: global function
Returns: string -

The album type.


updateAlbumData()

Updates the album data in the UI based on the page data.

Kind: global function

albumFunctions() ⇒ void

This function contains several sub-functions which are called only when the album is completely loaded. If the album is already loaded, then the sub-functions will execute immediately. If not, the function listens for the 'albumLoaded' event to trigger and then executes the sub-functions.

Kind: global function

albumData() ⇒ void

Calls all functions related to album creation and updating.

Kind: global function