This repository has been archived by the owner on Apr 15, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 30
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'dev' of https://github.com/PBS-KIDS/Platypus into dev
Conflicts: lib/platypus.combined.js lib/platypus.min.js
- Loading branch information
Showing
9 changed files
with
712 additions
and
470 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,169 @@ | ||
| /** | ||
| * This class defines an action state based on one or more inputs. This is used by [EntityController](platypus.components.EntityController.html) to produce event messages listing whether a particular action is "triggered", "pressed", and/or "released". | ||
| * | ||
| * @namespace platypus | ||
| * @class ActionState | ||
| * @constructor | ||
| * @param event {String} The name of the event to trigger on the Entity. | ||
| * @param states {Object} A list of key/value pairs describing what states should be `true` or `false` on the Entity for this action to be triggered. | ||
| * @param trigger {Function} The function to be called if one or more inputs are active and the current state of the Entity is valid. | ||
| * @return {ActionState} Returns the new ActionState object. | ||
| * @since 0.6.8 | ||
| */ | ||
| /*global platypus */ | ||
| platypus.ActionState = (function () { | ||
| "use strict"; | ||
|
|
||
| var ActionState = function (event, states, trigger) { | ||
| /** | ||
| * The name of the event to trigger on the Entity. | ||
| * | ||
| * @property event | ||
| * @type String | ||
| */ | ||
| this.event = event; | ||
|
|
||
| /** | ||
| * The function to call if the ActionState is active. | ||
| * | ||
| * @property trigger | ||
| * @type Function | ||
| */ | ||
| this.trigger = trigger; | ||
|
|
||
| /** | ||
| * Whether any of the ActionState's inputs are active. | ||
| * | ||
| * @property active | ||
| * @type Boolean | ||
| */ | ||
| this.active = false; | ||
|
|
||
| /** | ||
| * Whether any of the ActionState's inputs were active last update. | ||
| * | ||
| * @property wasActive | ||
| * @type Boolean | ||
| */ | ||
| this.wasActive = false; | ||
|
|
||
| /** | ||
| * Whether the Entity's state is valid for this ActionState. | ||
| * | ||
| * @property valid | ||
| * @type Boolean | ||
| */ | ||
| this.valid = true; | ||
|
|
||
| /** | ||
| * Whether the Entity's state was valid for this ActionState last update. | ||
| * | ||
| * @property wasValid | ||
| * @type Boolean | ||
| */ | ||
| this.wasValid = true; | ||
|
|
||
| /** | ||
| * The state of the Entity that is valid for this ActionState. | ||
| * | ||
| * @property states | ||
| * @type Object | ||
| */ | ||
| this.states = states || {}; | ||
|
|
||
| /** | ||
| * The list of input toggles to track control input. | ||
| * | ||
| * @property inputs | ||
| * @type Array | ||
| */ | ||
| this.inputs = []; | ||
|
|
||
| /** | ||
| * The message that is passed to the Entity if the ActionState is active. | ||
| * | ||
| * @property stateSummary | ||
| * @type Object | ||
| */ | ||
| this.stateSummary = { | ||
| pressed: false, | ||
| released: false, | ||
| triggered: false | ||
| }; | ||
| }, | ||
| orArray = function (element) { | ||
| return element; | ||
| }, | ||
| proto = ActionState.prototype; | ||
|
|
||
| /** | ||
| * Updates the state of the action by checking the state of the Entity and whether any inputs are active. | ||
| * | ||
| * @method update | ||
| * @param state {Object} The Entity's `state` property to compare against the ActionState's valid state. | ||
| * @return {Boolean} Whether the ActionState is triggered, pressed, or released. | ||
| */ | ||
| proto.update = function (state) { | ||
| var ss = this.stateSummary; | ||
|
|
||
| this.valid = this.isStateValid(state); | ||
| this.active = this.inputs.some(orArray); | ||
|
|
||
| ss.pressed = this.valid && this.active; | ||
| ss.released = this.wasActive && ((!this.valid && this.wasValid) || (this.valid && !this.active)); | ||
| ss.triggered = this.valid && this.active && !this.wasActive; | ||
|
|
||
| this.wasValid = this.valid; | ||
| this.wasActive = this.active; | ||
|
|
||
| return ss.pressed || ss.released || ss.triggered; | ||
| }; | ||
|
|
||
| /** | ||
| * Triggers events on the Entity related to the ActionState's state. This is necessarily separate from the `update` method since triggered events could affect entity state. The messages have the following form and are only triggered if one of the values is `true`: | ||
| * | ||
| * { | ||
| * "triggered": true, | ||
| * "pressed": true, | ||
| * "released": false | ||
| * } | ||
| * | ||
| * Here is a mapping of the various event messages depending on the ActionState's state. | ||
| * | ||
| * ActionState State: | ||
| * wasValid: 0 0 0 0 0 0 0 0 1 1 1 1 1 1 1 1 | ||
| * valid: 0 0 0 0 1 1 1 1 0 0 0 0 1 1 1 1 | ||
| * wasActive: 0 0 1 1 0 0 1 1 0 0 1 1 0 0 1 1 | ||
| * active: 0 1 0 1 0 1 0 1 0 1 0 1 0 1 0 1 | ||
| * Events: | ||
| * triggered: 0 0 0 0 0 1 0 0 0 0 0 0 0 1 0 0 | ||
| * pressed: 0 0 0 0 0 1 0 1 0 0 0 0 0 1 0 1 | ||
| * released: 0 0 0 0 0 0 1 0 0 0 1 1 0 0 1 0 | ||
| * | ||
| * @method resolve | ||
| */ | ||
| proto.resolve = function () { | ||
| this.trigger(this.event, this.stateSummary); | ||
| }; | ||
|
|
||
| /** | ||
| * Determines whether the ActionState is valid for the Entity's current state. | ||
| * | ||
| * @method isStateValid | ||
| * @return {Boolean} Whether the current Entity state is valid for this ActionState. | ||
| */ | ||
| proto.isStateValid = function (ownerState) { | ||
| var key = '', | ||
| states = this.states; | ||
|
|
||
| for (key in states) { | ||
| if (states.hasOwnProperty(key) && ownerState.hasOwnProperty(key) && (states[key] !== ownerState[key])) { | ||
| return false; | ||
| } | ||
| } | ||
|
|
||
| return true; | ||
| }; | ||
|
|
||
| return ActionState; | ||
| }()); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.