001/*
002 * Trident - A Multithreaded Server Alternative
003 * Copyright 2014 The TridentSDK Team
004 *
005 * Licensed under the Apache License, Version 2.0 (the "License");
006 * you may not use this file except in compliance with the License.
007 * You may obtain a copy of the License at
008 *
009 *    http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017
018package net.tridentsdk.entity.living.ai;
019
020import net.tridentsdk.entity.types.EntityType;
021
022/**
023 * Handles the assigning of AIs to Entities on the server.
024 *
025 * @author The TridentSDK Team
026 * @since 0.3-alpha-DP
027 */
028public interface AiHandler {
029    /**
030     * Returns the AI Module that is the default for a certain type of entity
031     */
032    AiModule defaultAiFor(EntityType type);
033
034    /**
035     * Sets the AI for this entity type, used to provide a separate AiModule for
036     * Entities
037     *
038     * <p>Entities of this type in the world will immediately start using this
039     * {@link net.tridentsdk.entity.living.ai.AiModule}, even if they were
040     * created before this was set.</p>
041     *
042     * @param type   the type of entity to replace the AI for
043     * @param module the new AiModule to use
044     */
045    void setDefaultAiFor(EntityType type, AiModule module);
046
047    /**
048     * Returns the server's implementation of the AI for a given entity type
049     *
050     * @param type the type of entity to request the AI for
051     */
052    AiModule nativeAIFor(EntityType type);
053}