com.iohao.game.widget.light.room.Player 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;

import java.io.Serializable;

/**
 * 玩家接口
 *
 * @author 渔民小镇
 * @date 2022-03-31
 * @since 21.8
 */
public interface Player extends Serializable {
    /**
     * get userId
     *
     * @return userId 玩家 id
     */
    long getUserId();

    /**
     * set userId
     *
     * @param userId userId 玩家 id
     */
    void setUserId(long userId);

    /**
     * get RoomId
     *
     * @return 房间 id
     */
    long getRoomId();

    /**
     * set RoomId
     *
     * @param roomId 房间 id
     */
    void setRoomId(long roomId);

    /**
     * get 用户所在位置
     *
     * @return 用户所在位置
     */
    int getSeat();

    /**
     * set 用户所在位置
     *
     * @param seat 用户所在位置
     */
    void setSeat(int seat);

    /**
     * 是否已经准备
     *
     * @return true - 已准备
     */
    boolean isReady();

    /**
     * set 准备状态
     *
     * @param ready true - 已准备
     */
    void setReady(boolean ready);
}