com.iohao.game.widget.light.room.flow.GameFlowContext Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of light-game-room Show documentation
The newest version!
/*
 * ioGame
 * Copyright (C) 2021 - present  渔民小镇 （[email protected]、[email protected]） . All Rights Reserved.
 * # iohao.com . 渔民小镇
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see .
 */
package com.iohao.game.widget.light.room.flow;

import com.iohao.game.action.skeleton.core.flow.FlowContext;
import com.iohao.game.common.kit.attr.AttrOption;
import com.iohao.game.common.kit.attr.AttrOptions;
import com.iohao.game.widget.light.room.Player;
import com.iohao.game.widget.light.room.Room;

/**
 * 上下文 - 游戏流程上下文。
 *
 * @author 渔民小镇
 * @date 2024-05-12
 * @see GameFlowService
 * @since 21.8
 */
public interface GameFlowContext {
    /**
     * 获取动态成员属性
     *
     * @return 动态成员属性
     */
    AttrOptions getOptions();

    /**
     * get room
     *
     * @param  t
     * @return room
     */
     T getRoom();

    /**
     * get FlowContext
     *
     * @return FlowContext
     */
    FlowContext getFlowContext();

    /**
     * get 当前操作的玩家
     *
     * @param  t
     * @return 当前玩家
     */
    default  T getPlayer() {
        long userId = getUserId();
        Room room = getRoom();
        return room.getPlayerById(userId);
    }

    /**
     * get userId
     *
     * @return userId
     */
    default long getUserId() {
        return this.getFlowContext().getUserId();
    }

    /**
     * get roomId
     *
     * @return roomId
     */
    default long getRoomId() {
        return getRoom().getRoomId();
    }

    /**
     * get 动态属性，获取选项值，如果选项不存在，返回默认值。
     *
     * @param option 选项值
     * @return 如果 option 不存在，则使用默认的 option 值。
     */
    default  T option(AttrOption option) {
        return this.getOptions().option(option);
    }

    /**
     * 设置动态属性。设置一个具有特定值的新选项，使用 null 值删除前一个设置的 {@link AttrOption}。
     *
     * @param option 选项值
     * @param value  选项值, null 用于删除前一个 {@link AttrOption}.
     * @return this
     */
    default  GameFlowContext option(AttrOption option, T value) {
        this.getOptions().option(option, value);
        return this;
    }

    /**
     * 创建 GameFlowContext（框架内置的默认实现）
     *
     * @param room        房间
     * @param flowContext flowContext 当前玩家
     * @return GameFlowContext
     */
    static GameFlowContext of(Room room, FlowContext flowContext) {
        return new SimpleGameFlowContext(room, flowContext);
    }

    /**
     * 创建 GameFlowContext（框架内置的默认实现）
     *
     * @param room 房间
     * @return GameFlowContext
     */
    static GameFlowContext of(Room room) {
        return of(room, null);
    }
}