Phantasmal Site > Phantasmal API > API Listing > stop_heart_beat

API Function: stop_heart_beat

Summary:

stop a heart_beat function from being called

Defined In LPC Object:

/usr/common/sys/timed.c

Prototype:

void stop_heart_beat(int how_often)

Can Be Called By:

System, Common, Game

Description:

Each object may have one heart_beat function of each frequency (such as TIMED_HALF_MINUTE or TIMED_ONE_HOUR). This call stops one such heart_beat function. The function is stopped for the calling object -- that is, an object may only stop one of its own heart_beat functions.

Return Value:

None.

Errors:

If no such heart_beat function exists, an error may occur.

See Also:

set_heart_beat