Overview

The Universal Query System (UQS) Standard Library (StdLib) is a set of item types, functions, generators and evaluators that are meant as a reference for how to implement custom ones but can also be used out of the box by your game.

It's a static library and needs to be linked to your game executable.

Technically speaking, the StdLib resides on the same layer as your game's custom item types, functions, etc.

In order to make the StdLib's content available for registration in the UQS core, a single method call will suffice:

UQS::StdLib::CStdLibRegistration::InstantiateAllFactoriesForRegistration(); 

Contents of the StdLib

As of writing, the StdLib currently provides the following elements, which are all registered with the "std::" prefix:

• Item types:
  • std::EntityId
  • std::int
  • std::bool
  • std::float
  • std::Pos3
  • std::Ofs3
  • std::Dir3
  • std::NavigationAgentTypeID

• Functions:
  • std::Pos3 std::Pos3AddOfs3 ( std::Pos3 pos, std::Ofs3 ofs )
  • std::Pos3 std::PosFromEntity ( std::EntityId entityId )

• Generators:
  • std::Pos3[] std::PointsOnPureGrid ( std::Pos3 center, std::float size, std::float spacing )
  • std::Pos3[] std::PointsOnNavMesh ( std::Pos3 pivot, std::Ofs3 localAABBMins, std::Ofs3 localAABBMaxs, std::NavigationAgentTypeID navigationAgentTypeID )

• InstantEvaluators:
  • std::TestMinDistance ( std::Pos3 pos1, std::Pos3 pos2, std::float minRequiredDistance )
  • std::TestMaxDistance ( std::Pos3 pos1, std::Pos3 pos2, std::float maxAllowedDistance )
  • std::TestLocationInNavMesh ( std::Pos3 locationToTest, std::NavigationAgentTypeID navigationAgentTypeID )
  • std::ScoreDistance ( std::Pos3 pos1, std::Pos3 pos2, std::float distanceThreshold )
  • std::ScoreDistanceInverse ( std::Pos3 pos1, std::Pos3 pos2, std::float distanceThreshold )
  • std::ScoreRandom ()

• DeferredEvaluators:
  • std::TestRaycast ( std::Pos3 from, std::Pos3 to, bool raycastShallSucceed )