Audio Player Module

Overview

The AudioPlayer module provides functionalities to control and manage the state of the RELICSxyz Audio Player in Roblox. It offers methods to toggle the visibility of the player, expand or collapse sections, show favorites, and activate the search functionality.


Services

  • RelicsXYZ: The main parent of the audio player, serving as the primary reference point for UI components.


Data Structures

  • isPlaylistExpanded: A boolean indicating if the playlist section of the player is expanded.

  • isTracklistExpanded: A boolean indicating if the tracklist section of the player is expanded.

  • showFavorites: A boolean indicating if the player is currently displaying favorite tracks.

  • isSearchActive: A boolean indicating if the search functionality is active.


Functions

  • IsPlaylistExpanded():

    • Returns: boolean

    • Indicates if the playlist is expanded.

  • IsTracklistExpanded():

    • Returns: boolean

    • Indicates if the tracklist is expanded.

  • IsShowingFavorites():

    • Returns: boolean

    • Indicates if the player is showing favorite tracks.

  • IsSearchActive():

    • Returns: boolean

    • Indicates if the search functionality is active.

  • ToggleVisibility():

    • Toggles the visibility of the main audio player frame.

  • TogglePlaylistVisibility():

    • Toggles the expansion state of the playlist section.

  • ToggleTracklistVisibility():

    • Toggles the expansion state of the tracklist section.

  • ToggleFavorites():

    • Toggles between showing favorite tracks and regular tracks.

  • ToggleSearch():

    • Activates or deactivates the search functionality.


Usage

To use the AudioPlayer module in another script:


Notes

The AudioPlayer module provides a comprehensive set of functionalities to control the visibility and state of the RELICSxyz Audio Player. It abstracts the complexities of managing the player's state, making it easier for developers to integrate and control the audio player's features in their Roblox projects.

Last updated