new CommandContext(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. |
- Source:
Extends
- jspb.Message
Classes
Members
(static) displayName
- Source:
Methods
clearActorContext() → (non-null) {proto.spine.core.CommandContext}
Clears the message field making it undefined.
- Source:
Returns:
returns this
clearAttributesMap() → (non-null) {proto.spine.core.CommandContext}
Clears values from the map. The map will be non-null.
- Source:
Returns:
returns this
clearOrigin() → (non-null) {proto.spine.core.CommandContext}
Clears the message field making it undefined.
- Source:
Returns:
returns this
clearSchedule() → (non-null) {proto.spine.core.CommandContext}
Clears the message field making it undefined.
- Source:
Returns:
returns this
getActorContext() → (nullable) {proto.spine.core.ActorContext}
optional ActorContext actor_context = 1;
- Source:
Returns:
getAttributesMap(opt_noLazyCreateopt) → (non-null) {jspb.Map.<string, !proto.google.protobuf.Any>}
map attributes = 3;
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
opt_noLazyCreate |
boolean |
<optional> |
Do not create the map if empty, instead returning `undefined` |
- Source:
Returns:
- Type
- jspb.Map.<string, !proto.google.protobuf.Any>
getOrigin() → (nullable) {proto.spine.core.Origin}
optional Origin origin = 5;
- Source:
Returns:
getSchedule() → (nullable) {proto.spine.core.CommandContext.Schedule}
optional Schedule schedule = 4;
- Source:
Returns:
getTargetVersion() → {number}
optional int32 target_version = 2;
- Source:
Returns:
- Type
- number
hasActorContext() → {boolean}
Returns whether this field is set.
- Source:
Returns:
- Type
- boolean
hasOrigin() → {boolean}
Returns whether this field is set.
- Source:
Returns:
- Type
- boolean
hasSchedule() → {boolean}
Returns whether this field is set.
- Source:
Returns:
- Type
- boolean
serializeBinary() → (non-null) {Uint8Array}
Serializes the message to binary data (in protobuf wire format).
- Source:
Returns:
- Type
- Uint8Array
setActorContext(value) → (non-null) {proto.spine.core.CommandContext}
Parameters:
Name | Type | Description |
---|---|---|
value |
proto.spine.core.ActorContext | undefined |
- Source:
Returns:
returns this
setOrigin(value) → (non-null) {proto.spine.core.CommandContext}
Parameters:
Name | Type | Description |
---|---|---|
value |
proto.spine.core.Origin | undefined |
- Source:
Returns:
returns this
setSchedule(value) → (non-null) {proto.spine.core.CommandContext}
Parameters:
Name | Type | Description |
---|---|---|
value |
proto.spine.core.CommandContext.Schedule | undefined |
- Source:
Returns:
returns this
setTargetVersion(value) → (non-null) {proto.spine.core.CommandContext}
Parameters:
Name | Type | Description |
---|---|---|
value |
number |
- Source:
Returns:
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 |
- Source:
Returns:
- Type
- Object
(static) deserializeBinary(bytes) → (non-null) {proto.spine.core.CommandContext}
Deserializes binary data (in protobuf wire format).
Parameters:
Name | Type | Description |
---|---|---|
bytes |
jspb.ByteSource | The bytes to deserialize. |
- Source:
Returns:
(static) deserializeBinaryFromReader(msgnon-null, readernon-null) → (non-null) {proto.spine.core.CommandContext}
Deserializes binary data (in protobuf wire format) from the
given reader into the given message object.
Parameters:
Name | Type | Description |
---|---|---|
msg |
proto.spine.core.CommandContext | The message object to deserialize into. |
reader |
jspb.BinaryReader | The BinaryReader to use. |
- Source:
Returns:
(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.spine.core.CommandContext | |
writer |
jspb.BinaryWriter |
- Source:
(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.spine.core.CommandContext | The msg instance to transform. |
- Source:
Returns:
- Type
- Object