Improve AI events handling

Don't show in changelog

Author: 4ian

newIDE/app/src/EventsSheet/EventsTree/TextRenderer/TextRenderer.spec.js

@@ -9,6 +9,7 @@ describe('EventsTree/TextRenderer', () => {
   it('renders events as text', () => {
     const { project } = makeTestProject(gd);
     try {
+      const longCommentText = 'A'.repeat(450);
       const serializedEvents = [
         {
           type: 'BuiltinCommonInstructions::Standard',
@@ -331,6 +332,51 @@ describe('EventsTree/TextRenderer', () => {
             },
           ],
         },
+        // Disabled event with conditions/actions - should get disabled="true"
+        {
+          type: 'BuiltinCommonInstructions::Standard',
+          disabled: true,
+          conditions: [
+            {
+              type: { value: 'PlatformBehavior::IsFalling' },
+              parameters: [
+                'GroupOfSpriteObjectsWithBehaviors',
+                'PlatformerObject',
+              ],
+            },
+          ],
+          actions: [
+            {
+              type: { value: 'Show' },
+              parameters: ['GroupOfObjects', ''],
+            },
+          ],
+          events: [
+            // Sub-event of disabled parent - should get disabled-because-of-ancestor="true"
+            {
+              type: 'BuiltinCommonInstructions::Standard',
+              conditions: [],
+              actions: [
+                {
+                  type: { value: 'Show' },
+                  parameters: ['GroupOfObjects', ''],
+                },
+              ],
+            },
+          ],
+        },
+        // Short comment
+        {
+          type: 'BuiltinCommonInstructions::Comment',
+          comment: 'This is a short comment',
+          color: { r: 255, g: 230, b: 109, textR: 0, textG: 0, textB: 0 },
+        },
+        // Long comment (>400 chars) - should be truncated
+        {
+          type: 'BuiltinCommonInstructions::Comment',
+          comment: longCommentText,
+          color: { r: 255, g: 230, b: 109, textR: 0, textG: 0, textB: 0 },
+        },
       ];
 
       const eventsList = new gd.EventsList();
@@ -361,7 +407,7 @@ describe('EventsTree/TextRenderer', () => {
            Actions:
            - Show GroupOfObjects
           </event-0.0>
-          <event-0.1>
+          <event-0.1 type=\\"repeat\\">
            Repeat \`1\` times these:
            Conditions:
             (no conditions)
@@ -392,7 +438,7 @@ describe('EventsTree/TextRenderer', () => {
            - Hide GroupOfObjects
            - Unknown or unsupported instruction
           </event-0.3>
-          <event-0.4>
+          <event-0.4 type=\\"while\\">
            While these conditions are true:
             - GroupOfSpriteObjectsWithBehaviors is falling
            Then do:
@@ -402,15 +448,15 @@ describe('EventsTree/TextRenderer', () => {
             - Change the number of the animation of MySpriteObject: = 1
             - Show GroupOfObjects
           </event-0.4>
-          <event-0.5>
+          <event-0.5 type=\\"repeat\\">
            Repeat \`3 + 4\` times these:
            Conditions:
             - GroupOfSpriteObjectsWithBehaviors is falling
            Actions:
             - Change the number of the animation of MySpriteObject: = 1
             - Show GroupOfObjects
           </event-0.5>
-          <event-0.6>
+          <event-0.6 type=\\"group\\">
            Group called \\"My super group\\":
            Sub-events:
             <event-0.6.0>
@@ -458,7 +504,26 @@ describe('EventsTree/TextRenderer', () => {
            Actions:
            - Hide GroupOfObjects
           </event-0.10>
-        </event-0>"
+        </event-0>
+        <event-1 disabled=\\"true\\">
+         Conditions:
+         - GroupOfSpriteObjectsWithBehaviors is falling
+         Actions:
+         - Show GroupOfObjects
+         Sub-events:
+          <event-1.0 disabled-because-of-ancestor=\\"true\\">
+           Conditions:
+           (no conditions)
+           Actions:
+           - Show GroupOfObjects
+          </event-1.0>
+        </event-1>
+        <event-2 type=\\"comment\\">
+         This is a short comment
+        </event-2>
+        <event-3 type=\\"comment\\">
+         AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA[cut - 50 more characters]
+        </event-3>"
       `);
     } finally {
       project.delete();

newIDE/app/src/EventsSheet/EventsTree/TextRenderer/index.js

@@ -96,7 +96,15 @@ ${actions}`,
     };
   },
   'BuiltinCommonInstructions::Comment': ({ event, padding }) => {
-    return { content: `${padding}(comment - content is not displayed)` };
+    const commentEvent = gd.asCommentEvent(event);
+    const fullText = commentEvent.getComment();
+    const maxLength = 400;
+    const text =
+      fullText.length > maxLength
+        ? fullText.slice(0, maxLength) +
+          `[cut - ${fullText.length - maxLength} more characters]`
+        : fullText;
+    return { content: `${padding}${text}` };
   },
   'BuiltinCommonInstructions::While': ({ event, padding }) => {
     const whileEvent = gd.asWhileEvent(event);
@@ -280,16 +288,15 @@ const renderEventAsText = ({
   eventIndex,
   padding,
   eventPath,
+  isAncestorDisabled,
 }: {|
   event: gdBaseEvent,
   eventsList: gdEventsList,
   eventIndex: number,
   padding: string,
   eventPath: string,
+  isAncestorDisabled: boolean,
 |}) => {
-  const isDisabled = event.isDisabled();
-  if (isDisabled) return `${padding}(This event is disabled - ignored)`;
-
   const localVariablesText =
     event.canHaveVariables() && event.hasVariables()
       ? renderLocalVariablesAsText({
@@ -324,6 +331,7 @@ const renderEventAsText = ({
       eventsList: event.getSubEvents(),
       parentPath: eventPath,
       padding: padding + ' ',
+      isAncestorDisabled: isAncestorDisabled || event.isDisabled(),
     });
   }
 
@@ -334,10 +342,12 @@ export const renderEventsAsText = ({
   eventsList,
   parentPath,
   padding,
+  isAncestorDisabled = false,
 }: {|
   eventsList: gdEventsList,
   parentPath: string,
   padding: string,
+  isAncestorDisabled?: boolean,
 |}): string => {
   return mapFor(0, eventsList.getEventsCount(), i => {
     const event = eventsList.getEventAt(i);
@@ -349,6 +359,7 @@ export const renderEventsAsText = ({
       eventIndex: i,
       eventPath,
       padding: padding + ' ',
+      isAncestorDisabled,
     });
 
     let elseOfAttribute = '';
@@ -362,7 +373,29 @@ export const renderEventsAsText = ({
       elseOfAttribute = ` else-of="event-${previousEventPath}"`;
     }
 
-    return `${padding}<event-${eventPath}${elseOfAttribute}>
+    const eventTypeToAttribute: { [string]: string } = {
+      'BuiltinCommonInstructions::Comment': 'comment',
+      'BuiltinCommonInstructions::While': 'while',
+      'BuiltinCommonInstructions::Link': 'link',
+      'BuiltinCommonInstructions::Group': 'group',
+      'BuiltinCommonInstructions::ForEachChildVariable':
+        'for-each-child-variable',
+      'BuiltinCommonInstructions::ForEach': 'for-each',
+      'BuiltinCommonInstructions::Repeat': 'repeat',
+    };
+    const typeAttributeValue = eventTypeToAttribute[event.getType()];
+    const typeAttribute = typeAttributeValue
+      ? ` type="${typeAttributeValue}"`
+      : '';
+
+    let disabledAttribute = '';
+    if (event.isDisabled()) {
+      disabledAttribute = ' disabled="true"';
+    } else if (isAncestorDisabled) {
+      disabledAttribute = ' disabled-because-of-ancestor="true"';
+    }
+
+    return `${padding}<event-${eventPath}${elseOfAttribute}${typeAttribute}${disabledAttribute}>
 ${eventAndSubEventsText}
 ${padding}</event-${eventPath}>`;
   }).join('\n');