EVENT PLAYLEVELMUSICSLOT: Difference between revisions

From EDukeWiki
Jump to navigation Jump to search
mNo edit summary
m (Remove outdated information and add template + return values)
Line 1: Line 1:
{{EventTable|1=EVENT_DISPLAYCROSSHAIR|2=[[myconnectindex]]|3=[[i|player->i]]|4=3 values}}
EVENT_PLAYLEVELMUSICSLOT is a [[EDuke32 event list|Misc Event]].
EVENT_PLAYLEVELMUSICSLOT is a [[EDuke32 event list|Misc Event]].


Called when a music track will be started from the beginning (excluding loops), regardless of whether the music is on or off.
Called when a music track will be started from the beginning (excluding loops), regardless of whether the music is on or off.


The slot of the requested track is passed into EVENT_PLAYLEVELMUSICSLOT via the [[Members_of_the_userdef_structure|userdef struct]] members [[m_volume_number]] and [[m_level_number]].
Set RETURN to -1 in order to disable the music for the map.
 
== Return Values ==
 
:; userdef.return 0 ([[RETURN]])
:: Default is 0. Set to -1 to disable music playback.
 
:; userdef.return 1
:: Contains the volume number for the music track that is about to be played. Read-only.
 
:; userdef.return 2
:: Contains the level number for the music track that is about to be played. Read-only.


Set RETURN to -1 in order to disable the music for the map.
[[Category:Events]]
[[Category:Events]]

Revision as of 05:39, 4 February 2022

Event ID player# THISACTOR RETURN
EVENT_DISPLAYCROSSHAIR myconnectindex player->i 3 values

EVENT_PLAYLEVELMUSICSLOT is a Misc Event.

Called when a music track will be started from the beginning (excluding loops), regardless of whether the music is on or off.

Set RETURN to -1 in order to disable the music for the map.

Return Values

userdef.return 0 (RETURN)
Default is 0. Set to -1 to disable music playback.
userdef.return 1
Contains the volume number for the music track that is about to be played. Read-only.
userdef.return 2
Contains the level number for the music track that is about to be played. Read-only.