View source for MUDL:send msgs for sing


__TOC__


= Summary =

{|class="abilitiestable" border="0" cellspacing="0" cellpadding="0"
! Function Name
| send_msgs_for_sing
|-
! Settable
| No
|-
! Returns
| Boolean
|}


This function sends the appropriate messages for singing a song.  It is most likely to be used inside the intercept_sing function but could be used in other places.  The function returns TRUE if all the parameters are valid and FALSE otherwise.


= Parameters =

{|class="abilitiestable" border="0" cellspacing="0" cellpadding="0"
!colspan="2" | Arguments
|-
| Character
| Actor singing the song.
|-
| Integer
| Id of the song being sung.
|-
| Boolean
| FALSE if this is the start of a song or TRUE if another verse of a song is being played.
|}


= Output =

{|class="abilitiestable" border="0" cellspacing="0" cellpadding="0"
! Person
! Message Sent
|-
| Actor
| You begin to sing <Song>.<br/>
You sing another verse of <Song>.
|-
| Others in Room
| <Actor> begins to sing <Song>.<br/>
<Actor> sings another verse of <Song>.
|}


= Example =
<pre>
addproc <mobile> mudl
setproc <mobile> 0 intercept_sing_ib

if (spell_name(%1) != 'lion chorus',
(
    # Wrong song.
    return(false)
)),

if (false = %2,
(
    # Allow the initial play to run as normal.
    cmd(%a, 'sing ~`lion chorus~` ' + concatenate(%s)),
    cmd(%c, 'say What a lovely song.')
),
(
    # Show the replay messages.
    send_msgs_for_sing(%a, %1, %2),
    cmd(%c, 'say It keeps getting better!')
)),

# Mark song as successful - full mana drain.
set(flag(%f, 'procedure-flags', 'success'), true),

# Stop future processing of this command
set(flag(%f, 'procedure-flags', 'overrode-command'), true),
return(true)@

setproc <mobile> 0 PROC_ENABLED 1
compile
</pre>


[[Category:Building]]
[[Category:MUDL|send_msgs_for_sing]]