Function __global->get_effect_settings

Definitions

sources/chat_sounds.php

  • Get a list of template mappings for the current member, between sound effect IDs and the URLs to the mp3 files.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: array

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$full_urls boolean No No False N/A N/A Whether to use full URLs in the mappings
$for_member ?MEMBER No No Null N/A N/A Get settings overridden for this specific member (null: global settings)
$all_members boolean No No False N/A N/A Get global settings and settings overridden for all members (if this is true we'd expect $for_member to be null)

Returns

  • The template mappings
  • Type: array
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Get a list of template mappings for the current member, between sound effect IDs and the URLs to the mp3 files.
 *
 * @param  boolean $full_urls Whether to use full URLs in the mappings
 * @param  ?MEMBER $for_member Get settings overridden for this specific member (null: global settings)
 * @param  boolean $all_members Get global settings and settings overridden for all members (if this is true we'd expect $for_member to be null)
 * @return array The template mappings
 */
function get_effect_settings(bool $full_urls = false, ?int $for_member = null, bool $all_members = false) : array