Resource::StandardFileFilter class
#include <Spore ModAPI/Spore/Resource/IKeyFilter.h>

The standard file filter which filters resources depending on the ResourceKey.

This filter accepts ResourceKey values if they match certain instanceIDs, typeIDs or groupIDs, allowing to use wildcardss (i.e. accept all) on each of them. Additionally, a mask can be specified for groupIDs, so only certain parts of the groupID are required to match.

Base classes

class IKeyFilter: A generic interface used to filter ResourceKey objects.

Constructors, destructors, conversion operators

StandardFileFilter(uint32_t instanceID = ResourceKey::kWildcardID, uint32_t groupID = ResourceKey::kWildcardID, uint32_t typeID = ResourceKey::kWildcardID, uint32_t groupMask = ResourceKey::kWildcardID)
~StandardFileFilter() virtual

Public functions

auto IsValid(const ResourceKey& name) -> bool override: A method used to determine whether a file with this ResourceKey name is accepted.
auto SetInstanceId(uint32_t value) -> StandardFileFilter&
auto SetGroupId(uint32_t value) -> StandardFileFilter&
auto SetTypeId(uint32_t value) -> StandardFileFilter&
auto SetGroupMask(uint32_t value) -> StandardFileFilter&

Public variables

uint32_t instanceID
uint32_t groupID
uint32_t typeID
uint32_t groupMask

Function documentation

bool Resource::StandardFileFilter::IsValid(const ResourceKey& name) override

A method used to determine whether a file with this ResourceKey name is accepted.

Parameters
name
Returns	True if the file is accepted, false otherwise.