audio_play_for_cellphone(ring_name, num_rings, ring_interval, ring_passive, conv_name, mission_interrupt[, begin_name[, end_name[, handle_in_script]]])

Parameters:
ring_name (string) name of the ring tone sound
num_rings (integer) number of times to play the ring tone before call is considered unanswered
ring_interval (float) amount of time between ring tones, in seconds
ring_passive (float) amount of time between call attempts, in minutes
conv_name (string) name of conversation sound to play (entry in voice.tbl)
mission_interrupt (boolean) set to true if the phone call can be taken during a mission, or false if not
begin_name (string, optional) name of function to be executed immediately before conversation begins (defaults to "")
end_name (string, optional) name of function to be executed immediately after conversation ends (defaults to "")
handle_in_script (boolean, optional) set to true if animations and sounds are handled by the script (defaults to false)
 
Returns:
none

Description:
Play a cellphone call and conversation.

Example:

   audio_play_for_cellphone("Ring 1", 4, 1.5, 0.75, "your punked", false, "punked_begin", "punked_end")

Plays the ring tone "Ring 1" four times before hanging up. Each ring has 1.5 seconds between them. If the call is not answered, the call will happen again 0.75 minutes later. When the phone is answered the "punked_begin" is executed and "your punked" is played. This call cannot interrupt a mission. When the call is done, "punked_end" is executed.

 

back to indexSR3 Script Action Documentation
Last updated: Tue, 09 Aug 2011 11:32:15