Package com.heroiclabs.nakama.api

Interface TournamentOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Tournament, Tournament.Builder
public interface TournamentOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    getCanEnter()
    True if the tournament is active and can enter.
    int
    getCategory()
    The category of the tournament.
    Timestamp
    getCreateTime()
    The UNIX time when the tournament was created.
    TimestampOrBuilder
    getCreateTimeOrBuilder()
    The UNIX time when the tournament was created.
    String
    getDescription()
    The description of the tournament.
    com.google.protobuf.ByteString
    getDescriptionBytes()
    The description of the tournament.
    int
    getDuration()
    Duration of the tournament in seconds.
    int
    getEndActive()
    The UNIX time when the tournament stops being active until next reset.
    Timestamp
    getEndTime()
    The UNIX time when the tournament will be stopped.
    TimestampOrBuilder
    getEndTimeOrBuilder()
    The UNIX time when the tournament will be stopped.
    String
    getId()
    The ID of the tournament.
    com.google.protobuf.ByteString
    getIdBytes()
    The ID of the tournament.
    int
    getMaxNumScore()
    The maximum score updates allowed per player for the current tournament.
    int
    getMaxSize()
    The maximum number of players for the tournament.
    String
    getMetadata()
    Additional information stored as a JSON object.
    com.google.protobuf.ByteString
    getMetadataBytes()
    Additional information stored as a JSON object.
    int
    getNextReset()
    The UNIX time when the tournament is next playable.
    int
    getSize()
    The current number of players in the tournament.
    int
    getSortOrder()
    ASC or DESC sort mode of scores in the tournament.
    int
    getStartActive()
    The UNIX time when the tournament start being active.
    Timestamp
    getStartTime()
    The UNIX time when the tournament will start.
    TimestampOrBuilder
    getStartTimeOrBuilder()
    The UNIX time when the tournament will start.
    String
    getTitle()
    The title for the tournament.
    com.google.protobuf.ByteString
    getTitleBytes()
    The title for the tournament.
    boolean
    hasCreateTime()
    The UNIX time when the tournament was created.
    boolean
    hasEndTime()
    The UNIX time when the tournament will be stopped.
    boolean
    hasStartTime()
    The UNIX time when the tournament will start.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getId

      String getId()
       The ID of the tournament.
      string id = 1;
      Returns:
      The id.

    • getIdBytes

      com.google.protobuf.ByteString getIdBytes()
       The ID of the tournament.
      string id = 1;
      Returns:
      The bytes for id.

    • getTitle

      String getTitle()
       The title for the tournament.
      string title = 2;
      Returns:
      The title.

    • getTitleBytes

      com.google.protobuf.ByteString getTitleBytes()
       The title for the tournament.
      string title = 2;
      Returns:
      The bytes for title.

    • getDescription

      String getDescription()
       The description of the tournament. May be blank.
      string description = 3;
      Returns:
      The description.

    • getDescriptionBytes

      com.google.protobuf.ByteString getDescriptionBytes()
       The description of the tournament. May be blank.
      string description = 3;
      Returns:
      The bytes for description.

    • getCategory

      int getCategory()
       The category of the tournament. e.g. "vip" could be category 1.
      uint32 category = 4;
      Returns:
      The category.

    • getSortOrder

      int getSortOrder()
       ASC or DESC sort mode of scores in the tournament.
      uint32 sort_order = 5;
      Returns:
      The sortOrder.

    • getSize

      int getSize()
       The current number of players in the tournament.
      uint32 size = 6;
      Returns:
      The size.

    • getMaxSize

      int getMaxSize()
       The maximum number of players for the tournament.
      uint32 max_size = 7;
      Returns:
      The maxSize.

    • getMaxNumScore

      int getMaxNumScore()
       The maximum score updates allowed per player for the current tournament.
      uint32 max_num_score = 8;
      Returns:
      The maxNumScore.

    • getCanEnter

      boolean getCanEnter()
       True if the tournament is active and can enter. A computed value.
      bool can_enter = 9;
      Returns:
      The canEnter.

    • getEndActive

      int getEndActive()
       The UNIX time when the tournament stops being active until next reset. A computed value.
      uint32 end_active = 10;
      Returns:
      The endActive.

    • getNextReset

      int getNextReset()
       The UNIX time when the tournament is next playable. A computed value.
      uint32 next_reset = 11;
      Returns:
      The nextReset.

    • getMetadata

      String getMetadata()
       Additional information stored as a JSON object.
      string metadata = 12;
      Returns:
      The metadata.

    • getMetadataBytes

      com.google.protobuf.ByteString getMetadataBytes()
       Additional information stored as a JSON object.
      string metadata = 12;
      Returns:
      The bytes for metadata.

    • hasCreateTime

      boolean hasCreateTime()
       The UNIX time when the tournament was created.
      .google.protobuf.Timestamp create_time = 13;
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      Timestamp getCreateTime()
       The UNIX time when the tournament was created.
      .google.protobuf.Timestamp create_time = 13;
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      TimestampOrBuilder getCreateTimeOrBuilder()
       The UNIX time when the tournament was created.
      .google.protobuf.Timestamp create_time = 13;

    • hasStartTime

      boolean hasStartTime()
       The UNIX time when the tournament will start.
      .google.protobuf.Timestamp start_time = 14;
      Returns:
      Whether the startTime field is set.

    • getStartTime

      Timestamp getStartTime()
       The UNIX time when the tournament will start.
      .google.protobuf.Timestamp start_time = 14;
      Returns:
      The startTime.

    • getStartTimeOrBuilder

      TimestampOrBuilder getStartTimeOrBuilder()
       The UNIX time when the tournament will start.
      .google.protobuf.Timestamp start_time = 14;

    • hasEndTime

      boolean hasEndTime()
       The UNIX time when the tournament will be stopped.
      .google.protobuf.Timestamp end_time = 15;
      Returns:
      Whether the endTime field is set.

    • getEndTime

      Timestamp getEndTime()
       The UNIX time when the tournament will be stopped.
      .google.protobuf.Timestamp end_time = 15;
      Returns:
      The endTime.

    • getEndTimeOrBuilder

      TimestampOrBuilder getEndTimeOrBuilder()
       The UNIX time when the tournament will be stopped.
      .google.protobuf.Timestamp end_time = 15;

    • getDuration

      int getDuration()
       Duration of the tournament in seconds.
      uint32 duration = 16;
      Returns:
      The duration.

    • getStartActive

      int getStartActive()
       The UNIX time when the tournament start being active. A computed value.
      uint32 start_active = 17;
      Returns:
      The startActive.