This method removes a PTPattern
from a
PTModule
object and updates the
patternOrder
table accordingly.
Arguments
- x
- index
A
numeric
index of thePTPattern
table that needs to be removed. The index should be between 1 andpatternLength
. It's not possible to delete multiple patterns simultaneously with this method. APTModule
should always hold at least 1 pattern table, therefore, the lastPTPattern
table cannot be deleted.
Details
This method safely removes a PTPattern
from a
PTModule
object, guarding the validity of the
PTModule
object. It therefore also updates
the patternOrder
table, by renumbering the indices
listed there. The index of the removed object is replaced with a zero
in the patternOrder
table.
Note
As per ProTracker specification, the pattern indices
stored in the PTModule
and obtained with
patternOrder
start at 0. Whereas R starts indexing at 1.
Beware of this discrepancy.
See also
Other pattern.operations:
MODPlugToPTPattern()
,
PTPattern-class
,
PTPattern-method
,
PTPatternToMODPlug()
,
appendPattern()
,
pasteBlock()
,
patternLength()
,
patternOrderLength()
,
patternOrder()
Other module.operations:
PTModule-class
,
appendPattern()
,
clearSamples()
,
clearSong()
,
fix.PTModule()
,
modToWave()
,
moduleSize()
,
patternLength()
,
patternOrderLength()
,
patternOrder()
,
playMod()
,
playingtable()
,
rawToPTModule()
,
read.module()
,
trackerFlag()
,
write.module()
Examples
data("mod.intro")
print(mod.intro)
#>
#> PTModule Object:
#> Module name: intro
#> Number of samples: 4
#> Number of patterns: 4
#> Pattern order table length: 9
## delete pattern #2 from mod.intro:
mod.intro <- deletePattern(mod.intro, 2)
print(mod.intro)
#>
#> PTModule Object:
#> Module name: intro
#> Number of samples: 4
#> Number of patterns: 3
#> Pattern order table length: 9