gpeDeleteDummyEntries
gpeDeleteDummyEntries(
u_sandbox
g_includeInternal
g_unplaceOnly
g_fullRCOnly
[ ?verbose { t | nil } ]
)
=> t / nil
Description
Deletes dummy entries from the given Modgen sandbox object and compresses the grid based on the specified options.
Arguments
|
u_sandbox
|
Specifies the Modgen sandbox object.
|
|
g_includeInternal
|
Specifies whether internal dummies must be deleted. Valid values are t and nil.
When set to t, internal dummies are deleted. Internal dummies are the dummies present between instances.
Example of internal dummies:
* * A B
A C D B
When set to nil, only the non-internal dummies are deleted. Non-internal dummies are the dummies that form full rows or columns at the edges of a Modgen.
Examples of non-internal dummies:
Row of non-internal dummies:
* * * *
A A B B
C D A A
Row and column of non-internal dummies:
* * * * *
A A B B *
C D A A *
* * * * *
|
|
g_unplaceOnly
|
Unplaces the available dummies. Does not remove the rows or columns. Valid values are t and nil.
|
|
g_fullRCOnly
|
Deletes rows or columns that are either empty or contain dummies. Valid values are t and nil.
|
|
?verbose { t | nil }
|
|
|
Controls the display of warning messages.
|
Value Returned
|
t
|
The dummy entries were deleted.
|
|
nil
|
The command was unsuccessful.
|
Example
Removes all rows and columns that are filled with either dummies or empty cells surrounding a core of instances. The grid is then compressed.
sbox = gpeEditSandbox()
gpeDeleteDummyEntries(sbox nil nil t)
> t
Return to top
