Phantasmal Site > Phantasmal API > API Listing > get_start_room

API Function: get_start_room

Summary:

get the start room's number

Defined In LPC Object:

/usr/common/sys/configd.c

Prototype:

int get_start_room(void)

Can Be Called By:

System, Common, Game

Description:

Get a room number for the starting room. This information is used by the system user object to start the player's body in an appropriate location.

This API may change later since we may want a more complex mechanism than a single default starting room.

Return Value:

An integer for the starting room.

Errors:

Normally none

See Also:

set_start_room