[Home]
[Download]
[Documentation]
[Discussion Forum]
[Jin at SourceForge]
[Contribute]
The event types and subtypes
When you choose the event type, you specify what type of event your script
is is intended to "respond" to. In other words, what must happen for Jin to run
your script.
The event subtypes selection specifies which of the subtypes of the chosen
event type your script will "respond" to. If the selected event type has no
subtypes, then no checkboxes will appear and your script will be run whenever an
event of the chosen type occurs.
A list of the currently available event types and their subtypes:
(Click the links for more information, such as the variables available for the type/subtype)
- Chat (All types of tells)
- All kinds of tells are categorized as this type. This includes personal tells, channel tells, all kinds of shouts, kibitzes/whispers etc.
Subtypes include:
- Personal tell - a regular personal tell, includes tells issued with the "say" command.
- Shout - regular shouts (not sshouts or c-shouts).
- (Bughouse) Partner Tell - tells from your current bughouse partner, issued with the "ptell" command.
- Channel Tell - tells to various channels/rooms.
- Kibitz - kibitzes in games, tells that go to all observers and players in a game.
- Whisper - like kibitzes, but goes only to observers, not players.
- Announcement - announcements made by the server administrators.
Subtypes specific to the Internet Chess Club (chessclub.com):
- Serious Shout - shouts done with the "sshout" command.
- QTell - Personal tells from Tournament Directors (TDs), such as Tomato, Flash etc.
- Channel QTell - Channel tells from Tournament Directors (TDs), such as Tomato, Flash etc.
Subtypes specific to the Free Internet Chess Server (freechess.org):
- C-Shout - shouts done with the "cshout" command.
- T-Shout - tournament announcements from mamer and Tournament Managers (TMs)
- Connection
- Events related to the connection of Jin to a chess server.
Subtypes include:
- Connect - Jin has connected to the server. You may not send commands to the server until login.
- Login - Jin has successfully logged in (the server accepted the username/password). You may now send commands to the server.
- Disconnect - Jin has been disconnected from the server for some reason. You may no longer send commands to the server.
- Seek
- Occur when a seek is posted/withdrawn on the server.
Subtypes include:
- Post - a new seek has been posted.
- Withdraw - an existing seek has been removed.
- Game
- Game related events such as game start, moves, clock adjustments etc.
Subtypes include:
- Game Start - a new game has started, or you started observing an existing game.
- Move - a move has been made in the game.
- Takeback/Backward - either a takeback has occurred or someone moved backwards in an examined game.
- Board Flip - the board has been flipped (from white-at-bottom to black-at-bottom view, or vice versa).
- Illegal Move Attempt - you've attempted to make an illegal move.
- Clock Update - a change to one of the clocks of the players.
- Other Position Change - a change in the position that can't be (or just isn't) described by a move or a takeback.
- Game End - a game has ended, or you have stopped observing it.
- Text (Unparsed text)
- Any text sent by the server that isn't categorized as any of the other types is automatically categorized as this type.