Truxton artifact get type

From truxwiki.com
Jump to navigation Jump to search

This tells you what the artifact is. This information comes from the [EntityTypeID] column of the [Entity] table in the database or a defined constant.

Syntax

uint64_t truxton_artifact_get_type( uint64_t artifact_handle );

Parameters

artifact_handle

The artifact instance. This handle comes from calling truxton_artifact_create().

Return value

The type of the artifact. This is stored in the [EntityTypeID] column of the [Entity] table and should contain a value from the [ID] column of the [EntityType] table or one of the defined constants.

Sample

void create_artifact( void )
{
   uint64_t truxton = truxton_create();

   uint64_t artifact = truxton_artifact_create( truxton );

   truxton_artifact_set_name( artifact, "Ducky Momo Server" );
   truxton_artifact_set_type( artifact, ENTITY_TYPE_MACHINE_NAME );
   truxton_artifact_save( artifact );
   truxton_artifact_tag( artifact, "Too Young", "Yes, yes I am", 1 );

   uint64_t entity_type = truxton_artifact_get_type( artifact );

   printf( "Artifact type is %" PRIu64 "\n", data_type );

   truxton_artifact_destroy( artifact );
   truxton_destroy( truxton );
}

The PRIu64 in the sample code above is a standard way of formatting a 64-bit unsigned integer in C. Over the years, different compilers on different operating systems used different format specifiers for things, these PRI macros, along with some tricky string concatenation the compilers perform for you, allow you to maintain a single code base without a bunch of macro magic.