MIST messageRemoveById

mist.message.removeById

Added with: Mist 3.0

Description

Removes the message with integer id from the list of messages. If the message was removed the function will return true. NOTE:

Syntax

boolean mist.message.removeById(number id )

Valid Input Values:

number id: any number

Return value:

boolean

Return example:

true

Usage Examples:

The following would remove a message from being displayed. do local myMsg = mist.message.add(vars) if whatever == true then mist.message.removeById(myMsg) end end

Notes:

Renamed from mist.message.remove in Mist v3.0! Change function names as needed!

Related Functions

messageAdd, removeById, remove , msgMGRS, msgLL, msgBR, msgBRA, msgBullseye, msgLeadingLL, msgLeadingMGRS, msgLeadingBR

Scripting Engine

MIST Root Page