feat: alarm.add / alarm.delete and surface id in alarm rows#2
Closed
jonpepler wants to merge 3 commits into
Closed
feat: alarm.add / alarm.delete and surface id in alarm rows#2jonpepler wants to merge 3 commits into
jonpepler wants to merge 3 commits into
Conversation
Adds two action keys for stock-clock alarm management: alarm.add[title, ut, warpAction?, message?] → uint id alarm.delete[id] → bool Both manually queue the scenario mutation onto the main thread rather than using IsAction (which the auto-defer wrapper makes fire-and-forget) so alarm.add can return the new id sync in the same HTTP response. Also surfaces alarm.Id in the AlarmJSONFormatter row so existing alarm.list / alarm.nextAlarm callers can address alarms by id. The alarm.count / alarm.list / alarm.nextAlarm / alarm.timeToNext reads gain AlwaysEvaluable = true so they're queryable from the Space Center / Tracking Station, not just Flight.
Two pieces:
- tools/generate-openapi.ts now strips the `sourceFile` field
when writing docs/api-schema.json. The field leaks absolute
paths from the build machine into the committed artifact;
every rebuild from a different machine produced ~500 lines
of pure path churn in the diff.
- Rebuilt and regenerated docs to pick up alarm.add /
alarm.delete plus the AlwaysEvaluable flips on the existing
alarm.count / list / nextAlarm / timeToNext.
Owner
Author
|
Superseded by upstream PR TeaGuild#83 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds two action keys for stock-clock alarm management plus an
idfield in the alarm row.alarm.list/alarm.nextAlarmrows now include"id": <uint>so external clients can address an alarm.Why not IsAction?
alarm.addneeds to return the new alarm'suint Idsynchronously in the HTTP response, but the existingIsAction = truepath wraps the handler inqueueDelayed, which short-circuits the return tofalsewhile the real work runs on the next Unity tick. So this PR manually queues theAlarmClockScenario.AddAlarm/DeleteAlarmcall onto the main thread via the sameTelemachusBehaviour.queueDelayedAPIhook the auto-defer uses, while the caller returns its own value sync.The
AlarmTypeRawctor callsGetUniqueAlarmID()synchronously, soalarm.Idis already set by the time we read it on the dispatch thread.Other small changes
alarm.count / alarm.list / alarm.nextAlarm / alarm.timeToNextgainAlwaysEvaluable = trueso they're queryable from Space Center / Tracking Station, not just Flight.Test plan
GET /telemachus/datalink?a=alarm.add[Test,1234567,KillWarp,Yes]returns the new alarm's uint id; the alarm appears in stock KAC UI.GET /telemachus/datalink?a=alarm.listrows now includeidfield.GET /telemachus/datalink?a=alarm.delete[<id>]returnstrueif the alarm exists,falseotherwise, and the alarm vanishes from the UI on the next tick.warpAction/messageenums return a descriptive error string instead of throwing.