Class LM_Message
Version added: before 9.5
The LM_Message class is used to notify a script when certain actions take place, like a button being pressed or when a menu selection is made.
If necessary, instances of this class can be created by:
- Local variable:
- Global (see Script Structure about conventions for naming globals):
If necessary, instances of this class can be created by:
- Local variable:
local msg = LM.GUI.LM_Message:new_local()- Global (see Script Structure about conventions for naming globals):
XX_msg = LM.GUI.LM_Message:new_local()Methods of LM_Message:
| Name | Returns | Description | Ver |
| ClearKeys ClearKeys() | void | < 9.5 | |
| CountKeys CountKeys() | int32 | < 9.5 | |
| GetBool GetBool(key) | bool | < 9.5 | |
| GetColor GetColor(key) | rgb_color | < 9.5 | |
| GetFloat GetFloat(key) | real | < 9.5 | |
| GetInt GetInt(key) | int32 | < 9.5 | |
| GetKeyName GetKeyName(keyID) | char | < 9.5 | |
| GetMessage GetMessage(key) | LM_Message | < 9.5 | |
| GetPoint GetPoint(key) | Point | < 9.5 | |
| GetPtr GetPtr(key) | void | < 9.5 | |
| GetRect GetRect(key) | Rect | < 9.5 | |
| GetString GetString(key) | char | < 9.5 | |
| GetVector2 GetVector2(key) | Vector2 | < 9.5 | |
| GetVector3 GetVector3(key) | Vector3 | < 9.5 | |
| HasKey HasKey(key) | bool | < 9.5 | |
| Remove Remove(key) | void | < 9.5 | |
| Set Set(key, value) | void | Set the value of the message | < 9.5 |
| SetPtr SetPtr(key, value) | void | < 9.5 |
Properties of LM_Message:
| Name | Type | Description | Ver |
| fWhat | int32 | The fWhat value of a message object indicates what the message is supposed to represent. For example, each button in a dialog should have been assigned a unique message value. When the dialog receives a message, this value tells it what to do. | < 9.5 |