ResetPhysical

Category: Objects / Status
Since engine version: 4.6.5.0 CP (extended in 4.9.6.0 CR)

Description

Resets all physicals to their default value. For more information see SetPhysical.

Syntax

bool ResetPhysical (object pObj, string sPhys);

Parameters

pObj:
[opt] Object of which you want to reset physicals. Can be 0 in local calls.
sPhys:
[opt] If nonzero, this string should specify the name of a physical attribute of which a previous value has been stored using SetPhysical in PHYS_StackTemporary-mode. The specified physical is reset to its previous value and the previous value is removed from the temporary physical stack. If the stack is empty - i.e., ResetPhysical has been called for all respective calls to SetPhysical in PHYS_StackTemporary-mode, the temporary physicals will automatically be reset. If this parameter is zero, all temporary physicals are reset and any temporary physical values deleted form the stack. See SetPhysical for an example using this parameter. Since CR.
See also: SetPhysical
jwk, August 2002