feat: new nodes -- Predicate, SideEffect, and Success

lib/index.ts

@@ -3,6 +3,9 @@ export {Composite} from './nodes/Composite';
 export {Decorator} from './nodes/Decorator';
 export {Sequence} from './nodes/Sequence';
 export {Selector} from './nodes/Selector';
+export {Predicate} from './nodes/Predicate';
+export {SideEffect} from './nodes/SideEffect';
+export {Success} from './nodes/Success';
 export {LatchedSelector} from './nodes/LatchedSelector';
 export {LatchedSequence} from './nodes/LatchedSequence';
 export {IfElse} from './nodes/IfElse';

lib/nodes/LatchedSequence.ts

@@ -15,6 +15,6 @@ export class LatchedSequence<S extends BlueshellState, E> extends Sequence<S, E>
 	}
 
 	get symbol(): string {
-		return `⍈`;
+		return '⍈';
 	}
 }

lib/nodes/Predicate.ts

@@ -0,0 +1,12 @@
+import {BlueshellState} from './BlueshellState';
+import {Base} from './Base';
+import {resultCodes} from '..';
+
+export class Predicate<S extends BlueshellState, E> extends Base<S, E> {
+	constructor(name: string, private readonly predicate: (state: S, event: E) => boolean) {
+		super(name);
+	}
+	onEvent(state: S, event: E) {
+		return this.predicate(state, event) ? resultCodes.SUCCESS : resultCodes.FAILURE;
+	}
+}

lib/nodes/SideEffect.ts

@@ -0,0 +1,14 @@
+import {BlueshellState} from './BlueshellState';
+import {resultCodes as rc} from '../utils/resultCodes';
+import {Base} from './Base';
+
+export class SideEffect<S extends BlueshellState, E> extends Base<S, E> {
+	constructor(public readonly name: string, private sideEffect: (state: S, event: E) => void) {
+		super(name);
+	}
+
+	onEvent(state: S, event: E) {
+		this.sideEffect(state, event);
+		return rc.SUCCESS;
+	}
+}

lib/nodes/Success.ts

@@ -0,0 +1,15 @@
+import {BlueshellState} from './BlueshellState';
+import {Base} from './Base';
+import {resultCodes as rc} from '../utils/resultCodes';
+
+export class Success<S extends BlueshellState, E> extends Base<S, E> {
+	constructor(
+		name = 'Success'
+	) {
+		super(name);
+	}
+
+	onEvent() {
+		return rc.SUCCESS;
+	}
+}

test/nodes/Predicate.test.ts

@@ -0,0 +1,16 @@
+import {assert} from 'chai';
+
+import {resultCodes as rc} from '../../lib/utils/resultCodes';
+
+import * as Behavior from '../../lib';
+
+describe('Predicate', function() {
+	it('Turns truth into success', function() {
+		const p = new Behavior.Predicate('test', () => true);
+		assert.strictEqual(p.handleEvent({__blueshell: {}}, {}), rc.SUCCESS);
+	});
+	it('Turns false into failure', function() {
+		const p = new Behavior.Predicate('test', () => false);
+		assert.strictEqual(p.handleEvent({__blueshell: {}}, {}), rc.FAILURE);
+	});
+});

test/nodes/SideEffect.test.ts

@@ -0,0 +1,20 @@
+import {assert} from 'chai';
+
+import {resultCodes as rc} from '../../lib/utils/resultCodes';
+
+import * as Behavior from '../../lib';
+
+describe('SideEffect', function() {
+	it('Runs the side effect', function() {
+		let x = 1;
+		const s = new Behavior.SideEffect('set X', () => {
+			x = 3;
+		});
+		s.handleEvent({__blueshell: {}}, {});
+		assert.strictEqual(x, 3);
+	});
+	it('Always succeeds if it completes', function() {
+		const s = new Behavior.SideEffect('set X', () => ({}));
+		assert.strictEqual(s.handleEvent({__blueshell: {}}, {}), rc.SUCCESS);
+	});
+});

test/nodes/Success.test.ts

@@ -0,0 +1,12 @@
+import {assert} from 'chai';
+
+import {resultCodes as rc} from '../../lib/utils/resultCodes';
+
+import * as Behavior from '../../lib';
+
+describe('Success', function() {
+	it('Returns success', function() {
+		const success = new Behavior.Success();
+		assert.strictEqual(success.handleEvent({__blueshell: {}}, {}), rc.SUCCESS);
+	});
+});