com.vwp.vuapi.world
Class VUWorldInfo

java.lang.Object
  com.vwp.vuapi.util.VUInfo
      com.vwp.vuapi.world.VUWorldInfo

public class VUWorldInfo
extends VUInfo

This class is a container for world-related information like they are provided by the different listeners. Please note: fields that are currently not available, e.g. because the listener context isn't able to provide all world-related information are initialized with null or -1. Please use the VUInfoTool to collect all available information and to store lists of worlds.

Field Summary

String	description description of the world
int	level the worlds level within the universes hierarchy, 0 specifies the Center of the Universe, 1 stands for galaxies and 2 for solar system nodes while only 3 defines a planet
int	minRating
int	rating the rating of the world a user needs to have to enter it successfully
int	width width of the world, this value is given in m and has double of the height

Fields inherited from class com.vwp.vuapi.util.VUInfo

ID, name

Constructor Summary

VUWorldInfo(String name, int ID, String description, int rating, int minRating, int width)
Constructor for a new VUWorldInfo object; this constructor is used by the API only, there is no valid operation that makes it necessary for an application to use it.

VUWorldInfo(String name, int ID, String description, int rating, int minRating, int width, int level)
Constructor for a new VUWorldInfo object; this constructor is used by the API only, there is no valid operation that makes it necessary for an application to use it.

Method Summary

void	set(VUWorldInfo wi) This method sets the available values of the given VUWorldInfo object, that means, memebers of the given parameter that are not -1 and not null are copied to the related members of this object

Methods inherited from class com.vwp.vuapi.util.VUInfo

set

Methods inherited from class java.lang.Object

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

Field Detail

description

public String description

description of the world

width

public int width

width of the world, this value is given in m and has double of the height

rating

public int rating

the rating of the world a user needs to have to enter it successfully

minRating

public int minRating

level

public int level

the worlds level within the universes hierarchy, 0 specifies the Center of the Universe, 1 stands for galaxies and 2 for solar system nodes while only 3 defines a planet

Constructor Detail

VUWorldInfo

public VUWorldInfo(String name,
                   int ID,
                   String description,
                   int rating,
                   int minRating,
                   int width,
                   int level)

Constructor for a new VUWorldInfo object; this constructor is used by the API only, there is no valid operation that makes it necessary for an application to use it.

Parameters:

name - the name of the world

ID - a unique identifier that specifies this world non-ambiguous, this identifier is created by the API

description - the description that is attached to this world

rating - the current rating

minRating - the minimum rating

width - the width of the world in unit m

level - the worlds level within a universes hierarchy

VUWorldInfo

public VUWorldInfo(String name,
                   int ID,
                   String description,
                   int rating,
                   int minRating,
                   int width)

Constructor for a new VUWorldInfo object; this constructor is used by the API only, there is no valid operation that makes it necessary for an application to use it.

Parameters:

name - the name of the world

ID - a unique identifier that specifies this world non-ambiguous, this identifier is created by the API

description - the description that is attahed to this world

rating - the current rating

minRating - the minimum rating

width - the width of the world in unit m

Method Detail

set

public void set(VUWorldInfo wi)

This method sets the available values of the given VUWorldInfo object, that means, memebers of the given parameter that are not -1 and not null are copied to the related members of this object

Parameters:

wi - the VUWorldInfo object to copy the available members from