Info

Statistics

  • Download count582 total downloads
  • Latest download count 226 downloads of latest version
  • Average download count1 downloads per day average

Owners

A list of all Actions, Conditions and Expressions supported in this addon.

Channels

  • Actions

    Channels: Fetch one by ID {0}

    Get channel by ID

    Channels: Fetch {0}, IDs: {1}, Tags: {2}, Search: {3}, Only Owned: {4}, Only Joined: {5}, limit: {6}, offset: {7}

    Get channels list

    Channels: Fetch more {0}, IDs: {1}, Tags: {2}, Search: {3}, Only Owned: {4}, Only Joined: {5}, limit: {6}

    Get more channels of selected search params

    Channels: create using {0} template

    Create channel using ready-made template and additional fields

    Channels: update {0} channel

    Update channel info

    Channels: delete {0} channel

    Delete channel

    Channels: reset next channel state to empty

    Reset next channel state to empty

    Channels: set next channel name to {0}

    Set next channel name to update or create channel

    Channels: set next channel description to {0}

    Set next channel description to update or create channel

    Channels: set next channel owner ID to {0}

    Set next channel owner ID to update or create channel

    Channels: set next channel password to {0}

    Set next channel password to update or create channel

    Channels: set next channel capacity to {0}

    Set next channel capacity to update or create channel

    Channels: set next channel private to {0}

    Set next channel private to update or create channel

    Channels: set next channel visible to {0}

    Set next channel visible to update or create channel

    Channels: set next channel tags to {0}

    Set next channel tags to update or create channel

    Channels: set next channel ACL of {0} to: View Messages: {1}, Add Messages: {2}, Edit Messages: {3}, Delete Messages: {4}, View Members: {5}, Invite Players: {6}, Kick Players: {7}, Accept Join Requests: {8}, Mute Players: {9}

    Set next channel ACL to update or create channel

    Channels: set next channel ACL by integers of {0} to: View Messages: {1}, Add Messages: {2}, Edit Messages: {3}, Delete Messages: {4}, View Members: {5}, Invite Players: {6}, Kick Players: {7}, Accept Join Requests: {8}, Mute Players: {9}

    Set next channel ACL to update or create channel using integers

  • Conditions

    For each channel

    For each channel in list. You need to fetch channels before

    For each current channel tag

    For each current channel tag

    For each current channel message tag

    For each current channel message tag

    Cur Channel Is Private

    Current channel is private

    Cur Channel Is Visible

    Current channel is visible

    Cur Channel Has Password

    Current channel has password

    Cur Channel Is Joined

    Current channel is Joined

    Cur Channel Is RequestSent

    Current channel is request sent

    Cur Channel Is Invited

    Current channel is invited

    Cur Channel Is Muted

    Current channel is muted

    Cur Channel Is Owner

    Current channel is owner

    {0} in Cur Channel Can {1}

    Check current channel acl by role

    Channels: On single channel fetch

    On single channel success fetch

    Channels: On single channel fetch error

    On single channel error fetch

    Channels: On any fetch

    On any success fetch

    Channels: On any fetch error

    On any fetch error

    Channels: On {0} fetch

    On success fetch

    Channels: On {0} fetch error

    On fetch error

    Channels: On any fetch more

    On any success fetch more

    Channels: On any fetch more error

    On any fetch more error

    Channels: On {0} fetch more

    On success fetch more

    Channels: On {0} fetch more error

    On fetch more error

    Channels: On create

    On success create

    Channels: On create error

    On create error

    Channels: On update

    On success update

    Channels: On update error

    On update error

    Channels: On delete

    On success delete

    Channels: On delete error

    On delete error

  • Expressions

    CurTag

    Current tag (of channel / message / other)

    CurTagIndex

    Current tag index

    CurChannelIndex

    Current channel index

    CurChannelID

    Current channel ID

    CurChannelName

    Current channel name

    CurChannelDescription

    Current channel description

    CurChannelOwnerID

    Current channel owner ID

    CurChannelPassword

    Current channel password

    CurChannelCapacity

    Current channel capacity

    CurChannelTemplateID

    Current channel template ID

    CurChannelMembersCount

    Current channel members count

    CurChannelIsPrivate

    Current channel is private

    CurChannelIsVisible

    Current channel is visible

    CurChannelHasPassword

    Current channel has password

    CurChannelIsJoined

    Current channel is joined

    CurChannelIsRequestSent

    Current channel is request sent

    CurChannelIsInvited

    Current channel is invited

    CurChannelIsMuted

    Current channel is muted

    CurChannelIsOwner

    Current channel is owner

Members

  • Actions

    Members: Fetch {0} in channel {1}, search: {2}, only online: {3}, limit: {4}, offset: {5}

    Get members list

    Members: Fetch more {0} in channel {1}, search: {2}, only online: {3}, limit: {4}

    Get more members of selected search params

    Members: join channel {0}, password: {1}

    Join channel

    Members: join channel {0}

    Cancel join request into channel

    Members: leave channel {0}

    Leave channel

    Members: kick {1} from channel {0}

    Kick player from channel

    Members: mute {1} in channel {0} for {2} seconds

    Mute player in channel

    Members: unmute {1} in channel {0}

    Unmute player in channel

  • Conditions

    For each member

    For each member in list. You need to fetch members before

    Cur Member Is Muted

    Current member is muted

    Cur Member Is Online

    Current member is online

    Members: On any fetch

    On any success fetch

    Members: On any fetch error

    On any fetch error

    Members: On {0} fetch

    On success fetch

    Members: On {0} fetch error

    On fetch error

    Members: On any fetch more

    On any success fetch more

    Members: On any fetch more error

    On any fetch more error

    Members: On {0} fetch more

    On success fetch more

    Members: On {0} fetch more error

    On fetch more error

    Members: On kick

    On kick

    Members: On kick error

    On kick error

    Members: On mute

    On mute

    Members: On mute error

    On mute error

    Members: On unmute

    On unmute

    Members: On unmute error

    On unmute error

    Members: On join

    On join

    Members: On join error

    On join error

    Members: On cancel join

    On cancel join

    Members: On cancel join error

    On cancel join error

    Members: On leave

    On leave

    Members: On leave error

    On leave error

  • Expressions

    CurMemberIndex

    Current member index

    CurMemberChannelID

    Current member channel ID

    CurMemberIsMuted

    Current member is muted

    CurMemberUnmuteAt

    Current member unmute date, ISO 8601

    CurMemberIsOnline

    Current member is online

Join Requests

  • Actions

    Join Requests: Fetch in channel {0}, limit: {1}, offset: {2}

    Get join requests list

    Join Requests: Fetch more in channel {0}, limit: {1}

    Get more join requests of selected search params

    Join Requests: Fetch sent requests, limit: {0}, offset: {1}

    Get sent join requests list

    Join Requests: Fetch more sent requests, limit: {0}

    Get more sent join requests of selected search params

    Join Requests: accept join request of player {1} in channel {0}

    Accept join request

    Join Requests: reject join request of player {1} in channel {0}

    Reject join request

  • Conditions

    For each join request

    For each join request in list. You need to fetch join requests before

    Join Requests: On fetch

    On success fetch

    Join Requests: On fetch error

    On fetch error

    Join Requests: On fetch more

    On success fetch more

    Join Requests: On fetch more error

    On fetch more error

    Join Requests: On fetch sent

    On success fetch

    Join Requests: On fetch sent error

    On fetch error

    Join Requests: On fetch more sent

    On success fetch more

    Join Requests: On fetch more sent error

    On fetch more error

    Join Requests: On accept join request

    On accept join request

    Join Requests: On accept join request error

    On accept join request error

    Join Requests: On reject join request

    On reject join request

    Join Requests: On reject join request error

    On reject join request error

  • Expressions

    CurJoinRequestIndex

    Current join request index

    CurJoinRequestDate

    Current join request date

Invites

  • Actions

    Invites: Fetch incoming, limit: {0}, offset: {1}

    Get incoming invites list

    Invites: Fetch more incoming, limit: {0}

    Get more incoming invites of selected search params

    Invites: Fetch sent invites, limit: {0}, offset: {1}

    Get sent invites list

    Invites: Fetch more sent invites, limit: {0}

    Get more sent invites of selected search params

    Invites: Fetch in channel {0}, limit: {1}, offset: {2}

    Get invites list in channel

    Invites: Fetch more in channel {0}, limit: {1}

    Get more invites in channel of selected search params

    Invites: send invite to player {1} in channel {0}

    Send invite

    Invites: cancel invite to player {1} in channel {0}

    Cancel invite

    Invites: accept invite to channel {0}

    Accept invite

    Invites: reject invite to channel {0}

    Reject invite

  • Conditions

    For each invite

    For each invite in list. You need to fetch invites before

    Invites: On fetch

    On success fetch

    Invites: On fetch error

    On fetch error

    Invites: On fetch more

    On success fetch more

    Invites: On fetch more error

    On fetch more error

    Invites: On fetch channel invites

    On success fetch

    Invites: On fetch channel invites error

    On fetch error

    Invites: On fetch more channel invites

    On success fetch more

    Invites: On fetch more channel invites error

    On fetch more error

    Invites: On fetch sent

    On success fetch

    Invites: On fetch sent error

    On fetch error

    Invites: On fetch more sent

    On success fetch more

    Invites: On fetch more sent error

    On fetch more error

    Invites: On send invite

    On send invite

    Invites: On send invite error

    On send invite error

    Invites: On cancel invite

    On cancel invite

    Invites: On cancel invite error

    On cancel invite error

    Invites: On accept invite

    On accept invite

    Invites: On accept invite error

    On accept invite error

    Invites: On reject invite

    On reject invite

    Invites: On reject invite error

    On reject invite error

    Invites: Cur invite pick player TO

    Pick player state of recipient of the invitation to get access from methods CurPlayerGet, CurPlayerName, CurPlayerID, etc.

    Invites: Cur invite pick player FROM

    Pick player state of the sender of the invitation to get access from methods CurPlayerGet, CurPlayerName, CurPlayerID, etc.

  • Expressions

    CurInviteIndex

    Current invites index

    CurInviteDate

    Current invites date

Overlay

  • Actions

    Overlay: open main chat

    Open main chat using overlay

    Overlay: open chat for channel ID {0} with tags {1}

    Open chat using overlay

    Overlay: open personal chat for player ID {0} with tags {1}

    Open personal chat using overlay

    Overlay: open feed for player ID {0} with tags {1}

    Open feed using overlay

  • Conditions

    Overlay: On open chat

    On open chat

    Overlay: On open chat error

    On open chat error

    Overlay: on close chat

    On close chat

Players

  • Conditions

    Cur Player Has {0}

    Current player state has field and it's not empty

  • Expressions

    CurPlayerIndex

    Current player state index

    CurPlayerID

    Current player state ID

    CurPlayerName

    Current player state name

    CurPlayerAvatar

    Current player state avatar

    CurPlayerGet

    Current player state get field value

    CurPlayerGetNumber

    Current player state get field value converted to number

    CurPlayerHas

    Current player state has field and it's not empty

Messages

  • Actions

    Messages: Fetch {0} from channel: {1}, Tags: {2}, limit: {3}, offset: {4}

    Get messages list

    Messages: Fetch more {0} from channel: {1}, Tags: {2}, limit: {3}

    Get more messages of selected search params

    Messages: Fetch {0} personal messages with player: {1}, Tags: {2}, limit: {3}, offset: {4}

    Get personal messages list

    Messages: Fetch more {0} personal messages with player: {1}, Tags: {2}, limit: {3}

    Get more personal messages of selected search params

    Messages: Fetch {0} feed messages of player: {1}, Tags: {2}, limit: {3}, offset: {4}

    Get feed messages list

    Messages: Fetch more {0} feed messages of player: {1}, Tags: {2}, limit: {3}

    Get more feed messages of selected search params

    Messages: send {1} to channel {0}, Tags: {2}

    Send message to channel

    Messages: send {1} to player {0}, Tags: {2}

    Send personal message

    Messages: send {1} to player {0} feed, Tags: {2}

    Send feed message

    Messages: edit {0} message, set text: {1}

    Edit message by ID

    Messages: delete {0} message

    Delete message by ID

  • Conditions

    For each message

    For each message in list. You need to fetch messages before

    For each message reversed

    For each message in list, reversed. You need to fetch messages before

    For each current message tag

    For each current message tag

    Cur message target is {0}

    Current message target: channel, personal, feed. Only available on event notification

    Messages: On any fetch

    On any success fetch

    Messages: On any fetch error

    On any fetch error

    Messages: On {0} fetch

    On success fetch

    Messages: On {0} fetch error

    On fetch error

    Messages: On any fetch more

    On any success fetch more

    Messages: On any fetch more error

    On any fetch more error

    Messages: On {0} fetch more

    On success fetch more

    Messages: On {0} fetch more error

    On fetch more error

    Messages: On any fetch personal

    On any success fetch personal

    Messages: On any fetch personal error

    On any fetch personal error

    Messages: On {0} fetch personal

    On success fetch personal

    Messages: On {0} fetch personal error

    On fetch personal error

    Messages: On any fetch more personal

    On any success fetch more personal

    Messages: On any fetch more personal error

    On any fetch more personal error

    Messages: On {0} fetch more personal

    On success fetch more personal

    Messages: On {0} fetch more personal error

    On fetch more personal error

    Messages: On any fetch feed

    On any success fetch feed

    Messages: On any fetch feed error

    On any fetch feed error

    Messages: On {0} fetch feed

    On success fetch feed

    Messages: On {0} fetch feed error

    On fetch feed error

    Messages: On any fetch more feed

    On any success fetch more feed

    Messages: On any fetch more feed error

    On any fetch more feed error

    Messages: On {0} fetch more feed

    On success fetch more feed

    Messages: On {0} fetch more feed error

    On fetch more feed error

    Messages: On send

    On success send

    Messages: On send error

    On send error

    Messages: On edit

    On success edit

    Messages: On edit error

    On edit error

    Messages: On delete

    On success delete

    Messages: On delete error

    On delete error

  • Expressions

    CurMessageIndex

    Current message index

    CurMessageID

    Current message ID

    CurMessageChannelID

    Current message channel ID

    CurMessageText

    Current message text

    CurMessageAuthorID

    Current message author ID

    CurMessageCreatedAt

    Current message creation date in ISO 8601

    CurMessageTarget

    Current message target: channel, personal, feed. Only available on event notification

Common

  • Actions

    Common: Load from JSON {0}

    Load plugin state (player, ratings) from json

  • Conditions

    Common: On load JSON error

    Failed if data was corrupted

    Is Last Action Success

    Check if last action success

    Can load more

    Check if can load more items of last search query

    Common: is main chat enabled

    Check can open main chat using overlay

  • Expressions

    AsJSON

    Get Plugin state as JSON string

    LastError

    Last error message

    IsLastActionSuccess

    Check is last action success: 1 or 0

    MainChatID

    ID of main chat for overlay

Events

  • Conditions

    Events: On event

    On success event

    Events: On invite

    On event invite

    Events: On cancel invite

    On event cancel invite

    Events: On reject invite

    On event reject invite

    Events: On join

    On event join

    Events: On join request

    On event join request

    Events: On leave

    On event leave

    Events: On cancel join

    On event cancel join

    Events: On reject join jequest

    On event reject join jequest

    Events: On message

    On event message

    Events: On edit message

    On event edit message

    Events: On delete message

    On event delete message

    Events: On mute

    On event mute

    Events: On unmute

    On event unmute

    Events: On update channel

    On event update channel

    Events: On delete channel

    On event delete channel

    Events: Is {0}

    Check event type

    Events: Leave reason is {0}

    Check leave reason on leave event

  • Expressions

    EventType

    Current event type

    LeaveReason

    Leave reason: 'kick' | 'leave'