Version: Unity 7.0 Alpha (7000.0)
LanguageEnglish
  • C#

EntityQuery.TryGetSingleton

Leave feedback
Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Declaration

public bool TryGetSingleton(out T value);

Parameters

Parameter Description
value The component. if an Entity with the specified type does not exist in the World, this is assigned a default value

Returns

bool True, if exactly one Entity exists in the World with the provided component type.

Description

Gets the value of a singleton component, and returns whether or not a singleton component of the specified type matches inside the EntityQuery. Note that if querying a singleton component from a system-associated entity, the query must include either EntityQueryOptions.IncludeSystems or the SystemInstance component.

Is something described here not working as you expect it to? It might be a Known Issue. Please check with the Issue Tracker at issuetracker.unity3d.com.

Copyright ©2005-2026 Unity Technologies. All rights reserved. Built from job ID 77614794. Built on: 2026-10-15.
Tutorials Community Answers Knowledge Base Forums Asset Store Terms of use Legal Privacy Policy Cookies Documentation Terms of Use Do Not Sell or Share My Personal Information