Lens Scripting API
    Preparing search index...

    Class MatchmakingConfig

    Configuration for matchmaking when creating a session. If not set on session options, no matchmaking occurs (direct session join).

    Lens Scripting Version 375

    Hierarchy (View Summary)

    Index

    Properties

    maxPlayerCount minPlayerCount targetPlayerCount

    Methods

    create getMaxPlayerCountLimit getMinPlayerCountLimit getTypeName getTypeName isOfType isSame

    Properties

    maxPlayerCount: number

    Maximum number of players allowed in the match. Must be at least 2 and at most 64.

    Lens Scripting Version 375

    minPlayerCount: number

    Minimum number of players required to start the match. Must be at least 1.

    Lens Scripting Version 375

    targetPlayerCount: number

    Target number of players that matchmaking attempts to fill for the session. Defaults to minPlayerCount if not explicitly set.

    Lens Scripting Version 375

    null

    Methods

    • Creates a new MatchmakingConfig instance with the specified player counts.

      Parameters

      • minPlayerCount: number

        Minimum players required (1-64)

      • maxPlayerCount: number

        Maximum players allowed (2-64, must be >= minPlayerCount)

      • OptionaltargetPlayerCount: number

        Optional. Number of players matchmaking aims to fill the session with. Omit it to leave the target unset, in which case matchmaking uses minPlayerCount. Equivalent to assigning ConnectedLensModule.MatchmakingConfig#targetPlayerCount afterwards.

      Returns MatchmakingConfig

      Lens Scripting Version 375

    • Returns the maximum allowed value for maxPlayerCount.

      Returns number

      Lens Scripting Version 375

    • Returns the minimum allowed value for minPlayerCount.

      Returns number

      Lens Scripting Version 375

    • Returns the fully-qualified JavaScript type name for this class (for example, "Component.Camera"). This is a static accessor (no instance required) and returns the same value as the instance getTypeName().

      Returns string

      Lens Scripting Version 375

    • Returns true if the object matches or derives from the passed in type.

      Parameters

      • type: string

      Returns boolean

    • Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

      Parameters

      Returns boolean

    Settings

    Member Visibility

    On This Page

    Properties
    Methods