js doc composer for interop with visual paradigm

This commit is contained in:
2024-11-27 09:05:37 +02:00
parent c2245d92b3
commit 54b8941f3c
9 changed files with 186 additions and 30 deletions
+105 -1
View File
@@ -73,10 +73,114 @@ class ScenariosManager{
class Scenario {
/**
* Scenario name
* @type string
* @type {string}
*/
name = null;
/**
* Scenario levels
* @type {Level[]}
*/
levels = [];
}
/**
* Game scenario level
*/
class Level {
/**
* Scenario name
* @type {string}
*/
name = null;
/**
* Active objects
* @type {LevelObject[]}
*/
activeObjects = []
}
/**
* Game object associated to a level
*/
class LevelObject {
/**
* Associated game object
* @type {GameObject}
*/
gameObject = null;
/**
* Available actions
* @type {GameAction}
*/
actions = []
}
/**
* Action associated to game object
*/
class GameAction {
/**
* Scenario name
* @type {string}
*/
name = null;
/**
* Scenario name
* @type {string}
*/
description = null;
/**
* Associated inventory item
* @type {InventoryItem}
*/
inventoryItem = null;
/**
* Available outcomes from the action
* @type {GameActionResult}
*/
results = []
}
/**
* Result associated to game action
*/
class GameActionResult{
pointsRuleDefinition = null;
/**
* Scenario name
* @type {string}
*/
name = null;
/**
* Scenario name
* @type {string}
*/
description = null;
}
/**
* Inventory item required to perform specific action
*/
class InventoryItem {
/**
* Scenario name
* @type {string}
*/
name = null;
/**
* Scenario name
* @type {string}
*/
description = null;
}
export { ScenariosManager }