nova.core.network

Enum NetworkTarget.Side

java.lang.Object

java.lang.Enum<NetworkTarget.Side>

nova.core.network.NetworkTarget.Side

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<NetworkTarget.Side>

Enclosing class:

NetworkTarget

public static enum NetworkTarget.Side
extends java.lang.Enum<NetworkTarget.Side>

A side specifies the current scope of the execution environment. Use get() to check your current side in order to react differently on the server or client side. Some methods may only be run on a specific side, see assertSide(Side).

Design your NOVA mod with two different sides in mind, or they might only run client side and crash your game when attempting to run the mod on the server side!

By convention, Sided is used to mark a sided type. Any reference to it from the wrong side, be it in form of a variable, a method call, or anything else that might cause the desired type to load might inevidably crash your game, causing an NetworkTarget.IllegalSideException, ReflectiveOperationException or worse.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BOTH BOTH is used by NetworkTarget to specify that an object has to be processed by both sides, SERVER and CLIENT.
CLIENT The client side.
NONE NONE is used by NetworkTarget to specify that an object has been processed, and finished its queue.
SERVER The server side.

Method Summary

Modifier and Type	Method and Description
void	assertSide() Shorthand for Side.assertSide(this)
static void	assertSide(NetworkTarget.Side side) Checks if the current execution environment is of the desired side.
static NetworkTarget.Side	get() Returns the NetworkTarget.Side of the current execution environment.
boolean	isClient() Check if the provided side is the client side, shorthand for side == Side.CLIENT.
boolean	isServer() Check if the provided side is the server side, shorthand for side == Side.SERVER.
NetworkTarget.Side	opposite() Returns the opposite side, SERVER for CLIENT and vice-visa.
NetworkTarget.Side	reduce() Reduce is used to mark an object that was sent over the network as already processed from the opposing side.
boolean	targets(NetworkTarget.Side otherSide) Check if the given side is a valid target for this side.
static NetworkTarget.Side	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static NetworkTarget.Side[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CLIENT

public static final NetworkTarget.Side CLIENT

The client side. The client usually handles rendering and has no access to the remote World or Entities. Any changes on the client side have to be synchronized with the SERVER side using Packets or internal synchronizing methods as provided by Entity and others.

See Also:

NetworkTarget, NetworkManager, SERVER

SERVER

public static final NetworkTarget.Side SERVER

The server side. The server usually handles saving, entity logic, world data, etc. The server has to send packets to communicate with the CLIENT, every interaction with the game world has to be synchronized in order to see the effects on the client. The server doesn't handle rendering usually.

See Also:

NetworkTarget, NetworkManager, CLIENT

BOTH

public static final NetworkTarget.Side BOTH

BOTH is used by NetworkTarget to specify that an object has to be processed by both sides, SERVER and CLIENT.

NONE

public static final NetworkTarget.Side NONE

NONE is used by NetworkTarget to specify that an object has been processed, and finished its queue.

Method Detail

values

public static NetworkTarget.Side[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (NetworkTarget.Side c : NetworkTarget.Side.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static NetworkTarget.Side valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

assertSide

public static void assertSide(NetworkTarget.Side side)

Checks if the current execution environment is of the desired side.

Parameters:

side - desired NetworkTarget.Side

Throws:

NetworkTarget.IllegalSideException - if the side doesn't match

get

public static NetworkTarget.Side get()

Returns the NetworkTarget.Side of the current execution environment.

Returns:

current side

See Also:

NetworkManager.getSide()

targets

public boolean targets(NetworkTarget.Side otherSide)

Check if the given side is a valid target for this side. This is given if the provided side is either the opposing side or of type BOTH.

Parameters:

otherSide - side to check for

Returns:

true if otherSide is a valid target.

isServer

public boolean isServer()

Check if the provided side is the server side, shorthand for side == Side.SERVER.

Returns:

true if the current side is SERVER.

isClient

public boolean isClient()

Check if the provided side is the client side, shorthand for side == Side.CLIENT.

Returns:

true if the current side is CLIENT.

opposite

public NetworkTarget.Side opposite()

Returns the opposite side, SERVER for CLIENT and vice-visa. BOTH and NONE remain unchanged.

Returns:

Opposite side

reduce

public NetworkTarget.Side reduce()

Reduce is used to mark an object that was sent over the network as already processed from the opposing side. Especially used for BOTH.

Returns:

reduced scope, without the opposite side

See Also:

SidedEventBus

assertSide

public void assertSide()

Shorthand for Side.assertSide(this)

See Also:

assertSide(nova.core.network.NetworkTarget.Side)