Class: World

Class

World

In:

lib/core/world.rb

Parent:

TopLevel

The World class is the mother of all worlds.

It contains world state information, the world timer, utility functions, and delegates to the Engine.

cmds: is a handle to the character commands table.
ocmds: is a handle to the object commands table.
timer_list: is a list of all installed timer objects (persistent)
all_characters: is a list of all characters (persistent)
timer_list: is a list of all connected characters

Methods

add_admin add_builder is_admin? is_builder? is_owner? memstats new rem_admin rem_builder set_timer shutdown startup unset_timer

Attributes

 cmds
 connected_characters
 ocmds

Public Class methods

Create the World. This loads or creates the database depending on whether it finds it.

return: A handle to the World object.

Public Instance methods

Make the character an admin

oid: character object id
return: undefined

add_builder(oid)

Make the character a builder

oid: character object id
return: undefined

Is character an admin?

oid: character object id
return: true or false

is_builder?(oid)

Is character a builder?

oid: character object id
return: true or false

is_owner?(pid, oid)

Does character own the object?

pid: character object id
oid: object id
return: true or false

memstats scans all objects in memory and produces a report

return: a string

Remove admin priviledges from character

oid: character object id
return: undefined

rem_builder(oid)

Remove admin priviledges from character

oid: character object id
return: undefined

set_timer(id, name, time)

Set/add a timer for an object

id: The id of the object that wants to get a timer event
name: The symbolic name of the timer event
time: The interval time in seconds of the timer event

unset_timer(id, name=nil)

Unset/remove a timer for an object

id: The id of the object to remove a timer event
name: The symbolic name of the timer event to remove (or nil for all events)