RoomOptions

new RoomOptions(opt_dataopt)

Generated by JsPbCodeGenerator.
Parameters:
Name Type Attributes Description
opt_data Array <optional>
 Optional initial data array, typically from a server response, or constructed directly in Javascript. The array is used in place and becomes part of the constructed object. It is not cloned. If no data is provided, the constructed object will be empty, but still valid.

Extends

  • jspb.Message

Members

static displayName

Methods

static deserializeBinary(bytes) → non-null {proto.game_protobuf_messages.proto.messages.RoomOptions}

Deserializes binary data (in protobuf wire format).
Parameters:
Name Type Description
bytes jspb.ByteSource The bytes to deserialize.
Returns:
proto.game_protobuf_messages.proto.messages.RoomOptions

static deserializeBinaryFromReader(msgnon-null, readernon-null) → non-null {proto.game_protobuf_messages.proto.messages.RoomOptions}

Deserializes binary data (in protobuf wire format) from the given reader into the given message object.
Parameters:
Name Type Description
msg proto.game_protobuf_messages.proto.messages.RoomOptions The message object to deserialize into.
reader jspb.BinaryReader The BinaryReader to use.
Returns:
proto.game_protobuf_messages.proto.messages.RoomOptions

static serializeBinaryToWriter(messagenon-null, writernon-null)

Serializes the given message to binary data (in protobuf wire format), writing to the given BinaryWriter.
Parameters:
Name Type Description
message proto.game_protobuf_messages.proto.messages.RoomOptions
writer jspb.BinaryWriter

static toObject(includeInstance, msgnon-null) → non-null {Object}

Static version of the {@see toObject} method.
Parameters:
Name Type Description
includeInstance boolean | undefined Deprecated. Whether to include the JSPB instance for transitional soy proto support: http://goto/soy-param-migration
msg proto.game_protobuf_messages.proto.messages.RoomOptions The msg instance to transform.
Returns:
Object

addExpectMembers(value, opt_indexopt) → non-null {proto.game_protobuf_messages.proto.messages.RoomOptions}

Parameters:
Name Type Attributes Description
value string
opt_index number <optional>
Returns:
proto.game_protobuf_messages.proto.messages.RoomOptions - returns this

addLobbyAttrKeys(value, opt_indexopt) → non-null {proto.game_protobuf_messages.proto.messages.RoomOptions}

Parameters:
Name Type Attributes Description
value string
opt_index number <optional>
Returns:
proto.game_protobuf_messages.proto.messages.RoomOptions - returns this

addMembers(opt_valueopt, non-null, opt_indexopt) → non-null {proto.game_protobuf_messages.proto.messages.RoomMember}

Parameters:
Name Type Attributes Description
opt_value proto.game_protobuf_messages.proto.messages.RoomMember <optional>
opt_index number <optional>
Returns:
proto.game_protobuf_messages.proto.messages.RoomMember

clearExpectMembersList() → non-null {proto.game_protobuf_messages.proto.messages.RoomOptions}

Clears the list making it empty but non-null.
Returns:
proto.game_protobuf_messages.proto.messages.RoomOptions - returns this

clearLobbyAttrKeysList() → non-null {proto.game_protobuf_messages.proto.messages.RoomOptions}

Clears the list making it empty but non-null.
Returns:
proto.game_protobuf_messages.proto.messages.RoomOptions - returns this

clearMembersList() → non-null {proto.game_protobuf_messages.proto.messages.RoomOptions}

Clears the list making it empty but non-null.
Returns:
proto.game_protobuf_messages.proto.messages.RoomOptions - returns this

clearOpen() → non-null {proto.game_protobuf_messages.proto.messages.RoomOptions}

Clears the message field making it undefined.
Returns:
proto.game_protobuf_messages.proto.messages.RoomOptions - returns this

clearVisible() → non-null {proto.game_protobuf_messages.proto.messages.RoomOptions}

Clears the message field making it undefined.
Returns:
proto.game_protobuf_messages.proto.messages.RoomOptions - returns this

getAttr() → non-null {string|Uint8Array}

optional bytes attr = 9;
Returns:
string | Uint8Array

getAttr_asB64() → {string}

optional bytes attr = 9; This is a type-conversion wrapper around `getAttr()`
Returns:
string

getAttr_asU8() → non-null {Uint8Array}

optional bytes attr = 9; Note that Uint8Array is not supported on all browsers.
Returns:
Uint8Array
See:

getCid() → {string}

optional string cid = 1;
Returns:
string

getEmptyRoomTtl() → {number}

optional int32 empty_room_ttl = 4;
Returns:
number

getExpectMembersList() → non-null {Array.<string>}

repeated string expect_members = 10;
Returns:
Array.<string>

getFlag() → {number}

optional int64 flag = 7;
Returns:
number

getLobbyAttrKeysList() → non-null {Array.<string>}

repeated string lobby_attr_keys = 11;
Returns:
Array.<string>

getMasterActorId() → {number}

optional int32 master_actor_id = 14;
Returns:
number

getMaxMembers() → {number}

optional int32 max_members = 6;
Returns:
number

getMemberCount() → {number}

optional int32 member_count = 13;
Returns:
number

getMembersList() → non-null {Array.<!proto.game_protobuf_messages.proto.messages.RoomMember>}

repeated RoomMember members = 12;
Returns:
Array.<!proto.game_protobuf_messages.proto.messages.RoomMember>

getOpen() → nullable {proto.google.protobuf.BoolValue}

optional google.protobuf.BoolValue open = 3;
Returns:
proto.google.protobuf.BoolValue

getPlayerTtl() → {number}

optional int32 player_ttl = 5;
Returns:
number

getPluginName() → {string}

optional string plugin_name = 8;
Returns:
string

getVisible() → nullable {proto.google.protobuf.BoolValue}

optional google.protobuf.BoolValue visible = 2;
Returns:
proto.google.protobuf.BoolValue

hasOpen() → {boolean}

Returns whether this field is set.
Returns:
boolean

hasVisible() → {boolean}

Returns whether this field is set.
Returns:
boolean

serializeBinary() → non-null {Uint8Array}

Serializes the message to binary data (in protobuf wire format).
Returns:
Uint8Array

setAttr(valuenon-null) → non-null {proto.game_protobuf_messages.proto.messages.RoomOptions}

Parameters:
Name Type Description
value string | Uint8Array
Returns:
proto.game_protobuf_messages.proto.messages.RoomOptions - returns this

setCid(value) → non-null {proto.game_protobuf_messages.proto.messages.RoomOptions}

Parameters:
Name Type Description
value string
Returns:
proto.game_protobuf_messages.proto.messages.RoomOptions - returns this

setEmptyRoomTtl(value) → non-null {proto.game_protobuf_messages.proto.messages.RoomOptions}

Parameters:
Name Type Description
value number
Returns:
proto.game_protobuf_messages.proto.messages.RoomOptions - returns this

setExpectMembersList(valuenon-null) → non-null {proto.game_protobuf_messages.proto.messages.RoomOptions}

Parameters:
Name Type Description
value Array.<string>
Returns:
proto.game_protobuf_messages.proto.messages.RoomOptions - returns this

setFlag(value) → non-null {proto.game_protobuf_messages.proto.messages.RoomOptions}

Parameters:
Name Type Description
value number
Returns:
proto.game_protobuf_messages.proto.messages.RoomOptions - returns this

setLobbyAttrKeysList(valuenon-null) → non-null {proto.game_protobuf_messages.proto.messages.RoomOptions}

Parameters:
Name Type Description
value Array.<string>
Returns:
proto.game_protobuf_messages.proto.messages.RoomOptions - returns this

setMasterActorId(value) → non-null {proto.game_protobuf_messages.proto.messages.RoomOptions}

Parameters:
Name Type Description
value number
Returns:
proto.game_protobuf_messages.proto.messages.RoomOptions - returns this

setMaxMembers(value) → non-null {proto.game_protobuf_messages.proto.messages.RoomOptions}

Parameters:
Name Type Description
value number
Returns:
proto.game_protobuf_messages.proto.messages.RoomOptions - returns this

setMemberCount(value) → non-null {proto.game_protobuf_messages.proto.messages.RoomOptions}

Parameters:
Name Type Description
value number
Returns:
proto.game_protobuf_messages.proto.messages.RoomOptions - returns this

setMembersList(valuenon-null) → non-null {proto.game_protobuf_messages.proto.messages.RoomOptions}

Parameters:
Name Type Description
value Array.<!proto.game_protobuf_messages.proto.messages.RoomMember>
Returns:
proto.game_protobuf_messages.proto.messages.RoomOptions - returns this

setOpen(value) → non-null {proto.game_protobuf_messages.proto.messages.RoomOptions}

Parameters:
Name Type Description
value proto.google.protobuf.BoolValue | undefined
Returns:
proto.game_protobuf_messages.proto.messages.RoomOptions - returns this

setPlayerTtl(value) → non-null {proto.game_protobuf_messages.proto.messages.RoomOptions}

Parameters:
Name Type Description
value number
Returns:
proto.game_protobuf_messages.proto.messages.RoomOptions - returns this

setPluginName(value) → non-null {proto.game_protobuf_messages.proto.messages.RoomOptions}

Parameters:
Name Type Description
value string
Returns:
proto.game_protobuf_messages.proto.messages.RoomOptions - returns this

setVisible(value) → non-null {proto.game_protobuf_messages.proto.messages.RoomOptions}

Parameters:
Name Type Description
value proto.google.protobuf.BoolValue | undefined
Returns:
proto.game_protobuf_messages.proto.messages.RoomOptions - returns this

toObject(opt_includeInstanceopt) → non-null {Object}

Creates an object representation of this proto. Field names that are reserved in JavaScript and will be renamed to pb_name. Optional fields that are not set will be set to undefined. To access a reserved field use, foo.pb_, eg, foo.pb_default. For the list of reserved names please see: net/proto2/compiler/js/internal/generator.cc#kKeyword.
Parameters:
Name Type Attributes Description
opt_includeInstance boolean <optional>
 Deprecated. whether to include the JSPB instance for transitional soy proto support: http://goto/soy-param-migration
Returns:
Object