[SOLVED] What does the TagGroupReleaseSeeds function do in DM script?

What does the TagGroupReleaseSeeds function do in DM script?

I'm currently working with DM script and encountered the function TagGroupReleaseSeeds(). The manual states that it "Releases the seeds returned by TagGroupGetSeeds," but I'm not entirely sure what that means in practical terms.

My questions are:

What exactly are "seeds" in this context?
Does releasing these seeds mean freeing up memory or resources, or is there another purpose?
Could someone provide a more detailed explanation or example of when and how to use TagGroupReleaseSeeds() effectively?

Any clarification would be greatly appreciated. Thanks!

Solution

It is unlikely that these commands are of much use to you.

Their purpose is to check the "dirty" state of a TagGroup (i.e. whether it changed since some other point in time.) Essentially, a TagGroup has an internal "counter" of changes which is increased whenever it is changed. You can use it like this:

ClearResults()
taggroup testTG = NewTagGroup()
Result("Seeds of Taggroup:\n")
Result( testTG.TagGroupGetSeeds() +"\n")
Result( testTG.TagGroupGetSeeds() +"\n")
testTG.TagGroupSetTagAsNumber("Dummy",-100)
Result( testTG.TagGroupGetSeeds() +"\n")
testTG.TagGroupSetTagAsNumber("Dummy",100)
Result( testTG.TagGroupGetSeeds() +"\n")
testTG.TagGroupSetTagAsNumber("Dummy2",-100)
Result( testTG.TagGroupGetSeeds() +"\n")
testTG.TagGroupMarkAsChanged()
Result( testTG.TagGroupGetSeeds() +"\n")

Result("\n Remember Tag state...") 
number seeds = testTG.TagGroupGetSeeds()
testTG.TagGroupSetTagAsString("str","dummy")

if ( testTG.TagGroupHasChangedSince(seeds) )
    Result("\n Tag was changed since remembered state...")