HolyLib Wiki

HolyLib:OnSoundScapeUpdateForPlayer

  boolean HolyLib:OnSoundScapeUpdateForPlayer( Entity currentSoundscape, Player currentPlayer )

Description

Called before a soundscape tries to update for the given player.
Return true to block the call and any further calls for this tick and additionally,
the currently set soundscape entity for the active soundscapeUpdate will be applied to the player.
You can set it using soundscape.SetCurrentSoundscape inside the hook.

Recently Added

This was recently added in version (0.8 - DEV).

This hook needs to be enabled using soundscape.EnableUpdateHook

Arguments

1Entity currentSoundscape
2Player currentPlayer

Returns

1boolean blockChanges = false
block any further calls