Backbone - Localization
 
Loading...
Searching...
No Matches
Backbone::LocalizedSpriteRenderer Class Reference

Automatically updates a SpriteRenderer component with a localized sprite from the LocalizationManager based on the current language. More...

Inheritance diagram for Backbone::LocalizedSpriteRenderer:

Public Attributes

LocalizedSprite localizedSprite
 Localized sprite definition (can use a key or inline values).
 

Private Member Functions

void Awake ()
 
void OnEnable ()
 
void OnDisable ()
 
void UpdateSprite ()
 Updates the SpriteRenderer's sprite using the localized value from the manager.
 

Private Attributes

SpriteRenderer spriteRenderer
 

Detailed Description

Automatically updates a SpriteRenderer component with a localized sprite from the LocalizationManager based on the current language.

This component allows runtime localization of 2D sprites in the scene, supporting both key-based and inline sprite definitions.

Usage:

  1. Attach this component to a GameObject with a SpriteRenderer.
  2. Set the localizedSprite in the Inspector (using a key or inline values).
  3. When the language changes, the sprite will update automatically.

Example:

  • localizationKey = "characters.robot.icon"
  • English: robot_icon_en.png
  • Spanish: robot_icon_es.png

Notes:

  • Requires a SpriteRenderer component.
  • If the key is not found or no sprite is defined, a warning is logged.

Member Function Documentation

◆ Awake()

void Backbone::LocalizedSpriteRenderer::Awake ( )
private

◆ OnDisable()

void Backbone::LocalizedSpriteRenderer::OnDisable ( )
private

◆ OnEnable()

void Backbone::LocalizedSpriteRenderer::OnEnable ( )
private

◆ UpdateSprite()

void Backbone::LocalizedSpriteRenderer::UpdateSprite ( )
private

Updates the SpriteRenderer's sprite using the localized value from the manager.

Member Data Documentation

◆ localizedSprite

LocalizedSprite Backbone::LocalizedSpriteRenderer::localizedSprite

Localized sprite definition (can use a key or inline values).

◆ spriteRenderer

SpriteRenderer Backbone::LocalizedSpriteRenderer::spriteRenderer
private

The documentation for this class was generated from the following file: