gpeSetAbut

gpeSetAbut(
u_sandbox
g_abut
[ ?verbose { t | nil } ]
)
=> t / nil

Description

Sets the abutment for the entire grid, without using individual abutment entries. The entire abutment object of the sandbox-in-place is replaced.

Arguments

u_sandbox	Specifies the Modgen sandbox object.
g_abut	Specifies the abutment status. Valid values are: A Modgen sandbox abutment DPL. t to abut all instances. nil to unabut all instances.
?verbose { t | nil }
	Controls the display of warning messages.

Value Returned

t	Indicates that the abutment settings were set as specified.
nil	The command was unsuccessful.

Example

In the following example, the value for sbox is assigned to the value returned by gpeEditSandbox; the value of abut is assigned to value returned by gpeGetAbut. These values are then passed as arguments to gpeSetAbut:

sbox = gpeEditSandbox()

abut = gpeGetAbut(sbox)

gpeSetAbut(sbox abut)

prevAbut = gpeGetAbut(sbox)

In the following example, g_abut is set to t, and so all instances are abutted:

gpeSetAbut(sbox t)

In the following example, g_abut is set to nil, and so all instances are unabutted:

gpeSetAbut(sbox nil)

The following example uses prevAbut, a Modgen sandbox DPL, which contains the current abutment information from the sandbox:

gpeSetAbut(sbox prevAbut)

Return to top