Infinity PBR by Magic Pig Games
  • Infinity PBR Documentation
  • Game Modules 4
    • ➡️Quick Start
    • 📽️Video Tutorials
      • Quick Start: Creating Game Module Objects
      • Automating Start Actions on GameModulesActor
      • Inflicting Damage with Conditions
      • Updating UI (and more) with Blackboard Notes
      • Dynamic Menus with Item Objects and Dictionaries
      • Create Custom Quest Rewards
      • Save and Load Game Data
      • Stats: Deep Dive
      • Items: Deep Dive
      • Conditions: Deep Dive
      • First Person Movement
      • Tutorial: "Overheal" Effect with Condition & Stats
      • Tutorial: Create a Character & Actor Class Inheriting from GameModulesActor
    • 👀Game Modules Viewer
      • Viewer: Dictionaries
      • Viewer: Stat / GameStatList
      • Viewer: ItemObject / GameItemObjectList
      • Viewer: ItemAttribute / GameItemAttributeList
      • Viewer: Condition / GameConditionList
      • Viewer: Quest / GameQuestList
    • V4 Migration Tips
      • Introducing GameModulesActor
      • Interfaces
      • No More Tick*
      • Dictionaries
      • Repositories
      • Tips from Upgrading "Legend of the Stones"
    • Important Information
      • Game Modules Overview
      • Inherit from GameModulesActor
      • Things to not forget to do
      • Bugs, Backups, and Demos
      • FAQ / Tips & Tricks
      • Required Prefabs
      • Game Module Repository
      • Release Notes
    • Module Documentation
      • Game Modules Actor
      • Game Module "Lists"
        • Get() Methods
          • GameStatList Get() Methods
          • GameItemObjectList Get() Methods
          • GameItemAttribute Get() Methods
          • GameConditionList Get() Methods
          • GameQuestList Get() Methods
        • Contains() Methods
          • GameStatList Contains() Methods
          • GameItemObjectList Contains() Methods
          • GameItemAttributeList Contains() Methods
          • GameConditionList Contains() Methods
          • GameQuestList Contains() Methods
        • Count() Methods
          • GameStatList Count() Methods
          • GameItemObjectList Count() Methods
          • GameItemAttributeList Count() Methods
          • GameConditionList Count() Methods
          • GameQuestList Count() Methods
        • Remove() Methods
          • GameStatList Remove() Methods
          • GameItemObjectList Remove() Methods
          • GameItemAttributeList Remove() Methods
          • GameConditionList Remove() Methods
          • GameQuestList Remove() Methods
        • GameStatList
        • GameItemObjectList
        • GameItemAttributeList
        • GameQuestList
        • GameConditionList
      • Blackboard
        • Blackboard.cs
        • Blackboard Follower
        • Blackboard Note
        • Blackboard Event
        • Blackboard Values
        • Tips & Tricks
          • Use extension methods to check BlackboardNotes (or events)
      • Stats
        • IHaveStats
        • Stat.cs
        • GameStat.cs
        • GameStatList.cs
        • Mastery Levels
      • Loot
        • LootItems.cs
        • LootBox.cs
        • GameLootBox.cs
        • Generating & Handling Loot
        • Custom Loot Generation Algorithm
      • Items
        • ItemObject.cs
          • Manage Item Objects
          • Allowed Item Attributes
          • Starting Item Attributes
          • Item Attribute Variables
            • Variables Methods
        • GameItemObject.cs
        • GameItemObjectList.cs
        • ItemAttribute.cs
          • Manage Item Attributes
          • General Settings
          • Name Settings
          • Requisite Attributes
        • GameItemAttribute.cs
        • GameItemAttributeList.cs
        • Code Examples
      • Conditions
        • Condition.cs
          • Main Settings
          • Condition Time
          • Effects on Points
        • GameCondition.cs
        • GameConditionList.cs
        • Expiration Condition Handler
        • Code Examples
      • Quests
        • Quest
          • Main Settings
          • Quest Step Settings
        • Quest Steps
        • Quest Conditions
          • Create a Custom Quest Condition
            • Your Quest Condition
            • Your Quest Condition Editor
            • Your Quest Condition Drawer
          • Quest Condition Details
            • Blackboard Value Bool
            • Blackboard Value GameObject
            • Blackboard Value Number
            • Blackboard Value String
            • Final Stat Is
            • Game Condition List Contains
            • Game Item Object List Contains
            • Game Stat List Contains
          • Quest Condition Enums
        • Quest Rewards
          • Create a Custom Quest Reward
            • Your Quest Reward
            • Your Quest Reward Editor
            • Your Quest Reward Drawer
          • Quest Reward Details
            • Point Reward
            • Condition Reward
            • Quest Quest Reward
            • Item Object Reward
          • Custom Quest Reward Handler
        • GameQuest
        • GameQuestList
        • Quest Events
        • Demo Scene Quests
          • Push the Button
          • Add Money
          • Don't Get Poisoned
          • Rescue the Puppy
      • Voices
        • Voices
        • Voice.cs
        • Code Examples
      • Dictionaries
        • Dictionaries Setup
        • Dictionaries Methods
        • KeyValue Methods
        • Save and Load
        • Object Reference
      • Gametime & Timeboard
        • Timeboard
          • Timeboard Events
          • TimeboardFollower
        • Gametime
          • Pause Level
          • Time Options
          • Properties & Methods
        • TimeSpan
        • Code Examples
      • Property Code
      • Lookup Table
      • Save and Load
        • GameList & GameFile
        • Making objects saveable
        • Saving, and Loading
        • BlackboardEvents sent by Save and Load
    • Game Module "Systems"
      • Drag-and-Drop Inventory System
        • Scripts
          • PanelManager
          • OnScreenItem
          • Panel
          • BoxManager
        • Scene & Class Setup
        • Item / Object Setup
        • Item / Inventory Setup
        • Box Setup (Chests, Bags, Other Inventories)
        • Setup Your Scene
      • First Person Movement
      • Character Creation
    • Game Module Demo Projects
      • Party Based RPG
        • Title Scene
        • Character Creation Scene
        • World & Dungeon Scenes
    • Magic Time for Game Modules
  • ✨Northstar Tracking System
    • ✅Overview & Quickstart
      • ➡️Quick Start
      • 🫐Demo Scene
      • 🛠️Customizing & Overriding
        • Create a Custom Navigation Bar
        • Create a Custom Compass / Radar
        • Runtime Overrides
          • Screen & Edge Overlay
          • Navigation Bar
          • Compass / Radar
      • ☄️Tips & Code Examples
    • Northstar Documentation
      • Global Northstar Settings
      • Northstar Overlay Settings
      • Compass & Radar
        • Compass
        • Radar
      • Northstar Screen Overlay
        • Screen & Edge Overlay
        • Navigation Bar
      • Tracked Target Compass Radar
      • Tracked Target Overlay
        • Types
        • Override Values
      • Overlay Icon
      • Compass Icon
      • Distance Text
  • 🚀Projectile Factory
    • 👀Overview & Quickstart
      • ➡️Quick Start Guide
        • Create Your First Projectile
        • Add Projectile Factory & Create a Projectile Spawner
        • Use 3rd Party Integrations
        • Extending Projectile Factory
        • Making Lasers & Similar Attached Projectiles
      • 💡FAQs + Important Reminders
    • Game Modules 4 Integration
      • Projectiles with TimeMod
    • Magic Time for Projectile Factory
    • ✅3rd Party Particle Integrations [16]
      • ▶️Archanor VFX [5]
        • Sci-Fi Arsenal
        • Polygon Arsenal
        • Magic Arsenal
        • Retro Arsenal
        • Rainbow Magic
      • ▶️Gabriel Aguiar Prod [2]
        • Unique Projectiles Vol. 1
        • Unique Projectiles Vol. 2
      • ▶️HOVL Studio [4]
        • Toon Projectiles
        • Toon Projectiles 2
        • AAA Stylized Projectiles Vol. 1
        • AAA Projectiles Vol. 2
      • ▶️kripto289 [1]
        • Realistic Effects Pack 4
      • ▶️FORGE3D [1]
        • Sci-Fi Effects
      • ▶️Knife [1]
        • PRO Effects - Sci-Fi Shooter FX
      • ▶️Jean Moreno [1]
        • Cartoon FX Remastered
      • ▶️Synty Studios [1]
        • 🟡Synty Studios Particles
    • Projectile Factory Documentation
      • 🔫Projectile Spawner
        • Projectile Spawner Code
      • 🚀Projectile
        • Projectile Code
        • Projectile Data
      • ✨Spawn Behavior
        • Spawn Behavior Code
        • Spawn Behavior Modification
      • 🕊️Behaviors
        • Behavior Examples
      • ⚡Events
      • 👁️Observers, Global Observers, and Observer Objects
        • Toggle Objects At Events Observer Object
      • 👩‍💼Factory Manager
      • 🏹Trajectory
      • 🎱Object Pooling
      • 🤩Create Custom Behaviors
      • Spawn Point Manager
      • Helper Tools
        • Projectiles Quick Editor
        • Set Trail Auto Destroy to False
        • Set Layer of All Projectiles
        • Remove Colliders
      • Additional Scripts
        • Destroy or Pool Object
        • Project Force
        • Raycast Shooter + Handlers
        • Projectile Utilities
  • Additional Systems & Tools
    • 🎨Runtime Color Sampler
      • Quick Start
      • Demo Walkthrough
      • Runtime Color Sampler (Prefab & Class)
        • Sampler Sphere
        • Sampler Camera
      • Runtime Listener
      • Runtime Color Settings
      • Scripting
      • Additional Classes
    • 🙎‍♀️Portrait Avatars
      • Setup
        • Create a Portrait Avatar
        • Create a UI Portrait
      • Portrait Avatars
        • Scripting
      • Portrait3D
      • Portrait2D
      • Portrait UI
      • Avatar Camera
      • Important Considerations
    • 🎛️Audio Clip Combiner
    • 🌈Color Shifter
    • 🛠️Support Classes
      • Utilities.cs
      • InfinityExtensions.cs
  • ⌛Magic Time - Local Time Scale
    • Overview
    • ➡️Quick Start
    • 🛠️Integrations
    • 💡FAQ
    • Local Time Scale
      • Local Time Scale Scripting
    • Magic Time Manager
      • Magic Time Manager Scripting
    • Magic Time User
      • IHaveLocalTime
      • Magic Time User Scripting
      • Additional "Magic Time User" Components
    • Time Zone
  • Equipment Systems
    • Overview
    • Blend Shapes Manager
    • Blend Shapes Preset Manager
    • Prefab and Object Manager
      • Humanoid Demo & Setup
      • EquipmentObject.cs
      • Prefab Groups
      • Variables
      • Scripting Examples
    • Wardrobe Prefab Manager
  • 📽️General Tutorials
    • Quick 3rd Person Controller
  • ⚔️Legend of the Stones
    • Actors, Players, NPCs
    • Systems
      • Game State
  • External Links
  • Get them at the Asset Store
  • Connect on Discord
  • YouTube
  • Twitch
  • 🚧Work In Progress / Coming Soon
Powered by GitBook
On this page

Was this helpful?

  1. Game Modules 4
  2. Module Documentation
  3. Game Module "Lists"
  4. Contains() Methods

GameItemObjectList Contains() Methods

v4.0

Contains amounts of a group of GameItemObjects, optionally distinct

// Most of these have an optional bool distinct parameter, false by default. When true
// the comparison will only count one GameItemObject of each uid. No differentiation 
// will be made for GameItemObjects of the same uid with different ItemAttributes

// Contains > X ItemObjects
public bool ContainsMoreThanXItemObjects(int amount, IEnumerable<ItemObject> itemObjects, bool distinct = false)
public bool ContainsMoreThanXItemObjects(int amount, IEnumerable<GameItemObject> gameItemObjects, bool distinct = false)
public bool ContainsMoreThanXItemObjects(int amount, IEnumerable<string> itemObjectUids, bool distinct = false) 

// Contains < X ItemObjects
public bool ContainsLessThanXItemObjects(int amount, IEnumerable<ItemObject> itemObjects, bool distinct = false)
public bool ContainsLessThanXItemObjects(int amount, IEnumerable<GameItemObject> gameItemObjects, bool distinct = false)
public bool ContainsLessThanXItemObjects(int amount, IEnumerable<string> itemObjectUids, bool distinct = false) 

// Contains exactly X ItemObjects
public bool ContainsExactlyXItemObjects(int amount, IEnumerable<ItemObject> itemObjects, bool distinct = false)
public bool ContainsExactlyXItemObjects(int amount, IEnumerable<GameItemObject> gameItemObjects, bool distinct = false)
public bool ContainsExactlyXItemObjects(int amount, IEnumerable<string> itemObjectUids, bool distinct = false)

// Contains any of the ItemObjects [No distinct option]
public bool ContainsAnyItemObjects(IEnumerable<ItemObject> itemObjects, bool distinct = false)
public bool ContainsAnyItemObjects(IEnumerable<GameItemObject> gameItemObjects, bool distinct = false)
public bool ContainsAnyItemObjects(IEnumerable<string> itemObjectUids, bool distinct = false)

// Contains all of the ItemObjects
public bool ContainsAllItemObjects(IEnumerable<ItemObject> itemObjects, bool distinct = false)
public bool ContainsAllItemObjects(IEnumerable<GameItemObject> gameItemObjects, bool distinct = false)
public bool ContainsAllItemObjects(IEnumerable<string> itemObjectUids, bool distinct = false) 

// Contains none of the ItemObjets [No distinct option]
public bool ContainsNoItemObjects(IEnumerable<ItemObject> itemObjects, bool distinct = false)
public bool ContainsNoItemObjects(IEnumerable<GameItemObject> gameItemObjects, bool distinct = false)
public bool ContainsNoItemObjects(IEnumerable<string> itemObjectUids, bool distinct = false) 

// Example
ItemObject[] itemObjects = new[] { WhistleBerry, Lemon, Cranberries };
if (gameItemObjectList.ContainsAllItemObjects(itemObjects))
    MakeCranberryCocktail();

Contains a GameItemObject with Attribute(s)

// If itemObjectUid is provided, then only that itemObject will be checked

// Contains a GameItemObject with a specific ItemAttribute
public bool ContainsWithAttribute(ItemAttribute attribute, string itemObjectUid = null)
public bool ContainsWithAttribute(GameItemAttribute gameAttribute, string itemObjectUid = null)
public bool ContainsWithAttribute(string attributeUid, string itemObjectUid = null)

// Contains a GameItemObject with all of the provided ItemAttributes
public bool ContainsWithAllAttributes(IEnumerable<ItemAttribute> attributes, string itemObjectUid = null)
public bool ContainsWithAllAttributes(IEnumerable<GameItemAttribute> gameAttributes, string itemObjectUid = null)
public bool ContainsWithAllAttributes(IEnumerable<string> attributeUids, string itemObjectUid = null)

// Contains a GameItemObject with ANY of the provided ItemAttributes
public bool ContainsWithAnyAttributes(IEnumerable<ItemAttribute> attributes, string itemObjectUid = null)
public bool ContainsWithAnyAttributes(IEnumerable<GameItemAttribute> gameAttributes, string itemObjectUid = null)
public bool ContainsWithAnyAttributes(IEnumerable<string> attributeUids, string itemObjectUid = null)

// Contains a GameItemObject with Exactly X ItemAttributes
public bool ContainsWithExactlyXAttributes(int amount, ItemObject itemObject)
public bool ContainsWithExactlyXAttributes(int amount, GameItemObject gameItemObject)
public bool ContainsWithExactlyXAttributes(int amount, string itemObjectUid = null)

// Contains a GameItemObject with Less than X ItemAttributes
public bool ContainsWithLessThanXAttributes(int amount, ItemObject itemObject) 
public bool ContainsWithLessThanXAttributes(int amount, GameItemObject gameItemObject)
public bool ContainsWithLessThanXAttributes(int amount, string itemObjectUid = null)

// Contains a GameItemObject with more than X ItemAttributes
public bool ContainsWithMoreThanXAttributes(int amount, ItemObject itemObject)
public bool ContainsWithMoreThanXAttributes(int amount, GameItemObject gameItemObject)
public bool ContainsWithMoreThanXAttributes(int amount, string itemObjectUid = null)

// Contains a GameItemObject with no ItemAttributes
public bool ContainsWithNoAttributes(ItemObject itemObject)
public bool ContainsWithNoAttributes(GameItemObject gameItemObject)
public bool ContainsWithNoAttributes(string itemObjectUid = null)

Contains a GameItemObject with Attribute(s)

// If itemObjectUid is provided, then only that itemObject will be checked

// Contains exactly X GameItemObjects
public bool ContainsExactlyXItemObjects(int amount, ItemObject itemObject)
public bool ContainsExactlyXItemObjects(int amount, GameItemObject gameItemObject)
public bool ContainsExactlyXItemObjects(int amount, string itemObjectUid = null)

// Contains less than X GameItemObjects
public bool ContainsLessThanXItemObjects(int amount, ItemObject itemObject)
public bool ContainsLessThanXItemObjects(int amount, GameItemObject gameItemObject)
public bool ContainsLessThanXItemObjects(int amount, string itemObjectUid = null)

// Contains more than X GameItemObjects
public bool ContainsMoreThanXItemObjects(int amount, ItemObject itemObject)
public bool ContainsMoreThanXItemObjects(int amount, GameItemObject gameItemObject)
public bool ContainsMoreThanXItemObjects(int amount, string itemObjectUid = null)

// Is Empty
public bool IsEmpty()

Contains a ItemAttribute (anywhere in any item)

public bool ContainsAttribute(ItemAttribute itemAttribute)
public bool ContainsAttribute(GameItemAttribute gameItemAttribute)
public bool ContainsAttribute(string uid)

Contains by status

Find out if the list contains quests of a specific status, optionally of a specific uid.

public bool ContainsQuestsInProgress(string uid = null)
public bool ContainsQuestsSucceeded(string uid = null)
public bool ContainsQuestsFailed(string uid = null)
public bool ContainsQuestsCompleted(string uid = null)

// Example
if (gameQuestList.ContainsQuestsFailed())
    Debug.Log("At some point, we have failed in our quest!");

// Each of the above also has a version that accepts a Quest or GameQuest instead
// of the uid.
public bool ContainsQuestsFailed(Quest quest)
public bool ContainsQuestsFailed(GameQuest gameQuest)

Contains quests which affect stats

GameQuests can modify Stats while they are in any of their states.

public bool ContainsQuestsWhichModifyStats()

// Example
if (ContainsQuestsWhichModifyStats())
    Debug.Log("At least one quest may be modifying Stats");

Contains Duplicates

These methods will return true if there are duplicates. The single-object methods have an optional itemObjectUid, when null, will return true if there are any duplicates in the list.

There is also an optional bool includeItemAttributes, which is false by default. When true, a GameItemObject must match both its Uid() and its list of ItemAttributes to qualify as a duplicate.

public bool ContainsDuplicates(ItemObject itemObject, bool includeItemAttributes = false)
public bool ContainsDuplicates(GameItemObject gameItemObject, bool includeItemAttributes = false)
public bool ContainsDuplicates(string itemObjectUid = null, bool includeItemAttributes = false)

// Specify a group of ItemObjects to check against
public bool ContainsDuplicates(IEnumerable<ItemObject> itemObjects, bool includeItemAttributes = false)
public bool ContainsDuplicates(IEnumerable<GameItemObject> gameItemObjects, bool includeItemAttributes = false)
public bool ContainsDuplicates(IEnumerable<string> itemObjectUids, bool includeItemAttributes = false)

// Examples
if (ContainsDuplicates())
    RemoveDuplicates();
    
ItemObject[] itemObjects = new[] { Sword, Shield, Helmet };
if (ContainsDuplicates(itemObjects, true))
    RemoveDuplicates(itemObjects, true);

Additional Contains Methods

// True if at least one ItemObject is a Quest Item
public bool ContainsQuestItem()
PreviousGameStatList Contains() MethodsNextGameItemAttributeList Contains() Methods

Last updated 1 year ago

Was this helpful?