Here you will find documentation on all the descriptions that Cinema 4D currently has. You can list them Alphabetically, by Type or Plugin . The sample Python and C++ code is automatically generated and in some cases may not be 100% correct. If something doesn't work then please refer to the official Cinema 4D SDK documentation for more information.

Description Txcache

IDs and information for Txcache

Txcache

Attributes

  • ENGLISH NAME : X-ParticlesCacheTag
  • NAME : Txcache
  • INCLUDE : Tbase
  • PATH : res/description/txcache.res
  • PLUGIN : X-Particles
  • MAXON online help (may not exist): TXCACHE

Elements

ID UI Name Type Parameters Cycle
ID_XP_TAG_CACHE_PLAY EnableCache BOOL  
ID_XP_TAG_CACHE_ALLOWCOPY CopyTagData BOOL ANIM
ID_XP_TAG_CACHE_COPYPLAYBLAST AutoCopyonPreviewRender BOOL ANIM
ID_XP_TAG_CACHE_DESCRIPTION Description STRING ANIM
ID_XP_TAG_CACHE_OBJECT CacheObject LINK  
ID_XP_TAG_CACHE_OVERRIDE Override BOOL  
ID_XP_TAG_CACHE_HOLD Hold BOOL  
ID_XP_TAG_CACHE_WRAP Cycle BOOL SCALE_H
ID_XP_TAG_CACHE_LOCALCOORDS LocalCoords BOOL  
ID_XP_TAG_CACHE_PERFRAME PlayPerFrame BOOL  
ID_XP_TAG_CACHE_FRAME Frame BASETIME SCALE_H
ID_XP_TAG_CACHE_OFFSET Offset BASETIME  
ID_XP_TAG_CACHE_SCALE Scale REAL
UNIT PERCENT
MINSLIDER -100.0
MAXSLIDER 100.0
CUSTOMGUI REALSLIDER
SCALE_H
ID_XP_TAG_CACHE_TIME_AUTO AutoTime BOOL  
ID_XP_TAG_CACHE_TIME_START Start BASETIME  
ID_XP_TAG_CACHE_TIME_STOP Stop BASETIME SCALE_H
ID_XP_TAG_CACHE_FOLDER Folder FILENAME
DIRECTORY
PARENTCOLLAPSE
ID_XP_TAG_CACHE_EXT ExtSeparator STRING PARENTCOLLAPSE
ID_XP_TAG_CACHE_FILE_ASSETS CacheFilesasAssets BOOL ANIM
ID_XP_TAG_CACHE_FILE_SCALE Scale REAL
MIN 0.0
CUSTOMGUI REALSLIDER
ID_XP_TAG_CACHE_PLAY_DATA_AS CustomPlay BOOL  
ID_XP_TAG_CACHE_PLAY_DATA_POSITION Position BOOL HIDDEN
ID_XP_TAG_CACHE_PLAY_DATA_VELOCITY Velocity BOOL  
ID_XP_TAG_CACHE_PLAY_DATA_TIME Time BOOL  
ID_XP_TAG_CACHE_PLAY_DATA_LIFE Life BOOL  
ID_XP_TAG_CACHE_PLAY_DATA_COLOR Color BOOL  
ID_XP_TAG_CACHE_PLAY_DATA_DISPLAY Display BOOL  
ID_XP_TAG_CACHE_PLAY_DATA_ID ID BOOL  
ID_XP_TAG_CACHE_PLAY_DATA_MODIFIERS Modifiers BOOL  
ID_XP_TAG_CACHE_PLAY_DATA_CUSTOM Custom BOOL HIDDEN
ID_XP_TAG_CACHE_PLAY_DATA_GROUPID Group BOOL  
ID_XP_TAG_CACHE_PLAY_DATA_RADIUS Radius BOOL  
ID_XP_TAG_CACHE_PLAY_DATA_MASS Mass BOOL  
ID_XP_TAG_CACHE_PLAY_DATA_TEMPERATURE Temperature BOOL  
ID_XP_TAG_CACHE_PLAY_DATA_BURN Fire BOOL  
ID_XP_TAG_CACHE_PLAY_DATA_FUEL Fuel BOOL  
ID_XP_TAG_CACHE_PLAY_DATA_SMOKE Smoke BOOL  
ID_XP_TAG_CACHE_PLAY_DATA_DISTANCE Distance BOOL  
ID_XP_TAG_CACHE_PLAY_DATA_ROTATION Rotation BOOL  
ID_XP_TAG_CACHE_HELP_BUTTON BITMAPBUTTON  
ID_XP_TAG_CACHE_VIDMAN_BUTTON BITMAPBUTTON  

Example Code

The following code does not use the correct values when setting the data. You should check directly in C4D for the correct values that you should use in place of the ones that are shown. This code is just to show you how to access the values for getting and setting the parameters.

Python

import c4d
from c4d import gui
def main():
    obj = c4d.BaseObject(c4d.Osphere)
    tag = obj.MakeTag(c4d.Txcache)
    doc.InsertObject(obj)
    c4d.EventAdd(c4d.EVENT_FORCEREDRAW)
    
    #You can set parameters two different ways. 
    #First way              
    tag[c4d.ID_XP_TAG_CACHE_PLAY] = True
    tag[c4d.ID_XP_TAG_CACHE_ALLOWCOPY] = True
    tag[c4d.ID_XP_TAG_CACHE_COPYPLAYBLAST] = True
    tag[c4d.ID_XP_TAG_CACHE_DESCRIPTION] = "Hello World"
    tag[c4d.ID_XP_TAG_CACHE_OVERRIDE] = True
    tag[c4d.ID_XP_TAG_CACHE_HOLD] = True
    tag[c4d.ID_XP_TAG_CACHE_WRAP] = True
    tag[c4d.ID_XP_TAG_CACHE_LOCALCOORDS] = True
    tag[c4d.ID_XP_TAG_CACHE_PERFRAME] = True
    tag[c4d.ID_XP_TAG_CACHE_SCALE] = 0.1
    tag[c4d.ID_XP_TAG_CACHE_TIME_AUTO] = True
    tag[c4d.ID_XP_TAG_CACHE_FOLDER] = "c:\\SomeFile.txt"
    tag[c4d.ID_XP_TAG_CACHE_EXT] = "Hello World"
    tag[c4d.ID_XP_TAG_CACHE_FILE_ASSETS] = True
    tag[c4d.ID_XP_TAG_CACHE_FILE_SCALE] = 0.1
    tag[c4d.ID_XP_TAG_CACHE_PLAY_DATA_AS] = True
    tag[c4d.ID_XP_TAG_CACHE_PLAY_DATA_POSITION] = True
    tag[c4d.ID_XP_TAG_CACHE_PLAY_DATA_VELOCITY] = True
    tag[c4d.ID_XP_TAG_CACHE_PLAY_DATA_TIME] = True
    tag[c4d.ID_XP_TAG_CACHE_PLAY_DATA_LIFE] = True
    tag[c4d.ID_XP_TAG_CACHE_PLAY_DATA_COLOR] = True
    tag[c4d.ID_XP_TAG_CACHE_PLAY_DATA_DISPLAY] = True
    tag[c4d.ID_XP_TAG_CACHE_PLAY_DATA_ID] = True
    tag[c4d.ID_XP_TAG_CACHE_PLAY_DATA_MODIFIERS] = True
    tag[c4d.ID_XP_TAG_CACHE_PLAY_DATA_CUSTOM] = True
    tag[c4d.ID_XP_TAG_CACHE_PLAY_DATA_GROUPID] = True
    tag[c4d.ID_XP_TAG_CACHE_PLAY_DATA_RADIUS] = True
    tag[c4d.ID_XP_TAG_CACHE_PLAY_DATA_MASS] = True
    tag[c4d.ID_XP_TAG_CACHE_PLAY_DATA_TEMPERATURE] = True
    tag[c4d.ID_XP_TAG_CACHE_PLAY_DATA_BURN] = True
    tag[c4d.ID_XP_TAG_CACHE_PLAY_DATA_FUEL] = True
    tag[c4d.ID_XP_TAG_CACHE_PLAY_DATA_SMOKE] = True
    tag[c4d.ID_XP_TAG_CACHE_PLAY_DATA_DISTANCE] = True
    tag[c4d.ID_XP_TAG_CACHE_PLAY_DATA_ROTATION] = True
    
    #Second way, using the base container.
    bc = tag.GetDataInstance()
    bc.SetBool(c4d.ID_XP_TAG_CACHE_PLAY,True)
    bc.SetBool(c4d.ID_XP_TAG_CACHE_ALLOWCOPY,True)
    bc.SetBool(c4d.ID_XP_TAG_CACHE_COPYPLAYBLAST,True)
    bc.SetString(c4d.ID_XP_TAG_CACHE_DESCRIPTION,"Hello World")
    bc.SetBool(c4d.ID_XP_TAG_CACHE_OVERRIDE,True)
    bc.SetBool(c4d.ID_XP_TAG_CACHE_HOLD,True)
    bc.SetBool(c4d.ID_XP_TAG_CACHE_WRAP,True)
    bc.SetBool(c4d.ID_XP_TAG_CACHE_LOCALCOORDS,True)
    bc.SetBool(c4d.ID_XP_TAG_CACHE_PERFRAME,True)
    bc.SetFloat(c4d.ID_XP_TAG_CACHE_SCALE,0.1)
    bc.SetBool(c4d.ID_XP_TAG_CACHE_TIME_AUTO,True)
    bc.SetFileName(c4d.ID_XP_TAG_CACHE_FOLDER,"c:\\SomeFile.txt")
    bc.SetString(c4d.ID_XP_TAG_CACHE_EXT,"Hello World")
    bc.SetBool(c4d.ID_XP_TAG_CACHE_FILE_ASSETS,True)
    bc.SetFloat(c4d.ID_XP_TAG_CACHE_FILE_SCALE,0.1)
    bc.SetBool(c4d.ID_XP_TAG_CACHE_PLAY_DATA_AS,True)
    bc.SetBool(c4d.ID_XP_TAG_CACHE_PLAY_DATA_POSITION,True)
    bc.SetBool(c4d.ID_XP_TAG_CACHE_PLAY_DATA_VELOCITY,True)
    bc.SetBool(c4d.ID_XP_TAG_CACHE_PLAY_DATA_TIME,True)
    bc.SetBool(c4d.ID_XP_TAG_CACHE_PLAY_DATA_LIFE,True)
    bc.SetBool(c4d.ID_XP_TAG_CACHE_PLAY_DATA_COLOR,True)
    bc.SetBool(c4d.ID_XP_TAG_CACHE_PLAY_DATA_DISPLAY,True)
    bc.SetBool(c4d.ID_XP_TAG_CACHE_PLAY_DATA_ID,True)
    bc.SetBool(c4d.ID_XP_TAG_CACHE_PLAY_DATA_MODIFIERS,True)
    bc.SetBool(c4d.ID_XP_TAG_CACHE_PLAY_DATA_CUSTOM,True)
    bc.SetBool(c4d.ID_XP_TAG_CACHE_PLAY_DATA_GROUPID,True)
    bc.SetBool(c4d.ID_XP_TAG_CACHE_PLAY_DATA_RADIUS,True)
    bc.SetBool(c4d.ID_XP_TAG_CACHE_PLAY_DATA_MASS,True)
    bc.SetBool(c4d.ID_XP_TAG_CACHE_PLAY_DATA_TEMPERATURE,True)
    bc.SetBool(c4d.ID_XP_TAG_CACHE_PLAY_DATA_BURN,True)
    bc.SetBool(c4d.ID_XP_TAG_CACHE_PLAY_DATA_FUEL,True)
    bc.SetBool(c4d.ID_XP_TAG_CACHE_PLAY_DATA_SMOKE,True)
    bc.SetBool(c4d.ID_XP_TAG_CACHE_PLAY_DATA_DISTANCE,True)
    bc.SetBool(c4d.ID_XP_TAG_CACHE_PLAY_DATA_ROTATION,True)

if __name__=='__main__':
    main()

C++

#include "c4d.h"
#include "../res/description/txcache.h"
void SampleFunction()
{
    BaseDocument *pDoc = GetActiveDocument();
    BaseObject *pObject = BaseObject::Alloc(Osphere);
    pDoc->InsertObject(pObject);
    pDoc->StartUndo();
    pDoc->AddUndo(UNDOTYPE_NEW,pObject);
    pDoc->EndUndo();
    pDoc->StartUndo();
    BaseTag *pTag = pObject->MakeTag(Txcache);
    pDoc->AddUndo(UNDOTYPE_NEW,pTag);
    pDoc->EndUndo();
    pObject->Message(MSG_UPDATE);
    
    //You can set parameters two different ways. 

    //First way              
    //Some objects do not store all their data in the container. You need to use GetParameter()/SetParameter() instead. 

    DESCFLAGS_SET flags = DESCFLAGS_SET_PARAM_SET;
    pTag->SetParameter(DescID(ID_XP_TAG_CACHE_PLAY),GeData(true),flags);
    pTag->SetParameter(DescID(ID_XP_TAG_CACHE_ALLOWCOPY),GeData(true),flags);
    pTag->SetParameter(DescID(ID_XP_TAG_CACHE_COPYPLAYBLAST),GeData(true),flags);
    pTag->SetParameter(DescID(ID_XP_TAG_CACHE_DESCRIPTION),GeData("Hello World"),flags);
    pTag->SetParameter(DescID(ID_XP_TAG_CACHE_OVERRIDE),GeData(true),flags);
    pTag->SetParameter(DescID(ID_XP_TAG_CACHE_HOLD),GeData(true),flags);
    pTag->SetParameter(DescID(ID_XP_TAG_CACHE_WRAP),GeData(true),flags);
    pTag->SetParameter(DescID(ID_XP_TAG_CACHE_LOCALCOORDS),GeData(true),flags);
    pTag->SetParameter(DescID(ID_XP_TAG_CACHE_PERFRAME),GeData(true),flags);
    pTag->SetParameter(DescID(ID_XP_TAG_CACHE_SCALE),GeData(0.1),flags);
    pTag->SetParameter(DescID(ID_XP_TAG_CACHE_TIME_AUTO),GeData(true),flags);
    pTag->SetParameter(DescID(ID_XP_TAG_CACHE_FOLDER),GeData(Filename("c:\\SomeFile.txt"),flags);
    pTag->SetParameter(DescID(ID_XP_TAG_CACHE_EXT),GeData("Hello World"),flags);
    pTag->SetParameter(DescID(ID_XP_TAG_CACHE_FILE_ASSETS),GeData(true),flags);
    pTag->SetParameter(DescID(ID_XP_TAG_CACHE_FILE_SCALE),GeData(0.1),flags);
    pTag->SetParameter(DescID(ID_XP_TAG_CACHE_PLAY_DATA_AS),GeData(true),flags);
    pTag->SetParameter(DescID(ID_XP_TAG_CACHE_PLAY_DATA_POSITION),GeData(true),flags);
    pTag->SetParameter(DescID(ID_XP_TAG_CACHE_PLAY_DATA_VELOCITY),GeData(true),flags);
    pTag->SetParameter(DescID(ID_XP_TAG_CACHE_PLAY_DATA_TIME),GeData(true),flags);
    pTag->SetParameter(DescID(ID_XP_TAG_CACHE_PLAY_DATA_LIFE),GeData(true),flags);
    pTag->SetParameter(DescID(ID_XP_TAG_CACHE_PLAY_DATA_COLOR),GeData(true),flags);
    pTag->SetParameter(DescID(ID_XP_TAG_CACHE_PLAY_DATA_DISPLAY),GeData(true),flags);
    pTag->SetParameter(DescID(ID_XP_TAG_CACHE_PLAY_DATA_ID),GeData(true),flags);
    pTag->SetParameter(DescID(ID_XP_TAG_CACHE_PLAY_DATA_MODIFIERS),GeData(true),flags);
    pTag->SetParameter(DescID(ID_XP_TAG_CACHE_PLAY_DATA_CUSTOM),GeData(true),flags);
    pTag->SetParameter(DescID(ID_XP_TAG_CACHE_PLAY_DATA_GROUPID),GeData(true),flags);
    pTag->SetParameter(DescID(ID_XP_TAG_CACHE_PLAY_DATA_RADIUS),GeData(true),flags);
    pTag->SetParameter(DescID(ID_XP_TAG_CACHE_PLAY_DATA_MASS),GeData(true),flags);
    pTag->SetParameter(DescID(ID_XP_TAG_CACHE_PLAY_DATA_TEMPERATURE),GeData(true),flags);
    pTag->SetParameter(DescID(ID_XP_TAG_CACHE_PLAY_DATA_BURN),GeData(true),flags);
    pTag->SetParameter(DescID(ID_XP_TAG_CACHE_PLAY_DATA_FUEL),GeData(true),flags);
    pTag->SetParameter(DescID(ID_XP_TAG_CACHE_PLAY_DATA_SMOKE),GeData(true),flags);
    pTag->SetParameter(DescID(ID_XP_TAG_CACHE_PLAY_DATA_DISTANCE),GeData(true),flags);
    pTag->SetParameter(DescID(ID_XP_TAG_CACHE_PLAY_DATA_ROTATION),GeData(true),flags);
    pTag->Message(MSG_UPDATE);            

    //Second way, using the base container.
    BaseContainer *bc =     pTag->GetDataInstance();
    bc->SetBool(ID_XP_TAG_CACHE_PLAY,true);
    bc->SetBool(ID_XP_TAG_CACHE_ALLOWCOPY,true);
    bc->SetBool(ID_XP_TAG_CACHE_COPYPLAYBLAST,true);
    bc->SetString(ID_XP_TAG_CACHE_DESCRIPTION,"Hello World");
    bc->SetBool(ID_XP_TAG_CACHE_OVERRIDE,true);
    bc->SetBool(ID_XP_TAG_CACHE_HOLD,true);
    bc->SetBool(ID_XP_TAG_CACHE_WRAP,true);
    bc->SetBool(ID_XP_TAG_CACHE_LOCALCOORDS,true);
    bc->SetBool(ID_XP_TAG_CACHE_PERFRAME,true);
    bc->SetFloat(ID_XP_TAG_CACHE_SCALE,0.1);
    bc->SetBool(ID_XP_TAG_CACHE_TIME_AUTO,true);
    bc->SetFileName(ID_XP_TAG_CACHE_FOLDER,"c:\\SomeFile.txt");
    bc->SetString(ID_XP_TAG_CACHE_EXT,"Hello World");
    bc->SetBool(ID_XP_TAG_CACHE_FILE_ASSETS,true);
    bc->SetFloat(ID_XP_TAG_CACHE_FILE_SCALE,0.1);
    bc->SetBool(ID_XP_TAG_CACHE_PLAY_DATA_AS,true);
    bc->SetBool(ID_XP_TAG_CACHE_PLAY_DATA_POSITION,true);
    bc->SetBool(ID_XP_TAG_CACHE_PLAY_DATA_VELOCITY,true);
    bc->SetBool(ID_XP_TAG_CACHE_PLAY_DATA_TIME,true);
    bc->SetBool(ID_XP_TAG_CACHE_PLAY_DATA_LIFE,true);
    bc->SetBool(ID_XP_TAG_CACHE_PLAY_DATA_COLOR,true);
    bc->SetBool(ID_XP_TAG_CACHE_PLAY_DATA_DISPLAY,true);
    bc->SetBool(ID_XP_TAG_CACHE_PLAY_DATA_ID,true);
    bc->SetBool(ID_XP_TAG_CACHE_PLAY_DATA_MODIFIERS,true);
    bc->SetBool(ID_XP_TAG_CACHE_PLAY_DATA_CUSTOM,true);
    bc->SetBool(ID_XP_TAG_CACHE_PLAY_DATA_GROUPID,true);
    bc->SetBool(ID_XP_TAG_CACHE_PLAY_DATA_RADIUS,true);
    bc->SetBool(ID_XP_TAG_CACHE_PLAY_DATA_MASS,true);
    bc->SetBool(ID_XP_TAG_CACHE_PLAY_DATA_TEMPERATURE,true);
    bc->SetBool(ID_XP_TAG_CACHE_PLAY_DATA_BURN,true);
    bc->SetBool(ID_XP_TAG_CACHE_PLAY_DATA_FUEL,true);
    bc->SetBool(ID_XP_TAG_CACHE_PLAY_DATA_SMOKE,true);
    bc->SetBool(ID_XP_TAG_CACHE_PLAY_DATA_DISTANCE,true);
    bc->SetBool(ID_XP_TAG_CACHE_PLAY_DATA_ROTATION,true);
    pTag->Message(MSG_UPDATE);                                                      
}

Buttons

This node has buttons. Buttons can manually be executed by calling the following code

Python

c4d.CallButton(tag,c4d.ID_XP_TAG_CACHE_HELP_BUTTON)
c4d.CallButton(tag,c4d.ID_XP_TAG_CACHE_VIDMAN_BUTTON)

C++

DescriptionCommand dc;
dc.id = DescID(ID_XP_TAG_CACHE_HELP_BUTTON);             
pTag->Message(MSG_DESCRIPTION_COMMAND, &dc);


DescriptionCommand dc;
dc.id = DescID(ID_XP_TAG_CACHE_VIDMAN_BUTTON);             
pTag->Message(MSG_DESCRIPTION_COMMAND, &dc);