SliderCanvasTypeSettings - jimdroberts/FishMMO GitHub Wiki

Description

The SliderCanvasTypeSettings class is a canvas type settings handler for Unity's Slider component in the FishMMO client. It applies color settings from a configuration file to the slider's color states, enabling consistent theming and easy customization of slider appearance.


API Access

Methods

  • public override void ApplySettings(object component, Configuration configuration)

    Applies color settings from configuration to the given Slider component. Sets the slider's normal, pressed, and highlighted colors using values parsed from the configuration.


Basic Usage

Setup

  1. Ensure SliderCanvasTypeSettings is registered in your canvas settings map for Slider components.
  2. Store color values (Primary, Secondary, Highlight) in your configuration file.
  3. When ApplySettings is called, the slider's color states will be updated according to the configuration.

Example

// Example usage in a canvas crawler or theming system:
var slider = myGameObject.GetComponent<Slider>();
var settings = new SliderCanvasTypeSettings();
settings.ApplySettings(slider, configuration);

Best Practices

  • Store all color values in a configuration file for easy theme changes.
  • Use SliderCanvasTypeSettings to centralize and automate slider theming across your UI.
  • Register this handler in your canvas settings map to ensure all sliders are themed consistently.
  • Extend or override for custom slider behavior or additional color states if needed.
  • Validate component types in ApplySettings to avoid runtime errors.
⚠️ **GitHub.com Fallback** ⚠️