Jump to: navigation, search

Message

Message

Message.Room(ByVal roomID As Integer, ByVal message As String, Optional ByVal ignorepID As Integer = -1, Optional ByVal ignorepID2 As Integer = -1, Optional ByVal pIDIsPlayer As Boolean = True, Optional ByVal pIDIsPlayer2 As Boolean = True)
  • Description=Message a whole room. You can ignore up to two IDs. (Normally ignoring is used for when you have more specific messages to send to one or two players, such as direct attacks vs spectators.)
Values
  • roomID=The room number.
  • message=The message to send to the room.
  • ignorepID=The ignored ID. Use -1 to bypass. This will bypass sending the message to this player.
  • ignorepID2=The second ignored ID. Use -1 to bypass. This will bypass sending the message to this player.
  • pIDIsPlayer=Is the first pID a player? Does not matter if -1 is set.
  • pIDIsPlayer2=Is the second pID a player? Does not matter if -1 is set.
  • Example=Message.Room(50, "Hello room!", 2, 5, true, true)


Message.RoomVar(ByVal roomID As Integer, ByVal message As String, Optional ByVal ignorepID As Integer = -1, Optional ByVal ignorepID2 As Integer = -1, Optional ByVal pIDIsPlayer As Boolean = True, Optional ByVal pIDIsPlayer2 As Boolean = True)
  • Description=Message a group of rooms. You generally need to set the rooms before hand. Can ignore up to two IDs. (Normally ignoring is used for when you have more specific messages to send to one or two players, such as direct attacks vs spectators.) Do not send a room message to too many rooms at once!
Values
  • roomID=The room number that holds the group of rooms (aka parent room, typically where the script is.).
  • message=The message to send to the room.
  • ignorepID=The ignored ID. Use -1 to bypass. This will bypass sending the message to this player.
  • ignorepID2=The second ignored ID. Use -1 to bypass. This will bypass sending the message to this player.
  • pIDIsPlayer=Is the first pID a player? Does not matter if -1 is set.
  • pIDIsPlayer2=Is the second pID a player? Does not matter if -1 is set.
  • Example=Message.RoomVar(50, "Hello all rooms!", 2, 5, true, true)


Message.NPCSpeak(ByVal NPCID As Integer, message As String, Optional directID As Integer = -1, Optional directIsPlayer As Boolean = False, Optional messageDirect As String = ") As Integer
  • Description=Makes an NPC speak like it was as player speaking. Can also do /me commands if the message starts with '/'.
Values
  • NPCID=The NPC ID.
  • message=The message to send. Start with a forward slash to produce a /me command.
  • directID=Is this message directed to anyone, if so, what ID? -1 for no one.
  • directIsPlayer=Is the directID a player?
  • messageDirect"=The message that the player directed will see. This means that 'message' is the room message, and 'messageDirect' is the message only to the directed.
  • Example=Message.NPCSpeak(5, "/whispers to NiteHawk", 1, true, "I will end you.")


Message.Global(ByVal message As String)
  • Description=Global server message, to everyone on the server.
Values
  • message=The message to send.
  • Example=Message.Global("Something just spawned in Seamoor!")


Message.Direct(ByVal pID As Integer, ByVal message As String)
  • Description=Sends a message directly to a player slot.
Values
  • pID=The slot to send the message too.
  • message=The message to send.
  • Example=Message.Direct(1, "You fall to the ground!")


Message.AttackDirect(ByVal pID As Integer, ByVal message As String)
  • Description=Sends a message directly to a player slot. Will act as a attack message and will ding the player with a sound.
Values
  • pID=The slot to send the message too.
  • message=The message to send.
  • Example=Message.AttackDirect(1, "You get hit by a flying canadian!!")


Message.AttackRoom(ByVal roomID As Integer, ByVal message As String, Optional ByVal ignorepID As Integer = -1, Optional ByVal ignorepID2 As Integer = -1, Optional ByVal pIDIsPlayer As Boolean = True, Optional ByVal pIDIsPlayer2 As Boolean = True)
  • Description=Message a whole room but also 'ding' the room like an attack message would. You can ignore up to two IDs. (Normally ignoring is used for when you have more specific messages to send to one or two players, such as direct attacks vs spectators.)
Values
  • roomID=The room number.
  • message=The message to send to the room.
  • ignorepID=The ignored ID. Use -1 to bypass. This will bypass sending the message to this player.
  • ignorepID2=The second ignored ID. Use -1 to bypass. This will bypass sending the message to this player.
  • pIDIsPlayer=Is the first pID a player? Does not matter if -1 is set.
  • pIDIsPlayer2=Is the second pID a player? Does not matter if -1 is set.
  • Example=Message.AttackRoom(50, "Everyone in the room takes 200 damage!", 2, 5, true, true)


Message.AttackGlobal(ByVal message As String)
  • Description="Global server message with ding noise, to everyone on the server. Armageddon anyone?
Values
  • message=The message to send.
  • Example=Message.AttackGlobal("You take 500 random damage for existing!")