reldens/lib/actions/client/plugin.js

Reldens - MMORPG Platform

/**
 *
 * Reldens - ActionsPlugin
 *
 * Main functionalities:
 * The ActionsPlugin class is responsible for setting up and managing the actions plugin for the Reldens game engine.
 * It listens to various events and sets up the necessary components for the actions plugin to work, such as the player
 * selector, preloader handler, and UI manager. It also handles message processing and enriching the game manager with
 * the necessary skills and receivers.
 *
 * Methods:
 * - setup(props): sets up the plugin by initializing the necessary components and listening to events.
 * - setTranslations(): sets up translations for the plugin using the TranslationsMapper class.
 * - listenEvents(): listens to various events and sets up the necessary components for the plugin to work.
 *
 * Fields:
 * - gameManager: the game manager instance.
 * - events: the events manager instance.
 * - playerSelector: an instance of the PlayerSelector class.
 * - preloaderHandler: an instance of the PreloaderHandler class.
 * - uiManager: an instance of the SkillsUi class.
 *
 */

const { SkillsUi } = require('./skills-ui');
const { PluginInterface } = require('../../features/plugin-interface');
const { PlayerSelector } = require('./player-selector');
const { PreloaderHandler } = require('./preloader-handler');
const { MessagesHandler } = require('./messages-handler');
const { GameManagerEnricher } = require('./game-manager-enricher');
const Translations = require('./snippets/en_US');
const { TranslationsMapper } = require('../../snippets/client/translations-mapper');
const { ActionsConst } = require('../constants');
const { Logger, sc } = require('@reldens/utils');

class ActionsPlugin extends PluginInterface
{

    setup(props)
    {
        this.gameManager = sc.get(props, 'gameManager', false);
        if(!this.gameManager){
            Logger.error('Game Manager undefined in ActionsPlugin.');
        }
        this.events = sc.get(props, 'events', false);
        if(!this.events){
            Logger.error('EventsManager undefined in ActionsPlugin.');
        }
        this.playerSelector = new PlayerSelector(props);
        this.preloaderHandler = new PreloaderHandler(props);
        this.setTranslations();
        this.listenEvents();
    }

    setTranslations()
    {
        if(!this.gameManager){
            return false;
        }
        TranslationsMapper.forConfig(this.gameManager.config.client, Translations, ActionsConst.MESSAGE.DATA_VALUES);
    }

    listenEvents()
    {
        if(!this.events || !this.gameManager){
            return false;
        }
        this.events.on('reldens.preloadUiScene', (uiScene) => {
            this.preloaderHandler.loadContents(uiScene);
        });
        this.events.on('reldens.createPreload', (preloadScene) => {
            this.preloaderHandler.createAnimations(preloadScene);
        });
        this.events.on('reldens.createUiScene', (preloadScene) => {
            this.uiManager = new SkillsUi(preloadScene);
            this.uiManager.createUi();
        });
        this.events.on('reldens.beforeCreateEngine', (initialGameData) => {
            this.playerSelector.populateClassesSelector(
                sc.get(initialGameData, 'classesData', {}),
                initialGameData.gameConfig.client.players,
                initialGameData.player
            );
        });
        this.events.on('reldens.activateRoom', (room) => {
            room.onMessage('*', (message) => {
                MessagesHandler.processOrQueueMessage(message, this.gameManager);
            });
        });
        this.events.on('reldens.playersOnAddReady', (props) => {
            GameManagerEnricher.withReceiver(props.player, props.roomEvents, this.gameManager);
        });
    }

}

module.exports.ActionsPlugin = ActionsPlugin;