Help

JS-WORLD

For immortals Also: JAVASCRIPT-WORLD

The World object represents worlds.

Properties:

keyName             The name of this world.
shortDesc           The short description of this world.
longDesc            The long description of this world.
hour                The current hour (0-23) in this world.
month               The current month (1-17) in this world.
weekday             The current day of the week (0-6) in this world.
day                 The current day of the month (1-35) in this world.
yearday             The current day of the year (1-595) in this world.
eonday              The current day as a count of days since the
                    beginning.
month               The current month (1-17) in this world.
year                The current year in this world.

Methods:

isActive()          Returns true if this world has not been deleted.
isWinter()          Returns true if it's winter in this world.
isSpring()          Returns true if it's spring in this world.
isSummer()          Returns true if it's summer in this world.
isAutumn()          Returns true if it's autumn in this world.
lighting( s )       Returns "dark", "rise", "light", or "dusk" based
                    upon the position of the sun named "s".  If no
                    sun name is provided, the light returned is based
                    upon the overall position(s) of the sun(s) in this
                    world.
lightLevel( s )     Like lighting() except that this returns 0-2 with
                    0 being darkness, 1 being twilight, and 2 being daylight
moonPhase( m )      Returns "new", "waxing crescent", "waxing quarter",
                    "waxing gibbous", "full", "waning gibbous",
                    "waning quarter", "waning crescent", or "bad" based
                    upon the position of the moon named "m".  If no
                    moon name is provided, the phase of the default moon
                    is provided or "undefined" if there is no moon.
hasPlayers()        Returns true if the world has players in it.
msg( string )       Sends a message to players in this world.  See
                    JS-MSG for more information.
randomPlayer()      This returns a player in this world at random or null if the
                    world is empty of players.
visitPlayers( f )   Applies the passed in function or array to all of the players
                    in this world.  See JS-VISIT for more information.
toString()          Returns the name of the world.
valueOf()           Returns the name of the world.