MouseDown proc (client)

Format

MouseDown(object,location,control,params)

Args

• object: the object under the mouse pointer
• location: the turf, stat panel, grid cell, etc. containing the object where it was clicked
• control: the name of the skin control involved
• params: other parameters including mouse/keyboard flags, icon offsets, etc.; see mouse handling

Default action

Call object.MouseDown(location,control,params).

This is called when the a mouse button is pressed while pointing to the object. Note that MouseUp() will always be called after MouseDown() is called, even if over empty space. That means object and location may be null.

Don’t define this unless you need it, because it generates extra communication that is otherwise avoided. Most operations can be done through Click(), DblClick(), and MouseDrop(). The other procedures are simply available for completeness.

The argument format for this verb is:

MouseDown(object as null|atom in usr.client,\
          location as null|turf|text in usr.client,\
          control as text, params as text)

Note

In BYOND 3.5 this procedure took three different arguments: location, icon_x, and icon_y. Since icon_x and icon_y have been replaced, old code will need to be modified. Games compiled before this change will still work normally.

See also

• DblClick proc (client)
• MouseDown proc (atom)
• MouseDrag proc (client)
• MouseDrop proc (client)
• MouseEntered proc (client)
• MouseExited proc (client)
• MouseMove proc (client)
• MouseUp proc (client)
• MouseWheel proc (client)
• mouse_opacity var (atom)
• mouse_pointer_icon var (client)
• show_popup_menus var (client)