-
-
Notifications
You must be signed in to change notification settings - Fork 992
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #561 from thestonefox/feat/tag-script-policy-lists
feat(PolicyList): add ability to have multiple tag/script ignore checks
- Loading branch information
Showing
11 changed files
with
244 additions
and
25 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
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
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
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
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,120 @@ | ||
| // Tag Or Script Policy List|Scripts|0225 | ||
| namespace VRTK | ||
| { | ||
| using UnityEngine; | ||
| using System.Collections.Generic; | ||
|
|
||
| /// <summary> | ||
| /// The Tag Or Script Policy List allows to create a list of either tag names or script names that can be checked against to see if another operation is permitted. | ||
| /// </summary> | ||
| /// <remarks> | ||
| /// A number of other scripts can use a Tag Or Script Policy List to determine if an operation is permitted based on whether a game object has a tag applied or a script component on it. | ||
| /// | ||
| /// For example, the Teleporter scripts can ignore game object targets as a teleport location if the game object contains a tag that is in the identifiers list and the policy is set to ignore. | ||
| /// | ||
| /// Or the teleporter can only allow teleport to targets that contain a tag that is in the identifiers list and the policy is set to include. | ||
| /// | ||
| /// Add the Tag Or Script Policy List script to a game object (preferably the same component utilising the list) and then configure the list accordingly. | ||
| /// | ||
| /// Then in the component that has a Tag Or Script Policy List paramter (e.g. BasicTeleporter has `Target Tag Or Script List Policy`) simply select the list that has been created and defined. | ||
| /// </remarks> | ||
| public class VRTK_TagOrScriptPolicyList : MonoBehaviour | ||
| { | ||
| /// <summary> | ||
| /// The operation to apply on the list of identifiers. | ||
| /// </summary> | ||
| /// <param name="Ignore">Will ignore any game objects that contain either a tag or script component that is included in the identifiers list.</param> | ||
| /// <param name="Include">Will only include game objects that contain either a tag or script component that is included in the identifiers list.</param> | ||
| public enum OperationTypes | ||
| { | ||
| Ignore, | ||
| Include | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// The types of element that can be checked against. | ||
| /// </summary> | ||
| /// <param name="Tag">The tag applied to the game object.</param> | ||
| /// <param name="Script">A script component added to the game object.</param> | ||
| /// <param name="Tag_Or_Script">Either a tag applied to the game object or a script component added to the game object.</param> | ||
| public enum CheckTypes | ||
| { | ||
| Tag, | ||
| Script, | ||
| Tag_Or_Script | ||
| } | ||
|
|
||
| [Tooltip("The operation to apply on the list of identifiers.")] | ||
| public OperationTypes operation = OperationTypes.Ignore; | ||
| [Tooltip("The element type on the game object to check against.")] | ||
| public CheckTypes checkType = CheckTypes.Tag; | ||
| [Tooltip("A list of identifiers to check for against the given check type (either tag or script).")] | ||
| public List<string> identifiers = new List<string>() { "" }; | ||
|
|
||
| /// <summary> | ||
| /// The Find method performs the set operation to determine if the given game object contains one of the identifiers on the set check type. | ||
| /// </summary> | ||
| /// <remarks> | ||
| /// For instance, if the Operation is `Ignore` and the Check Type is `Tag` then the Find method will attempt to see if the given game object has a tag that matches one of the identifiers. | ||
| /// </remarks> | ||
| /// <param name="obj">The game object to check if it has a tag or script that is listed in the identifiers list.</param> | ||
| /// <returns>If the operation is `Ignore` and the game object is matched by an identifier from the list then it returns true. If the operation is `Include` and the game object is not matched by an identifier from the list then it returns true.</returns> | ||
| public bool Find(GameObject obj) | ||
| { | ||
| if (operation == OperationTypes.Ignore) | ||
| { | ||
| return TypeCheck(obj, true); | ||
| } | ||
| else | ||
| { | ||
| return TypeCheck(obj, false); | ||
| } | ||
| } | ||
|
|
||
| private bool ScriptCheck(GameObject obj, bool returnState) | ||
| { | ||
| foreach (var identifier in identifiers) | ||
| { | ||
| if (obj.GetComponent(identifier)) | ||
| { | ||
| return returnState; | ||
| } | ||
| } | ||
| return !returnState; | ||
| } | ||
|
|
||
| private bool TagCheck(GameObject obj, bool returnState) | ||
| { | ||
| if (returnState) | ||
| { | ||
| return identifiers.Contains(obj.tag); | ||
| } | ||
| else | ||
| { | ||
| return !identifiers.Contains(obj.tag); | ||
| } | ||
| } | ||
|
|
||
| private bool TypeCheck(GameObject obj, bool returnState) | ||
| { | ||
| switch (checkType) | ||
| { | ||
| case CheckTypes.Script: | ||
| return ScriptCheck(obj, returnState); | ||
| case CheckTypes.Tag: | ||
| return TagCheck(obj, returnState); | ||
| case CheckTypes.Tag_Or_Script: | ||
| if ((returnState && ScriptCheck(obj, returnState)) || (!returnState && !ScriptCheck(obj, returnState))) | ||
| { | ||
| return returnState; | ||
| } | ||
| if ((returnState && TagCheck(obj, returnState)) || (!returnState && !TagCheck(obj, returnState))) | ||
| { | ||
| return returnState; | ||
| } | ||
| break; | ||
| } | ||
| return !returnState; | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.