Understand Networked Events
Analyzes and explains the communication flow of networked events between clients and servers in a Highrise Studio project.
The source repository doesn't declare a license. Check its terms before reusing the code.
Key features
- Identifies all scripts that reference a specified event.
- Locates event connection points like `Connect()`, `Fire*()`, and `.Changed`.
- Traces the flow of communication between clients and servers for a given event.
- Generates a reusable scenario file documenting the event's behavior.
- Summarizes an event's overall purpose and usage within the project.
Use cases
- Debugging issues where a networked event is not firing or behaving as expected.
- Onboarding to a new project and needing to understand its communication architecture.
- Refactoring code involving client-server interactions to ensure no functionality is broken.
FAQ
What does the Understand Networked Events skill do?
This skill analyzes how a specific networked event is used within a Highrise Studio project. It traces the complete communication flow between clients and servers, identifies all relevant scripts, and summarizes the event's purpose.
When should I use this skill?
Use this skill when you're debugging a networked feature, trying to understand legacy code, or need to map how a client action triggers a server response (or vice-versa) for a particular event without manually searching through the codebase.
How does this skill improve my workflow?
It saves significant development time by automatically locating all event connection points (like `Connect()`, `Fire*()`, and `.Changed`) across multiple scripts. This eliminates tedious manual searches and provides a clear, documented summary of an event's behavior.
What are its main capabilities?
It can identify every script referencing an event, trace the full client-server communication path, pinpoint specific connection points, generate a reusable scenario file for documentation, and provide a high-level summary of the event's function.