PlayerFunctions.java

/*
 * Copyright (c) 2014 tabletoptool.com team.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the GNU Public License v3.0
 * which accompanies this distribution, and is available at
 * http://www.gnu.org/licenses/gpl.html
 * 
 * Contributors:
 *     rptools.com team - initial implementation
 *     tabletoptool.com team - further development
 */
package com.t3.macro.api.functions;

import java.util.ArrayList;
import java.util.List;

import com.t3.client.TabletopTool;
import com.t3.macro.api.views.TokenView;
import com.t3.model.Player;
import com.t3.model.Token;

public class PlayerFunctions {
	/**
	 * @return the token the local player has impersonated or null if there is none
	 */
	public TokenView getLocalImpersonatedToken() {
		Token t = TabletopTool.getFrame().getCommandPanel().getImpersonatedToken();
		
		return t==null ? null : new TokenView(t);
	}
	
	/**
	 * @return if the local player has a token impersonated
	 */
	public boolean hasLocalImpersonatedToken() {
		return getLocalImpersonatedToken()!=null;
	}
	
	/**
	 * @return the name name of the local player
	 */
	public String getLocalName() {
		return TabletopTool.getPlayer().getName();
	}

    /**
     * @return if the current local player is a GM or not
     */
    public boolean isGM() { return TabletopTool.getPlayer().isGM(); }
	
	/**
	 * @return a list of all the player names
	 */
	public List<String> getPlayerNames() {
		List<Player> players=TabletopTool.getPlayerList();
		List<String> names=new ArrayList<String>(players.size());
		for(Player p:players)
			names.add(p.getName());
		return names;
	}
}