Repository navigation
Replies: 2 comments
|
Event names vs. Event types: We intend to have both the human-readable event names, and to add a new field that would use a 4-digit int (effectively an enum) to denote the general "type" of event. The event standard would reserve most of the space for defined event types, and the remainder would be for free use by individual games with no assumptions made about usage. The expectation is that each event type has a generic name, e.g. "inspect_object." This is just giving us a general way to refer to e.g. event type 4221. We don't assume that all games use the same names, e.g. one game might already have an event named "inspect_tool", and another might have "inspect_plant", even though they carry the same meaning within their individual games/game mechanics. Thus, we don't assume a 1-to-1 relationship between event name and event type. Taking this a step further, there's no inherent need for a 1-to-1 relationship within a single game. For example, Bloom has events for However, there's a tradeoff here. The data becomes a bit less readable if all inspects are labeled |
|
Level of enforcement of standard: There's tradeoff implicit in exactly how strict the "event standard" is enforced vs. what conveniences it can support. Regarding the event types defined by the event standard, the expectation is that the library would e.g. let the game engineer define for each logging call what event type they want (perhaps through an enum, so we avoid typos that give you e.g. a 1001 where a 1002 is intended, in other words we want to hide the exact numbers as much as possible). We would expect each event type to define a common set of elements that belong in the Beyond that, there's room to discuss whether to strictly enforce these on implementation side. This could reduce the situations where we rely on people to custom-build objects and do marshalling and stringifying and whatever else correctly. On the other hand, it could be annoying and/or limiting to do that kind of enforcement, and we could adopt a philosophy that it is the game engineer's responsibility to follow standard. |
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
We are currently working to develop an event standard for OpenGameData. This will include both the top-level event schema (#7), as well as standard event types, which we'll map to common sets of data keys for the
event_datapayload.This discussion is going to be a working space for notes on specific anticipated issues and such to resolve whenever we reach a point of working to implement the standard in this library (and the JS lib, eventually).
All reactions