nolan/detective
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Describe room exits

Browse Source
This commit is contained in:
nolwn
2021-05-31 12:12:34 -07:00
parent b134f1849a
commit 8f6d7e4db4
4 changed files with 168 additions and 113 deletions
Download Patch File Download Diff File Expand all files Collapse all files

99
types.ts
View File

@ -1,27 +1,7 @@
/**
* types.ts describes basic types used by the engine.
*/
export * from "./data/rooms.ts";
// ActionArgs is a union of all the different argument types that can be used with an
// action
export type ActionArgs = ApplyEffectArgs;
// ItemActionType is a union of all the types of action that can be used
export type ItemActionType = "applyEffect";
// Args is a base interface for the various argument interfaces
export interface Args {
result: string;
}
// ItemAction represents an action that can be taken by an item
export interface ItemAction {
type: ItemActionType;
args: ActionArgs;
}
// ApplyEffectArgs are the arguments required to apply effects to a player or scene
export interface ApplyEffectArgs extends Args {
effect: string;
@ -36,28 +16,9 @@ export interface ApplyEffectItemAction extends ItemAction {
args: ApplyEffectArgs;
}
// Item represents some item either in the scene or in the player's inventory
export interface Item {
name: string;
actions: { [name: string]: ItemAction };
}
// Effect represents some effect that may be applied to a scene or player
export interface Effect<T extends VesselProperties> {
name: string;
properties: T;
source: "player" | "scene"; // where the effect is applied
}
// VesselProperties is a base interface for the properties that a user or scene might have
export interface VesselProperties {
items?: Item[];
}
// SceneProperties are the properties (in addition to the VesselProperties) that are
// needed by the scene
export interface SceneProperties extends VesselProperties {
description?: string;
// Args is a base interface for the various argument interfaces
export interface Args {
result: string;
}
// Conditions contains story elements that can be conditionally applied to the scene or
@ -66,8 +27,62 @@ export interface Conditions<T extends VesselProperties> {
effects: Effect<T>[];
}
// Direction is union that contains the different directions a player can go
export type Direction =
| "north"
| "northeast"
| "east"
| "southest"
| "south"
| "southwest"
| "west"
| "northwest"
| "up"
| "down";
// Effect represents some effect that may be applied to a scene or player
export interface Effect<T extends VesselProperties> {
name: string;
properties: T;
source: "player" | "scene"; // where the effect is applied
}
// Exit describes the exits that the user can take to go to another scene
export interface Exit {
description: string;
direction: Direction;
scene: string;
}
// Item represents some item either in the scene or in the player's inventory
export interface Item {
name: string;
actions: { [name: string]: ItemAction };
}
// ItemActionType is a union of all the types of action that can be used
export type ItemActionType = "applyEffect";
// ItemAction represents an action that can be taken by an item
export interface ItemAction {
type: ItemActionType;
args: ActionArgs;
}
// SceneProperties are the properties (in addition to the VesselProperties) that are
// needed by the scene
export interface SceneProperties extends VesselProperties {
description?: string;
exits?: Exit[];
}
// StoryScene holds both the conditions and properties for a scene.
export interface StoryScene<T extends VesselProperties> {
conditions: Conditions<T>;
properties: SceneProperties;
}
// VesselProperties is a base interface for the properties that a user or scene might have
export interface VesselProperties {
items?: Item[];
}