Plex-FAWE/src/main/java/com/sk89q/worldedit/cui/CUIRegion.java

// $Id$
/*
 * WorldEdit
 * Copyright (C) 2010, 2011 sk89q <http://www.sk89q.com> and contributors
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
*/

package com.sk89q.worldedit.cui;

import com.sk89q.worldedit.LocalPlayer;
import com.sk89q.worldedit.LocalSession;

public interface CUIRegion {
    
    /**
     * Sends CUI events describing the region for
     * versions of CUI equal to or greater than the
     * value supplied by getProtocolVersion().
     * 
     */
    public void describeCUI(LocalSession session, LocalPlayer player);
    
    /**
     * Sends CUI events describing the region for
     * versions of CUI smaller than the value 
     * supplied by getProtocolVersion().
     * 
     */
    public void describeLegacyCUI(LocalSession session, LocalPlayer player);
    
    /**
     * Returns the CUI version that is required to send
     * up-to-date data. If the CUI version is smaller than
     * this value, the legacy methods will be called.
     * 
     * @return 
     */
    public int getProtocolVersion();
    
    /**
     * Returns the type ID to send to CUI in the selection event. 
     * @return 
     */
    public String getTypeID();
    
    /**
     * Returns the type ID to send to CUI in the selection
     * event if the CUI is in legacy mode.
     * 
     * @return 
     */
    public String getLegacyTypeID();
}