docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class BackfillingConfiguration

    Allow to configure the backfilling behavior on the session.

    Inheritance
    object
    BackfillingConfiguration
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: Unity.Services.Multiplayer
    Assembly: Unity.Services.Multiplayer.dll
    Syntax
    public class BackfillingConfiguration

    Properties

    AutoStart

    Define if the backfilling will start automatically when a player is missing. If set to false, it is possible to start backfilling manually using StartBackfilling() on the Session.

    Declaration
    public bool AutoStart { get; }
    Property Value
    Type Description
    bool

    AutomaticallyRemovePlayers

    Define if players leaving the session are automatically removed from the backfill. If set to false, players leaving the session will stay in the backfill ticket preventing them from joining again.

    Declaration
    public bool AutomaticallyRemovePlayers { get; }
    Property Value
    Type Description
    bool

    BackfillingLoopInterval

    The time between each backfill approval request. Default value is 1 second. Value is invalid if below 0

    Declaration
    public int BackfillingLoopInterval { get; }
    Property Value
    Type Description
    int

    Enable

    Allow the matchmaker to backfill the session if it is not full, not locked, and not private.

    Declaration
    public bool Enable { get; set; }
    Property Value
    Type Description
    bool

    PlayerConnectionTimeout

    The time in seconds that a player who was added from backfilling has to connect to a session before being automatically removed. Default value is 30 seconds. If value is set to 0, the player will never be removed.

    Declaration
    public int PlayerConnectionTimeout { get; set; }
    Property Value
    Type Description
    int

    Methods

    WithBackfillingConfiguration(bool, bool, bool, int, int)

    Declaration
    public static BackfillingConfiguration WithBackfillingConfiguration(bool enable = true, bool automaticallyRemovePlayers = true, bool autoStart = true, int playerConnectionTimeout = 30, int backfillingLoopInterval = 1)
    Parameters
    Type Name Description
    bool enable
    bool automaticallyRemovePlayers
    bool autoStart
    int playerConnectionTimeout
    int backfillingLoopInterval
    Returns
    Type Description
    BackfillingConfiguration

    Did you find this page useful? Please give it a rating:

    Thanks for rating this page!

    Report a problem on this page

    What kind of problem would you like to report?

    • This page needs code samples
    • Code samples do not work
    • Information is missing
    • Information is incorrect
    • Information is unclear or confusing
    • There is a spelling/grammar error on this page
    • Something else

    Thanks for letting us know! This page has been marked for review based on your feedback.

    If you have time, you can provide more information to help us fix the problem faster.

    Provide more information

    You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:

    You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:

    You've told us there is information missing from this page. Please tell us more about what's missing:

    You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:

    You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:

    You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:

    You've told us this page has a problem. Please tell us more about what's wrong:

    Thank you for helping to make the Unity documentation better!

    Your feedback has been submitted as a ticket for our documentation team to review.

    We are not able to reply to every ticket submitted.

    In This Article
    • Properties
      • AutoStart
      • AutomaticallyRemovePlayers
      • BackfillingLoopInterval
      • Enable
      • PlayerConnectionTimeout
    • Methods
      • WithBackfillingConfiguration(bool, bool, bool, int, int)
    Back to top
    Copyright © 2024 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)