9.1.10 Mouse Message

Component: MouseMessage

Mouse Message allows you to send messages when the mouse moves, or enters or exits an object listed in the ’Target Tags’ list. This way, one handler can send a message for any object of a given tag, which is much faster than adding a check to all objects that might need these events. To send multiple messages, a Relay can be used. Simply parent a relay object to this object, or click the ’Relay’ button on the Rapid Dev Toolbar (found in the Window -> Multigame menu at the top of the screen.). Tags must also be defined, so that an object that doesn’t need to be checked won’t be. To make sure that an object will be checked by this component, ensure that it has both a tag and a layer, and that the tag and layer are both added to the lists at the top of this component. If you want to send a message to the object that interacted with the mouse, instead of one targeted on the message inspector, click ’Send To Other’ and the message will be sent to the moused-over object instead. Remember, you can lock a message and type it in manually if it doesn’t appear in the list.

Event Acquisition Settings

Field of MouseMessage: bool checkMotion

Should we send a message when the user moves the mouse?

Default value: false

Optional Field of MouseMessage: float reCheckInterval

How often do we check for mouse movement? If zero or less, we will check every frame.

Default value: 0f

Field of MouseMessage: bool sendToOther

Should we send the messages to the object under the mouse? If false, we will send to this object (or the Message Target) instead.

Default value: false

Output Settings

Event Acquisition Settings

Field of MouseMessage: bool checkMotion

Should we send a message when the user moves the mouse?

Default value: false

Optional Field of MouseMessage: float reCheckInterval

How often do we check for mouse movement? If zero or less, we will check every frame.

Default value: 0f

Field of MouseMessage: bool sendToOther

Should we send the messages to the object under the mouse? If false, we will send to this object (or the Message Target) instead.

Default value: false

Output Settings