Package megamek.common.util

Class C3Util

java.lang.Object

megamek.common.util.C3Util

public class C3Util
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	C3Util.C3CapacityException
static class	C3Util.MismatchingC3MException
static class	C3Util.MissingC3MException

Constructor Summary

Constructors

Constructor	Description
C3Util()

Method Summary

Modifier and Type	Method	Description
static List<Entity>	broadcastChanges(Game game, Entity entity)
static Set<Entity>	connect(Game game, Collection<Entity> entities, int masterID, boolean disconnectFirst)	Connects the passed entities to a standard C3M identified by masterID.
static void	copyC3Networks(Entity source, Entity target)	Copies the C3 network setup from the source to the target.
static Set<Entity>	disconnectFromNetwork(Game game, Collection<Entity> entities)	Disconnects the passed entities from their C3 network, if any.
static void	joinNh(Game game, Collection<Entity> entities, int masterID, boolean disconnectFirst)	Connects the passed entities to a non-hierarchic C3 (NC3, C3i or Nova CEWS) identified by masterID.
static boolean	sameNhC3System(Entity a, Entity b)	Returns true if a and b share at least one non-hierarchic C3 system (C3i, Naval C3, Nova CEWS).
static void	setCompanyMaster(Collection<Entity> entities)	Sets the entities' C3M to act as a Company Master.
static void	setLanceMaster(Collection<Entity> entities)	Sets the entities' C3M to act as a Lance Master (aka normal mode).
static List<Entity>	wireC3(Game game, Entity entity)	Adds C3 connections when new units are being added.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

C3Util

public C3Util()

Method Details

wireC3

public static List<Entity> wireC3(Game game,
 Entity entity)

Adds C3 connections when new units are being added.

Parameters:

game - The Game the unit is being added to, the unit should already be in the Game.

entity - The entity being added.

Returns:

A list of units affected

disconnectFromNetwork

public static Set<Entity> disconnectFromNetwork(Game game,
 Collection<Entity> entities)

Disconnects the passed entities from their C3 network, if any. Due to the way C3 networks are represented in Entity, units cannot disconnect from a C3 network with an id that is the entity's own id.

setCompanyMaster

public static void setCompanyMaster(Collection<Entity> entities)
                             throws C3Util.MissingC3MException

Sets the entities' C3M to act as a Company Master.

Throws:

C3Util.MissingC3MException

setLanceMaster

public static void setLanceMaster(Collection<Entity> entities)
                           throws C3Util.MissingC3MException

Sets the entities' C3M to act as a Lance Master (aka normal mode).

Throws:

C3Util.MissingC3MException

sameNhC3System

public static boolean sameNhC3System(Entity a,
 Entity b)

Returns true if a and b share at least one non-hierarchic C3 system (C3i, Naval C3, Nova CEWS). Symmetrical (the order of a and b does not matter).

joinNh

public static void joinNh(Game game,
 Collection<Entity> entities,
 int masterID,
 boolean disconnectFirst)
                   throws C3Util.MismatchingC3MException,
C3Util.C3CapacityException

Connects the passed entities to a non-hierarchic C3 (NC3, C3i or Nova CEWS) identified by masterID.

Throws:

C3Util.MismatchingC3MException

C3Util.C3CapacityException

connect

public static Set<Entity> connect(Game game,
 Collection<Entity> entities,
 int masterID,
 boolean disconnectFirst)
                           throws C3Util.MismatchingC3MException,
C3Util.C3CapacityException

Connects the passed entities to a standard C3M identified by masterID.

Throws:

C3Util.MismatchingC3MException

C3Util.C3CapacityException

broadcastChanges

public static List<Entity> broadcastChanges(Game game,
 Entity entity)

copyC3Networks

public static void copyC3Networks(Entity source,
 Entity target)

Copies the C3 network setup from the source to the target.

Parameters:

source - The source Entity.

target - The target Entity.