@m2c2kit/core 0.1.2 → 0.1.3

package/dist/index.d.ts

@@ -72,13 +72,16 @@ declare class GlobalVariables {
 
 declare global {
     var Globals: GlobalVariables;
-}
+}
+//# sourceMappingURL=Globals.d.ts.map
 
 /**
  * Position in two-dimensional space.
  */
 declare class Point {
+    /** Horizonal coordinate */
     x: number;
+    /** Vertical coordinate */
     y: number;
     constructor(x?: number, y?: number);
 }
@@ -98,15 +101,25 @@ interface TapEvent {
 }
 
 interface Constraints {
+    /** Constrain the top (vertical axis) of this entity to the top of the specified entity. The tops of both will appear at the same vertical location */
     topToTopOf?: Entity | string;
+    /** Constrain the top (vertical axis) of this entity to the bottom of the specified entity. This entity will appear immediately below the specified entity */
     topToBottomOf?: Entity | string;
+    /** Constrain the bottom (vertical axis) of this entity to the top of the specified entity. This entity will appear immediately above of the specified entity */
     bottomToTopOf?: Entity | string;
+    /** Constrain the bottom (vertical axis) of this entity to the bottom of the specified entity. The bottoms of both will appear at the same vertical location */
     bottomToBottomOf?: Entity | string;
+    /** Constrain the start (horizontal axis) of this entity to the start of the specified entity. The start of both will appear at the same horizontal location */
     startToStartOf?: Entity | string;
+    /** Constrain the start (horizontal axis) of this entity to the end of the specified entity. This entity will appear immediately to the right of the specified entity */
     startToEndOf?: Entity | string;
+    /** Constrain the end (horizontal axis) of this entity to the end of the specified entity. The end of both will appear at the same horizontal location */
     endToEndOf?: Entity | string;
+    /** Constrain the end (horizontal axis) of this entity to the start of the specified entity. This entity will appear immediately to the left of the specified entity */
     endToStartOf?: Entity | string;
+    /** When opposing horizontal constraints are applied, the default is to center the entity within the constraints (horizontalBias = .5). Setting horizontalBias less than .5 will pull the entity towards the start (to the left). Setting horizontalBias greater than .5 will pull the entity towards the end (to the right)  */
     horizontalBias?: number;
+    /** When opposing vertical constraints are applied, the default is to center the entity within the constraints (verticalBias = .5). Setting verticalBias less than .5 will pull the entity towards the top. Setting verticalBias greater than .5 will pull the entity towards the bottom */
     verticalBias?: number;
     [key: string]: Entity | string | number | undefined;
 }
@@ -136,11 +149,17 @@ declare class Size {
 }
 
 interface EntityOptions {
+    /** Name of the entity. Only needed if the entity will be referred to by name in a later function */
     name?: string;
+    /** Position of the entity within its parent coordinate system. Default is (0, 0) */
     position?: Point;
+    /** Scale of the entity. Default is 1.0 */
     scale?: number;
+    /** Does the entity respond to user events, such as taps? Default is false */
     isUserInteractionEnabled?: boolean;
+    /** Is the entity, and its children, hidden? (not displayed). Default is false */
     hidden?: boolean;
+    /** FOR INTERNAL USE ONLY */
     layout?: Layout;
 }
 
@@ -155,7 +174,7 @@ declare enum EntityType {
 }
 
 declare function handleInterfaceOptions(entity: Entity, options: EntityOptions): void;
-declare abstract class Entity {
+declare abstract class Entity implements EntityOptions {
     type: EntityType;
     isDrawable: boolean;
     isShape: boolean;
@@ -214,6 +233,12 @@ declare abstract class Entity {
      * Returns all descendant entities. Descendants are children and children of children, recursively.
      */
     get descendants(): Array<Entity>;
+    /**
+     * Provides the callback function to be executed when the user taps the entity.
+     *
+     * @param codeCallback - function to execute
+     * @param replaceExistingCodeCallback  - should the provided callback replace any existing callbacks? Usually we want to have only one callback defined, instead of chaining multiple ones. It is strongly recommended not to change this, unless you have a special use case. Default is true.
+     */
     onTap(codeCallback: (tapEvent: TapEvent) => void, replaceExistingCodeCallback?: boolean): void;
     private parseLayoutConstraints;
     private calculateYFromConstraint;
@@ -480,10 +505,11 @@ declare enum Dimensions {
 }
 
 interface SceneOptions extends EntityOptions, DrawableOptions {
+    /** Background color of the scene. Default is Constants.DEFAULT_SCENE_BACKGROUND_COLOR (WebColors.WhiteSmoke) */
     backgroundColor?: RgbaColor;
 }
 
-declare class Scene extends Entity implements IDrawable {
+declare class Scene extends Entity implements IDrawable, SceneOptions {
     readonly type = EntityType.scene;
     isDrawable: boolean;
     anchorPoint: Point;
@@ -499,8 +525,7 @@ declare class Scene extends Entity implements IDrawable {
      *
      * @remarks The scene is the game screen or stage, and fills the entire available screen. There are usually multiple screens to contain multiple stages of the game, such as various instruction pages or phases of a game.
      *
-     * @param options
-     * @see {@link SceneOptions}
+     * @param options - {@link SceneOptions}
      */
     constructor(options?: SceneOptions);
     initialize(): void;
@@ -522,6 +547,13 @@ declare class Scene extends Entity implements IDrawable {
 declare abstract class Transition {
     abstract type: TransitionType;
     duration: number;
+    /**
+     * Creates a scene transition in which the outgoing scene slides out and the incoming scene slides in, as if the incoming scene pushes it.
+     *
+     * @param direction - TransitionDirection in which the push action goes
+     * @param duration - Duration, in millis, of the transition
+     * @returns
+     */
     static push(direction: TransitionDirection, duration: number): PushTransition;
 }
 declare class PushTransition extends Transition {
@@ -636,15 +668,20 @@ declare class Game {
      * at the appropriate time. It is not triggered automatically.
      * @param codeCallback
      */
-    onAllTrialsComplete(codeCallback: (data: GameData) => void): void;
+    onAllTrialsComplete(codeCallback: (data: GameData, trialSchema: object) => void): void;
     /**
      * Adds a scene to the game.
      *
-     * @remarks A scene, and its children entities, cannot be preseneted unless it has been added to the game object.
+     * @remarks A scene, and its children entities, cannot be presented unless it has been added to the game object.
      *
      * @param scene
      */
     addScene(scene: Scene): void;
+    /**
+     * Adds multiple scenes to the game.
+     *
+     * @param scenes
+     */
     addScenes(scenes: Array<Scene>): void;
     /**
      * Specifies the scene that will be presented upon the next frame draw.
@@ -669,6 +706,14 @@ declare class Game {
      */
     start(entryScene?: Scene | string): void;
     initData(trialSchema: object): void;
+    /**
+     * Adds data to the game's TrialData object.
+     *
+     * @remarks The variableName must be previously defined in the trialSchema object passed in during game initialization. see {@link GameInitOptions.trialSchema}. The type of the value must match what was defined in the trialSchema, otherwise an error is thrown.
+     *
+     * @param variableName - variable to be set
+     * @param value - value of the variable to set
+     */
     addTrialData(variableName: string, value: any): void;
     private loadCanvasKit;
     private setupHtmlCanvases;
@@ -716,9 +761,13 @@ interface IText {
 }
 
 interface TextOptions {
+    /** Text to be displayed */
     text?: string;
+    /** Name of font to use for text. Must have been previously loaded */
     fontName?: string;
+    /** Color of text. Default is Constants.DEFAULT_FONT_COLOR (WebColors.Black) */
     fontColor?: RgbaColor;
+    /** Size of text. Default is Constants.DEFAULT_FONT_SIZE (16) */
     fontSize?: number;
 }
 
@@ -729,12 +778,15 @@ declare enum LabelHorizontalAlignmentMode {
 }
 
 interface LabelOptions extends EntityOptions, DrawableOptions, TextOptions {
+    /** Horizontal alignment of label text. see {@link LabelHorizontalAlignmentMode}. Default is LabelHorizontalAlignmentMode.center  */
     horizontalAlignmentMode?: LabelHorizontalAlignmentMode;
+    /** Maximum width of label text before wrapping occurs. Default is the canvas width */
     preferredMaxLayoutWidth?: number;
+    /** Background color  of label text. Default is no background color */
     backgroundColor?: RgbaColor;
 }
 
-declare class Label extends Entity implements IDrawable, IText {
+declare class Label extends Entity implements IDrawable, IText, LabelOptions {
     readonly type = EntityType.label;
     isDrawable: boolean;
     isText: boolean;
@@ -752,9 +804,9 @@ declare class Label extends Entity implements IDrawable, IText {
     /**
      * Single or multi-line text formatted and rendered on the screen.
      *
-     * @remarks  Label (in contrast to TextLine) has enhanced text support for line wrapping, centering/alignment, and background colors.
+     * @remarks Label (in contrast to TextLine) has enhanced text support for line wrapping, centering/alignment, and background colors.
      *
-     * @param options
+     * @param options - {@link LabelOptions}
      */
     constructor(options?: LabelOptions);
     initialize(): void;
@@ -825,11 +877,17 @@ declare class RandomDraws {
 }
 
 interface RectOptions {
+    /** Position of rectangle */
     origin?: Point;
+    /** Size of rectangle */
     size?: Size;
+    /** X coordinate of rectangle position; this can be used instead of setting the origin property */
     x?: number;
+    /** Y coordinate of rectangle position; this can be used instead of setting the origin property */
     y?: number;
+    /** Width of rectangle; this can be used instead of setting the size property */
     width?: number;
+    /** Height of rectangle; this can be used instead of setting the size property */
     height?: number;
 }
 
@@ -844,11 +902,17 @@ declare class Rect implements RectOptions {
 }
 
 interface ShapeOptions extends EntityOptions, DrawableOptions {
+    /** If provided, shape will be a circle with given radius */
     circleOfRadius?: number;
+    /** If provided, shape will be a rectangle as specified in {@link Rect} */
     rect?: Rect;
+    /** Radius of rectangle's corners */
     cornerRadius?: number;
+    /** Color with which to fill shape. Default is Constants.DEFAULT_SHAPE_FILL_COLOR (WebColors.Red)  */
     fillColor?: RgbaColor;
+    /** Color with which to outline shape. Default is no color */
     strokeColor?: RgbaColor;
+    /** Width of outline. Default is undefined */
     lineWidth?: number;
 }
 
@@ -858,7 +922,7 @@ declare enum ShapeType {
     circle = "Circle"
 }
 
-declare class Shape extends Entity implements IDrawable {
+declare class Shape extends Entity implements IDrawable, ShapeOptions {
     readonly type = EntityType.shape;
     isDrawable: boolean;
     isShape: boolean;
@@ -874,9 +938,9 @@ declare class Shape extends Entity implements IDrawable {
     private fillColorPaint?;
     private strokeColorPaint?;
     /**
-     * Rectangular shape
+     * Rectangular or circular shape
      *
-     * @param options
+     * @param options - {@link ShapeOptions}
      */
     constructor(options?: ShapeOptions);
     initialize(): void;
@@ -889,10 +953,11 @@ declare class Shape extends Entity implements IDrawable {
 }
 
 interface SpriteOptions extends EntityOptions, DrawableOptions {
+    /** Name of image to use for sprite. Must have been previously loaded */
     imageName?: string;
 }
 
-declare class Sprite extends Entity implements IDrawable {
+declare class Sprite extends Entity implements IDrawable, SpriteOptions {
     readonly type = EntityType.sprite;
     isDrawable: boolean;
     anchorPoint: Point;
@@ -904,7 +969,7 @@ declare class Sprite extends Entity implements IDrawable {
      *
      * @remarks Sprites must be loaded during the Game.init() method prior to their use.
      *
-     * @param options
+     * @param options - {@link SpriteOptions}
      */
     constructor(options?: SpriteOptions);
     initialize(): void;
@@ -926,7 +991,7 @@ interface TextLineOptions extends EntityOptions, DrawableOptions, TextOptions {
     width?: number;
 }
 
-declare class TextLine extends Entity implements IDrawable, IText {
+declare class TextLine extends Entity implements IDrawable, IText, TextLineOptions {
     readonly type = EntityType.textline;
     isDrawable: boolean;
     isText: boolean;
@@ -943,7 +1008,7 @@ declare class TextLine extends Entity implements IDrawable, IText {
      *
      * @remarks TextLine has no paragraph formatting options; Label will be preferred in most use cases.
      *
-     * @param options
+     * @param options - {@link TextLineOptions}
      */
     constructor(options?: TextLineOptions);
     get text(): string;
@@ -1122,4 +1187,4 @@ declare class WebColors {
     static RebeccaPurple: RgbaColor;
 }
 
-export { Action, Composite, CompositeOptions, Constants, ConstraintType, Constraints, CustomAction, CustomActionOptions, Dimensions, DrawableOptions, Entity, EntityOptions, EntityType, FontData, FontManager, Game, GameInitOptions, GlobalVariables, GroupAction, IDrawable, IText, ImageManager, Label, LabelHorizontalAlignmentMode, LabelOptions, Layout, LayoutConstraint, LoadedImage, MoveAction, MoveActionOptions, Point, PushTransition, RandomDraws, Rect, RectOptions, RgbaColor, ScaleAction, ScaleActionOptions, Scene, SceneOptions, SceneTransition, SequenceAction, Shape, ShapeOptions, ShapeType, Size, Sprite, SpriteOptions, Story, StoryOptions, SvgImage, TapEvent, TapListener, TextLine, TextLineOptions, TextOptions, Timer, Transition, TransitionDirection, TransitionType, WaitAction, WaitActionOptions, WebColors, handleInterfaceOptions };
+export { Action, Composite, CompositeOptions, Constants, ConstraintType, Constraints, CustomAction, CustomActionOptions, Dimensions, DrawableOptions, Entity, EntityOptions, EntityType, FontData, FontManager, Game, GameData, GameInitOptions, GlobalVariables, GroupAction, IDrawable, IText, ImageManager, Label, LabelHorizontalAlignmentMode, LabelOptions, Layout, LayoutConstraint, LoadedImage, MoveAction, MoveActionOptions, Point, PushTransition, RandomDraws, Rect, RectOptions, RgbaColor, ScaleAction, ScaleActionOptions, Scene, SceneOptions, SceneTransition, SequenceAction, Shape, ShapeOptions, ShapeType, Size, Sprite, SpriteOptions, Story, StoryOptions, SvgImage, TapEvent, TapListener, TextLine, TextLineOptions, TextOptions, Timer, Transition, TransitionDirection, TransitionType, WaitAction, WaitActionOptions, WebColors, handleInterfaceOptions };