Messenger
Variables
Update
Messenger.Update
Is called every frame.
Example
self.RegisterListener(Messenger.Update,MyFunction)
SlowUpdate
Messenger.SlowUpdate
Is called every 20 frames.
Example
self.RegisterListener(Messenger.SlowUpdate,MyFunction)
StartGameUI
Messenger.StartGameUI
Is called when the main gameplay menu gets initialized.
Example
self.RegisterListener(Messenger.StartGameUI,MyFunction)
EndGameUI
Messenger.EndGameUI
Is called when the main gameplay menu gets destroyed.
Example
self.RegisterListener(Messenger.EndGameUI,MyFunction)
SliderSelectorChanged
Messenger.SliderSelectorChanged
Is called when the Slider Selector (Open with UI.OpenSliderSelector) has changed. You can get the new value by calling UI.GetLastSliderSelectorResult
Example
self.RegisterListener(Messenger.SliderSelectorChanged,MyFunction)
EventAdded
Messenger.EventAdded
Is called when an event gets added to the game state.
Example
self.RegisterListener(Messenger.EventAdded,MyFunction)
DayStarted
Messenger.DayStarted
Is called when the day is starting. It can also be called when you're changing islands.
Example
self.RegisterListener(Messenger.DayStarted,MyFunction)
SceneStarted
Messenger.SceneStarted
Is called when a new scene is started. It will be called when you first load into the game scene or when you change scenes to a new scene or to the dungeon. It will pass the scene's name as a parameter.
Example
self.RegisterListener(Messenger.SceneStarted,MyFunction)
MainSceneStarted
Messenger.MainSceneStarted
Is called when the main scene is started. It will be called when you first load into the game scene or when you go back to the main scene from another island or the dungeon.
Example
self.RegisterListener(Messenger.MainSceneStarted,MyFunction)
DayEnded
Messenger.DayEnded
Is called when the day is ending.
Example
self.RegisterListener(Messenger.DayEnded,MyFunction)
FiveSecondsIntoDay
Messenger.FiveSecondsIntoDay
Is called 5 seconds after the day started. (Or 5 seconds after you've changed islands)
Example
self.RegisterListener(Messenger.FiveSecondsIntoDay,MyFunction)
PlayerConnected
Messenger.PlayerConnected
Is called when a new player connected to the server. Player ID (int) is passed as a parameter.
Example
self.RegisterListener(Messenger.PlayerConnected,MyFunction)
PlayerDisconnected
Messenger.PlayerDisconnected
Is called when a new player disconnected to the server. Player ID (int) is passed as a parameter.
Example
self.RegisterListener(Messenger.PlayerDisconnected,MyFunction)
PlayerJumped
Messenger.PlayerJumped
Is called when the player jumps.
Example
self.RegisterListener(Messenger.PlayerJumped,MyFunction)
OwnChatMessage
Messenger.OwnChatMessage
Is called when the local player sends a message to chat. The message is sent as a parameter to the function registered.
Example
self.RegisterListener(Messenger.OwnChatMessage,MyFunction)
AnyChatMessage
Messenger.AnyChatMessage
Is called when any chat message is received. The message is sent as a parameter to the function registered. This can also be a message sent by the local player.
Example
self.RegisterListener(Messenger.AnyChatMessage,MyFunction)
PausedGame
Messenger.PausedGame
Is called when the game is paused and the pause menu is shown.
Example
self.RegisterListener(Messenger.PausedGame,MyFunction)
UnpausedGame
Messenger.UnpausedGame
Is called when the game was paused and it gets unpaused.
Example
self.RegisterListener(Messenger.UnpausedGame,MyFunction)
TimePassed
Messenger.TimePassed
Is called when time has passed in the game.
Example
self.RegisterListener(Messenger.TimePassed,MyFunction)
HourPassed
Messenger.HourPassed
Is called when an hour has passed in the game.
Example
self.RegisterListener(Messenger.HourPassed,MyFunction)
SetNormalCameraMode
Messenger.SetNormalCameraMode
Is called when the camera system is set to normal camera.
Example
self.RegisterListener(Messenger.SetNormalCameraMode,MyFunction)
SetShootingCameraMode
Messenger.SetShootingCameraMode
Is called when the camera system is set to shooting camera.
Example
self.RegisterListener(Messenger.SetShootingCameraMode,MyFunction)
LocalUpdate
Messenger.LocalUpdate
Is called every frame the entity is active. Used for entities only.
Example
self.RegisterListener(Messenger.LocalUpdate,MyFunction)
OnEnable
Messenger.OnEnable
Is called a frame after the entity is enabled. Entity only.
Example
self.RegisterListener(Messenger.OnEnable,MyFunction)
OnItemShifted
Messenger.OnItemShifted
Is called when the entity is item shifted using the item shifter. Entity only.
Example
self.RegisterListener(Messenger.OnItemShifted,MyFunction)
OnDisable
Messenger.OnDisable
Is called the frame the entity is disabled. Entity only.
Example
self.RegisterListener(Messenger.OnDisable,MyFunction)
UsableUpdate
Messenger.UsableUpdate
Is called every frame a UsableLua usable is selected in the hotbar.
Example
self.RegisterListener(Messenger.UsableUpdate,MyFunction)
UsableStarted
Messenger.UsableStarted
Is called the first frame a UsableLua usable is selected in the hotbar. It will pass a parameter string with the item id selected so you can check for a specific usable in your code.
Example
self.RegisterListener(Messenger.UsableStarted,MyFunction)
UsableEnded
Messenger.UsableEnded
Is called the frame a UsableLua usable that was selected is no longer selected in the hotbar. Useful for cleanup.
Example
self.RegisterListener(Messenger.UsableEnded,MyFunction)
UsableInteract
Messenger.UsableInteract
Is called the frame the interact button is pressed while a UsableLua usable is selected.
Example
self.RegisterListener(Messenger.UsableInteract,MyFunction)
UsableMouseClick
Messenger.UsableMouseClick
Is called the frame the mouse click is pressed while a UsableLua usable is selected.
Example
self.RegisterListener(Messenger.UsableMouseClick,MyFunction)