View source for VS:vsoStateGet

{{LocationMain|category=LocationVS|specific=}}
__TOC__
<vwDoc>

-----------------------------------------------------------------------------------------------------------
<desc>
Checks if the passed parametric object have received specific 'state' event before this reset event. [[VS:Parametric State Notifications#vsoStateGet]]

This function should be called during the parametric reset event: <code>3: {kParametricRecalculate}</code>
</desc>

-----------------------------------------------------------------------------------------------------------
<def>
<funcDef lang="vs">
FUNCTION vsoStateGet(hObj: HANDLE; state: INTEGER) : BOOLEAN;
</funcDef>
<funcDef lang="py">
def vs.vsoStateGet(hObj, state):
    return BOOLEAN
</funcDef>
</def>

-----------------------------------------------------------------------------------------------------------
<params>
<lineList ident=1>
<line>
hObj
HANDLE
Handle to the parametric object. Obtained by call to [[VS:GetCustomObjectInfo]]
</line>
<line>
state
INTEGER
State Identifier which you want to check.
</line>
</lineList>
</params>


-----------------------------------------------------------------------------------------------------------
<return>
Returns TRUE if the passed 'state' has been received. FALSE otherwise.
</return>

-----------------------------------------------------------------------------------------------------------
<remark>
State constants are:
:[[VS:Parametric State Notifications#kCreatedReset|kCreatedReset]] = 0;
:[[VS:Parametric State Notifications#kMovedReset|kMovedReset]] = 1;
:[[VS:Parametric State Notifications#kRotatedReset|kRotatedReset]] = 2;
:[[VS:Parametric State Notifications#kParameterChangedReset|kParameterChangedReset]] = 3;
:[[VS:Parametric State Notifications#kObjectChangedReset|kObjectChangedReset]] = 4;
:[[VS:Parametric State Notifications#kLayerChangedReset|kLayerChangedReset]] = 5;
:[[VS:Parametric State Notifications#kExitFromEditGroup|kExitFromEditGroup]] = 6;
:[[VS:Parametric State Notifications#kObjectNameChanged|kObjectNameChanged]] = 7;

</remark>

-----------------------------------------------------------------------------------------------------------
<sample>
==== VectorScript ====
<code lang="pas">
BEGIN
  result := GetCustomObjectInfo(objectName, objectHand, recordHand, wallHand);
  vsoGetEventInfo(theEvent, message );

  CASE theEvent OF
    5: {kObjOnInitXProperties}
    BEGIN
      {enable eventing for this plug-in}
      SetPrefInt( 590, 1 ); {varParametricEnableStateEventing, kParametricStateEvent_ResetStatesEvent}
      result := SetObjPropVS(18, TRUE); {kObjXPropAcceptStates}
    END;	

    44: {kObjOnAddState}
    BEGIN
      message := vsoStateAddCurrent( objectHand, message );
    END;

    3: {kParametricRecalculate}
    BEGIN
      MoveTo( 5mm, 8mm );
      CreateText( 'State events received after the last kParametricRecalculate:' );

      IF vsoStateGet( objectHand, 0 {ObjectState::kCreatedReset} ) THEN BEGIN
        MoveTo( 0, 0 );
        CreateText( 'Object just created!' );
      END;
    END;

</code>
==== Python ====
<code lang="py">

</code>
</sample>

-----------------------------------------------------------------------------------------------------------
<version>
Availability: from Vectorworks 2009
This is drop-in function.
</version>

-----------------------------------------------------------------------------------------------------------
<seeAlso>
[[VS:Parametric State Notifications]] | [[VS:vsoStateAddCurrent]]

[[VS:vsoStateGetPos]] | [[VS:vsoStateGetRot]] | [[VS:vsoStateGetParamChng]] | [[VS:vsoStateGetObjChng]] | [[VS:vsoStateGetLayrChng]] | [[VS:vsoStateGetExitGroup]] | [[VS:vsoStateGetNameChng]]


</seeAlso>

</vwDoc>

[[Category:VS Function Reference|vsoStateGet]]
[[Category:VS Function Reference:Object Events|vsoStateGet]]