Class AEBaseModel

Optionalend

Optionalinitiative

Optionallevel

item

• get item(): null | Item<"base" | ModuleSubType>

  Retrieve parent item

  Returns null | Item<"base" | ModuleSubType>

StaticdefineSchema

• defineSchema(): {
      end: StringField<
          {
              blank: false;
              choices: () => {
                  initiative: "Initiative";
                  turnEnd: "Turn End";
                  turnStart: "Turn Start";
              };
              label: "End Timing";
              required: false;
          },
          AssignmentType<
              {
                  blank: false;
                  choices: () => {
                      initiative: "Initiative";
                      turnEnd: "Turn End";
                      turnStart: "Turn Start";
                  };
                  label: "End Timing";
                  required: false;
              },
          >,
          InitializedType<
              {
                  blank: false;
                  choices: () => {
                      initiative: "Initiative";
                      turnEnd: "Turn End";
                      turnStart: "Turn Start";
                  };
                  label: "End Timing";
                  required: false;
              },
          >,
          InitializedType<
              {
                  blank: false;
                  choices: () => {
                      initiative: "Initiative";
                      turnEnd: "Turn End";
                      turnStart: "Turn Start";
                  };
                  label: "End Timing";
                  required: false;
              },
          >,
      >;
      initiative: NumberField<
          {
              initial: undefined;
              label: "Initiative";
              nullable: false;
              required: false;
          },
          AssignmentType<
              {
                  initial: undefined;
                  label: "Initiative";
                  nullable: false;
                  required: false;
              },
          >,
          InitializedType<
              {
                  initial: undefined;
                  label: "Initiative";
                  nullable: false;
                  required: false;
              },
          >,
          InitializedType<
              {
                  initial: undefined;
                  label: "Initiative";
                  nullable: false;
                  required: false;
              },
          >,
      >;
      level: NumberField<
          {
              initial: undefined;
              integer: true;
              label: "Level";
              nullable: false;
              required: false;
          },
          AssignmentType<
              {
                  initial: undefined;
                  integer: true;
                  label: "Level";
                  nullable: false;
                  required: false;
              },
          >,
          InitializedType<
              {
                  initial: undefined;
                  integer: true;
                  label: "Level";
                  nullable: false;
                  required: false;
              },
          >,
          InitializedType<
              {
                  initial: undefined;
                  integer: true;
                  label: "Level";
                  nullable: false;
                  required: false;
              },
          >,
      >;
  }

  Define the data schema for documents of this type. The schema is populated the first time it is accessed and cached for future reuse.

  Returns {
      end: StringField<
          {
              blank: false;
              choices: () => {
                  initiative: "Initiative";
                  turnEnd: "Turn End";
                  turnStart: "Turn Start";
              };
              label: "End Timing";
              required: false;
          },
          AssignmentType<
              {
                  blank: false;
                  choices: () => {
                      initiative: "Initiative";
                      turnEnd: "Turn End";
                      turnStart: "Turn Start";
                  };
                  label: "End Timing";
                  required: false;
              },
          >,
          InitializedType<
              {
                  blank: false;
                  choices: () => {
                      initiative: "Initiative";
                      turnEnd: "Turn End";
                      turnStart: "Turn Start";
                  };
                  label: "End Timing";
                  required: false;
              },
          >,
          InitializedType<
              {
                  blank: false;
                  choices: () => {
                      initiative: "Initiative";
                      turnEnd: "Turn End";
                      turnStart: "Turn Start";
                  };
                  label: "End Timing";
                  required: false;
              },
          >,
      >;
      initiative: NumberField<
          {
              initial: undefined;
              label: "Initiative";
              nullable: false;
              required: false;
          },
          AssignmentType<
              {
                  initial: undefined;
                  label: "Initiative";
                  nullable: false;
                  required: false;
              },
          >,
          InitializedType<
              {
                  initial: undefined;
                  label: "Initiative";
                  nullable: false;
                  required: false;
              },
          >,
          InitializedType<
              {
                  initial: undefined;
                  label: "Initiative";
                  nullable: false;
                  required: false;
              },
          >,
      >;
      level: NumberField<
          {
              initial: undefined;
              integer: true;
              label: "Level";
              nullable: false;
              required: false;
          },
          AssignmentType<
              {
                  initial: undefined;
                  integer: true;
                  label: "Level";
                  nullable: false;
                  required: false;
              },
          >,
          InitializedType<
              {
                  initial: undefined;
                  integer: true;
                  label: "Level";
                  nullable: false;
                  required: false;
              },
          >,
          InitializedType<
              {
                  initial: undefined;
                  integer: true;
                  label: "Level";
                  nullable: false;
                  required: false;
              },
          >,
      >;
  }

  Remarks

  The returned value MUST be kept up to sync with the Schema type parameter.