Skip to content

Conversation

@abeizer
Copy link
Contributor

@abeizer abeizer commented Dec 11, 2024

What has been done

Out of Scope

Interacting with segments outside of playing + stopping them. We will be getting more interaction with segments (creation and editing) in upcoming PRs.


Find the pull request instructions here

Every reviewer and the owner of the PR should consider these points in their request (feel free to copy this checklist so you can fill it out yourself in the overall PR comment)

  • The code is extensible and backward compatible
  • New public interfaces are extensible and open to backward compatibility in the future
  • If preparing to remove a field in the future (i.e. this PR removes an argument), the argument stays but is no longer functional, and attaches a deprecation warning. A linear task is also created to track this deletion task.
  • Non-critical or potentially modifiable arguments are optional
  • Breaking changes and the approach to handling them have been verified with the team (in the Linear task, design doc, or PR itself)
  • The code is easy to read
  • Unit tests are added for expected and edge cases
  • Integration tests are added for expected and edge cases
  • Functions and classes are documented
  • Migrations for both up and down operations are completed
  • A documentation PR is created and being reviewed for anything in this PR that requires knowledge to use
  • Implications on other dependent code (i.e. sample games and sample bots) is considered, mentioned, and properly handled
  • Style changes and other non-blocking changes are marked as non-blocking from reviewers

@abeizer abeizer changed the title [REG-2217] [REG-2217] Send available segments to dashboard Dec 11, 2024
@abeizer abeizer marked this pull request as ready for review December 11, 2024 23:50
Copy link
Contributor

@nAmKcAz nAmKcAz left a comment

Choose a reason for hiding this comment

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

Mostly looks good, a few small requests to rename some methods and do an error case check.

SendAvailableSequences();
}

private void LoadAvailableSegments()
Copy link
Contributor

Choose a reason for hiding this comment

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

based on the method naming, I don't like how these methods implicitly send the status as well, maybe rename them to better represent that they do that ?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated the name to indicate that this does send segments after loading them

{
botManager.OnBeginPlaying();
}
var playbackController = FindObjectOfType<BotSegmentsPlaybackController>();
Copy link
Contributor

Choose a reason for hiding this comment

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

this is fine for the initial POC, but we'll need to decide when we're doing away with the in game overlay

for now.. they could easily conflict

either way, we should probably at least check here that so segment/sequence is running in case the client UI is somehow out of sync

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Play now only works if something isn't already playing

AvailableSegments,

// info about the currently-running sequence (or segment)
ActiveSequence,
Copy link
Contributor

Choose a reason for hiding this comment

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

Future (non-blocking), I have a task to create a status manager to better isolate the current status of which segment we're on, what the current error state is, whether exploration is active, and the current exploration error state. We'll want to be able to sync that to the client, but I wanted to put this comment here for visibility into what is coming

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah, would love to adopt Addison's mockups into this dashboard. We have a lot more freedom here to show detailed information about the current segment, progression through a sequence, any errors, etc.

@abeizer abeizer requested a review from nAmKcAz December 12, 2024 20:29
Base automatically changed from abby/reg-2200 to dashboard-wip December 16, 2024 16:26
@abeizer abeizer merged commit 0aa06d7 into dashboard-wip Dec 16, 2024
2 checks passed
@abeizer abeizer deleted the abby/reg-2217 branch December 16, 2024 16:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants