Phantasmal Site > Phantasmal API > API Listing > set_start_room

API Function: set_start_room

Summary:

set the starting room's number

Defined In LPC Object:

/usr/common/sys/configd.c

Prototype:

void set_start_room(int room_number)

Can Be Called By:

System, Common, Game

Description:

Set 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.

The number should correspond to a room registered with the MapD. If the starting room doesn't exist, Phantasmal's behavior is undefined.

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:

get_start_room