cn.nukkit.entity.ai.behavior.IBehavior Maven / Gradle / Ivy
package cn.nukkit.entity.ai.behavior;
import cn.nukkit.api.PowerNukkitXOnly;
import cn.nukkit.api.Since;
import cn.nukkit.entity.ai.behaviorgroup.IBehaviorGroup;
import cn.nukkit.entity.ai.evaluator.IBehaviorEvaluator;
import cn.nukkit.entity.ai.executor.IBehaviorExecutor;
/**
* 此接口抽象了一个行为对象，作为行为组{@link IBehaviorGroup}的组成部分.
*
* This interface abstracts a behavior object as part of the behavior group {@link IBehaviorGroup}.
*/
@PowerNukkitXOnly
@Since("1.6.0.0-PNX")
public interface IBehavior extends IBehaviorExecutor, IBehaviorEvaluator {
/**
* 返回此行为的优先级，高优先级的行为会覆盖低优先级的行为
*
* Returns the priority of this behavior, with higher-priority behaviors overriding lower-priority ones
*
* @return 优先级
*/
default int getPriority() {
return 1;
}
/**
* 返回此行为的权重值，高权重的行为有更大几率被选中
*
* Returns the weight value of the behavior, with higher weights having a higher chance of being selected
*
* @return 权重值
*/
default int getWeight() {
return 1;
}
/**
* 返回此行为的刷新周期，小的刷新周期会使得评估器被更频繁的调用。注意此方法只会影响评估器的调用，而不会影响执行器的调用。
*
* Returns the refresh period for this behavior, a small refresh period will cause the evaluator to be called more often. Note that this method only affects evaluator calls, not executor calls.
*
* @return 刷新周期
Refresh period
*/
default int getPeriod() {
return 1;
}
/**
* @return 此行为当前的状态
The current state of this behavior
*/
BehaviorState getBehaviorState();
/**
* 设置此行为的状态
*
* Set the status of this behavior
*
* @param state 状态
*/
void setBehaviorState(BehaviorState state);
}