Colyseus (Multiplayer)


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


  • Actions

    Set endpoint to {0}

    Format: wss://example.com


  • Actions

    Join room {0} with options {1}.

    Join a room by name

    Join room {0} with options {1}.

    Join a room by name

    Create room {0} with options {1}.

    Create a room by name

    Join room {0} with options {1}.

    Join an existing room by its ID

    Consume seat reservation with {0}

    Consume a seat reservation made from the server-side

    Reconnect into room {0} with sessionId {1}.

    Reconnect using a previously connected room

    Send {0} with {1}

    Send message to a room

    Send {0} with {1}

    Send JSON message to a room

    Leave from the room

    Disconnect client from the room.

    Get available {0} rooms.

    Get available rooms by name, OnGetAvailableRooms triggered when data is available. Data returned as JSON string in expression CurrentValue

  • Conditions

    On Join

    Triggered when joined successfully into a room.

    On Leave

    Triggered when left from a room.

    On Error

    Triggered when an error happened on the server.

    On Message ({0})

    Triggered when the room broadcasts a message, or sends a message directly to this client.

    On State Change

    Triggered when the state of the room changes.

    On Get Available Rooms

    Triggers when available rooms data is ready in the CurrentValue expresssion.

  • Expressions


    Get a value from room's state


    Unique sessionId of the current user


    Get last error code


    Get last error message


  • Conditions

    On add at {0}

    Triggers when an item is added to ArraySchema or MapSchema.

    On field change at {0}

    Triggers when a field is changed inside a Schema instance. Need to use

    On change at {0}

    Triggers when an item is changed inside ArraySchema or MapSchema.

    On remove at {0}

    Triggers when an item is removed from ArraySchema or MapSchema.

    Is index {0}

    Only available for Arrays and Maps. Check if index of current item is equals to provided value.

    Is field {0}

    Only available during "On change" of a direct object. Checks if a field name has changed.

  • Expressions


    Declare a JSON value.


    Get index of current item. Available during "On Add", "On Change" or "On Remove"


    Get current field being changed. Available during "On field change"


    Get value from current item


    Get previous value from current field. Only available during "On change" on an instance variable. Not avaialble for arrays and maps.


    Get nested value from current item

Download Stable (47.93 KB)



  • Download count1,806 total downloads
  • Latest download count 30 downloads of latest version
  • Average download count2 downloads per day average



  • Order by
Want to leave a comment? Login or Register an account!
  • the chat c3p says its not a valid c3p single file when i try to open

  • Yay! 0.14.1 update!

  • Hi, I cant open the project.c3p, i got this message : Failed to open project. Check it is a valid Construct 3 single-file (.c3p) project. can you update it please?

  • Excellent plugin! Note to users, the server is on version 0.11 and there is a version 0.11 of the plugin (on the Colyseus Discord in #construct.)

  • Hi there, I am struggling to open your example, I am on build 170.

    Error: Failed to open project. Check it is a valid Construct 3 single-file (.c3p) project.

  • Can this be used with Meteor.com which is a stack of Node?

  • "Cannot Read property 'send' of undefined"

    Going Create a Server and using top down shooter template. when touch or click, gives a error.

  • Awesome stuff, although most live examples are currently broken, I could still manage to get 2 clients moving around. I started from the drawing prototype.

  • Simillar to your own example


    Also Does Not work..

    Right now, i am looking for Photon Cloud alternative.

    Even your plugin feature does not match photon cloud plugin currently, not as complex as photon cloud, But your Price Plan are really friendly for us the game hobiest.

    That's why i am heavily interested to your plugin.

    This is what Multiplayer lover looking for for all the time.

    Thanks for your hard work..

  • Hello, i've tried to install my own Colyseus server on Heruku.

    But it seems the "Create or Join Room.html" DOES NOT work.

    Please Check my Colyseus server on Heruku here:


    You can see that the page does not working properly.

    The other html pages are OK..

  • Load more comments (2 replies)