com.tenio.engine.fsm.entity.State Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of tenio-engine Show documentation

TenIO is a java NIO (Non-blocking I/O) based server specifically designed for multiplayer games. It supports UDP and TCP transports which are handled by Netty for high-speed network transmission. This is the engine module for the game related handlers of the framework.

There is a newer version: 0.6.0

Show newest version

/*
The MIT License

Copyright (c) 2016-2021 kong 

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
*/

package com.tenio.engine.fsm.entity;

import com.tenio.engine.fsm.MessageDispatcher;

/**
 * Check out the State
 * for more details.
 *
 * @param  the entity template
 */
public abstract class State {

  /**
   * This will execute when the state is entered.
   *
   * @param entity the current entity
   */
  public abstract void enter(T entity);

  /**
   * This is the state's normal update function.
   *
   * @param entity the current entity
   */
  public abstract void execute(T entity);

  /**
   * This will execute when the state is exited.
   *
   * @param entity the current entity
   */
  public abstract void exit(T entity);

  /**
   * This executes if the agent receives a message from the message dispatcher,
   * see {@link MessageDispatcher}.
   *
   * @param entity the current entity
   * @param msg    the message that sent to this current entity
   * @return true if the message was sent successful, false otherwise
   */
  public abstract boolean onMessage(T entity, Telegram msg);
}