All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface net.tabuleiro.nebulae.ServerMovie

public abstract interface ServerMovie

Interface representing a movie connected to the Nebulae server.
ServerSideScript classes can use the serverMovie() method to retrieve a pointer to the ServerMovie object that created them.
Scripts can also use methods of the ServerObject interface to retrieve pointers to other movies connected to the server.

createServerGroup(String): Creates a new group on the movie and returns a pointer to it.
deleteServerGroup(String): Deletes a group from the movie.
disableGroup(String): Disables this group so new users can not join it.
enableGroup(String): Enables this group to receive new users.
getServerGroup(int): Retrieves a pointer to a ServerGroup object representing a group that exists on this ServerMovie.
getServerGroup(String): Retrieves a pointer to a ServerGroup object representing a group that exists on this ServerMovie.
name(): Returns the name of the movie as a String
persists(): Checks if the movie is set to persist on the server even when no users are connected to it.
serverGroupCount(): Gets the number of groups in this movie.
serverUserCount(): Gets the number of users connected to this movie.
setpersists(boolean): Toggles the movie persistent flag for this movie.
setuserLevel(int): Sets the default user levels for users that connect to this movie and do not have an user account in the DB.
userLevel(): Gets the default user levels for users that connect to this movie and do not have an user account in the DB.

getServerGroup

 public abstract net.tabuleiro.nebulae.ServerGroup getServerGroup(java.lang.String groupname) throws net.tabuleiro.nebulae.GroupNotFoundException

Retrieves a pointer to a ServerGroup object representing a group that exists on this ServerMovie.

Parameters:: groupname - String with the name of the group to be returned
Returns:: ServerGroup pointer, or throws a GroupNotFoundException

getServerGroup

 public abstract net.tabuleiro.nebulae.ServerGroup getServerGroup(int groupidx) throws net.tabuleiro.nebulae.GroupNotFoundException

Retrieves a pointer to a ServerGroup object representing a group that exists on this ServerMovie.

Parameters:: groupidx - index of the movie to be returned
Returns:: ServerGroup pointer, or throws a GroupNotFoundException

createServerGroup

 public abstract net.tabuleiro.nebulae.ServerGroup createServerGroup(java.lang.String groupname) throws net.tabuleiro.nebulae.MUSErrorCode

Creates a new group on the movie and returns a pointer to it.

Parameters:: groupname - String with the name of the group to be created
Returns:: ServerGroup pointer, or throws a MUSErrorCode if the creation fails

deleteServerGroup

 public abstract void deleteServerGroup(java.lang.String groupname)

Deletes a group from the movie.

Parameters:: groupname - String with the name of the group to be deleted

serverGroupCount

 public abstract int serverGroupCount()

Gets the number of groups in this movie.

Returns:: the number of groups

serverUserCount

 public abstract int serverUserCount()

Gets the number of users connected to this movie.

Returns:: the number of users

name

 public abstract java.lang.String name()

Returns the name of the movie as a String

userLevel

 public abstract int userLevel()

Gets the default user levels for users that connect to this movie and do not have an user account in the DB.
This value can be configured by the DefaultUserLevel directive in a movie configuration file.

setuserLevel

 public abstract void setuserLevel(int level)

Sets the default user levels for users that connect to this movie and do not have an user account in the DB.
When this method is used it overrides the value configured by the DefaultUserLevel directive in a movie configuration file.

enableGroup

 public abstract void enableGroup(java.lang.String gname)

Enables this group to receive new users. Groups are enabled by default.

disableGroup

 public abstract void disableGroup(java.lang.String gname)

Disables this group so new users can not join it.

persists

 public abstract boolean persists()

Checks if the movie is set to persist on the server even when no users are connected to it. Movies are not persistent by default.

Returns:: TRUE if the movie is set to persist, FALSE otherwise

setpersists

 public abstract void setpersists(boolean persistflag)

Toggles the movie persistent flag for this movie. Persistent movies are not destroyed even when no users are connected to it.

Parameters:: persistflag - TRUE if the movie needs to persist on the server, FALSE otherwise

All Packages  Class Hierarchy  This Package  Previous  Next  Index