File /obj/handlers/transport_handler.c

This keeps track of transports unsurprisingly

Written by Goldenthread/runtime

Started 16 Aug y2k2

Inherits

Includes

Method index

• add_allowed_rider(int, string)
  Adds a new rider as allowed to use the transport
• add_transport(object, string, mixed, string, string)
  Registers a transport with the handler
• create_transport(int)
  This creates the transport with a particular id
• query_allowed_riders(int)
  Queries the riders allowed to use the transport associated with an id number
• query_gender(int)
  Queries the gender of the transport with a particular id number
• query_height_in_hands(int)
  Queries the transport's height in hands associated with an id number
• query_inventory(int)
  Queries the paths of all the inventory of the transport
• query_owned_transports(string)
  Queries the transports owned by a particular player
• query_owner(int)
  Queries the owner of the transport associated with an id number
• query_stabled(int)
  Returns the stabled time of the transport
• query_starting_location(int)
  Queries the transport's starting location
• query_time_stabled(int)
  Returns the time the transport has been stabled in seconds
• query_transport_base_name(int)
  Queries the transport base name
• query_transport_class(int)
  Queries the class associated with an id number
• query_transport_coat(int)
  Queries the coat type associated with an id number
• query_transport_colour(int)
  Queries the transport colour associated with an id number
• query_transport_desc(int)
  Gets the basic desc of the transport
• query_transport_name(int)
  Queries the transport name associated with an id number
• query_transport_type(int)
  Queries the type of transport
• query_transports()
  Queries the transports registered with the handler
• remove_allowed_rider(int, string)
  Removes a rider as allowed to use the transport
• remove_transport(int)
  Removes a transport from the handler
• set_allowed_riders(int, string *)
  Sets the allowed riders for the transport
• set_not_stabled(int)
  Sets the stabled state of the transport to false.
• set_stabled(int)
  Sets the stabled state of the transport to true.
• set_starting_location(int, string)
  Sets the transport's starting location
• set_transport_base_name(int, string)
  Sets the transport name
• set_transport_colour(int, string)
  Sets the transport colour
• set_transport_owner(int, string)
  Sets the transport's owner
• set_transport_short(int)
  Sets the short of the transport referenced by the id passed in
• toggle_stabled(int)
  Toggles the stabled state of the transport

Public Functions

add_allowed_rider

int add_allowed_rider(int trans_id,
                      string new_rider)

Adds a new rider as allowed to use the transport

Parameters:
trans_id - the id of the transport
new_rider - the new addition to the allowed rider array

Returns:
1 on success and 0 on failure

add_transport

int add_transport(object ob,
                  string trans_name,
                  mixed trans_owner,
                  string col,
                  string coat)

Registers a transport with the handler

Parameters:
ob - the transport object
trans_name - the name of the transport ( if set )
trans_owner - the owner of the transport
col - the transport colour
coat - the type of coat the transport has

Returns:
the id of the new transport

create_transport

object create_transport(int trans_id)

This creates the transport with a particular id

Parameters:
trans_id - the transport id

Returns:
the transport object

query_allowed_riders

string * query_allowed_riders(int trans_id)

Queries the riders allowed to use the transport associated with an id number

Parameters:
trans_id - the id number of the transport

Returns:
the riders allowed to use the transport associated with the id number

query_gender

int query_gender(int trans_id)

Queries the gender of the transport with a particular id number

Parameters:
trans_id - the id number of the transport

Returns:
the transport gender

query_height_in_hands

string query_height_in_hands(int trans_id)

Queries the transport's height in hands associated with an id number

Parameters:
trans_id - the id number of the transport

Returns:
the transport's height in hands associated with the id number

query_inventory

string * query_inventory(int trans_id)

Queries the paths of all the inventory of the transport

Parameters:
trans_id - the id number of the transport

Returns:
the transport's inventory

query_owned_transports

class transport * query_owned_transports(string owner)

Queries the transports owned by a particular player

Parameters:
owner - the name of the player to query

Returns:
the transports owned by the player

query_owner

string query_owner(int trans_id)

Queries the owner of the transport associated with an id number

Parameters:
trans_id - the id number of the transport

Returns:
the owner of the transport associated with the id number

query_stabled

int query_stabled(int trans_id)

Returns the stabled time of the transport

Parameters:
trans_id - the id of the transport

Returns:
the stabled time: 0 if the transport is not stabled

query_starting_location

string query_starting_location(int trans_id)

Queries the transport's starting location

Parameters:
trans_id - the id of the transport

Returns:
the starting location

query_time_stabled

int query_time_stabled(int trans_id)

Returns the time the transport has been stabled in seconds

Parameters:
trans_id - the id of the transport

Returns:
the time the transport has been stabled for

query_transport_base_name

string query_transport_base_name(int trans_id)

Queries the transport base name

Parameters:
trans_id - the id number of the transport

Returns:
the transport base name

query_transport_class

class transport query_transport_class(int trans_id)

Queries the class associated with an id number

Parameters:
trans_id - the id number of the transport

Returns:
the transport associated with the id number

query_transport_coat

string query_transport_coat(int trans_id)

Queries the coat type associated with an id number

Parameters:
trans_id - the id number of the transport

Returns:
the transport coat type associated with the id number

query_transport_colour

string query_transport_colour(int trans_id)

Queries the transport colour associated with an id number

Parameters:
trans_id - the id number of the transport

Returns:
the transport colour associated with the id number

query_transport_desc

string query_transport_desc(int trans_id)

Gets the basic desc of the transport

Parameters:
trans_id - the id number

Returns:
the basic desc

query_transport_name

string query_transport_name(int trans_id)

Queries the transport name associated with an id number

Parameters:
trans_id - the id number of the transport

Returns:
the transport name associated with the id number

query_transport_type

string query_transport_type(int trans_id)

Queries the type of transport

Parameters:
trans_id - the id number of the transport

Returns:
the transport type

query_transports

class transport * query_transports()

Queries the transports registered with the handler

Returns:
the transports registered with the handler

remove_allowed_rider

int remove_allowed_rider(int trans_id,
                         string rider)

Removes a rider as allowed to use the transport

Parameters:
trans_id - the id of the transport
new_rider_arr - the player to remove from the allowed rider array

Returns:
1 on success and 0 on failure

remove_transport

int remove_transport(int trans_id)

Removes a transport from the handler

Parameters:
trans_id - the transport id to remove

Returns:
1 on success and 0 on failure

set_allowed_riders

int set_allowed_riders(int trans_id,
                       string * new_rider_arr)

Sets the allowed riders for the transport

Parameters:
trans_id - the id of the transport
new_rider_arr - the new array of allowed riders

Returns:
1 on success and 0 on failure

set_not_stabled

void set_not_stabled(int trans_id)

Sets the stabled state of the transport to false.

Parameters:
trans_id - the id of the transport

set_stabled

void set_stabled(int trans_id)

Sets the stabled state of the transport to true. The stabled state holds the time of stabling

Parameters:
trans_id - the id of the transport

set_starting_location

void set_starting_location(int trans_id,
                           string loc)

Sets the transport's starting location

Parameters:
trans_id - the id of the transport
loc - the location to start in

set_transport_base_name

int set_transport_base_name(int trans_id,
                            string new_name)

Sets the transport name

Parameters:
trans_id - the id of the transport
new_name - the new name of the transport

Returns:
1 on success and 0 on failure

set_transport_colour

int set_transport_colour(int trans_id,
                         string new_col)

Sets the transport colour

Parameters:
trans_id - the id of the transport
new_col - the new colour of the transport

Returns:
1 on success and 0 on failure

set_transport_owner

int set_transport_owner(int trans_id,
                        string new_owner)

Sets the transport's owner

Parameters:
trans_id - the id of the transport
new_col - the new owner of the transport

Returns:
1 on success and 0 on failure

set_transport_short

string set_transport_short(int trans_id)

Sets the short of the transport referenced by the id passed in

Parameters:
trans_id - the id of the transport

Returns:
the new short

toggle_stabled

int toggle_stabled(int trans_id)

Toggles the stabled state of the transport

Parameters:
trans_id - the id of the transport

Returns:
the new stabled state