Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Doc improvements #80

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Doc improvements #80

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
204a85a
Updated protobuf documentation on CloakState
eminence Dec 9, 2017
d46baf8
Added comment about the Action message
eminence Dec 9, 2017
d788424
Updated comment about Action message
eminence Feb 8, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions s2clientprotocol/raw.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,10 +65,11 @@ enum Alliance {
Enemy = 4;
}

// Currently it is not possible to observe the "shimmer" of a cloaked and undetected unit.
enum CloakState {
Cloaked = 1;
CloakedDetected = 2;
NotCloaked = 3;
Cloaked = 1; // A unit that is currently cloaked. Only applies to your own units.
CloakedDetected = 2; // An enemy unit that was cloaked, but is currently being detected by a detector.
NotCloaked = 3; // A regular un-cloaked unit.
}

message PassengerUnit {
Expand Down
2 changes: 2 additions & 0 deletions s2clientprotocol/sc2api.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -567,6 +567,8 @@ message Observation {
optional ObservationUI ui_data = 8; // Populated if Feature Layer or Render interface is enabled.
}

// Only one of these Action fields should be set at once
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Only one of these would be set when making an action, but multiple are likely to be returned when getting the actions back in an observation (eg from a replay) since the action can be represented in multiple ways.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point! I just pushed an update

// TODO make this a `oneof` ?
message Action {
optional ActionRaw action_raw = 1; // Populated if Raw interface is enabled.
optional ActionSpatial action_feature_layer = 2; // Populated if Feature Layer interface is enabled.
Expand Down