VS:StairGetNumRisers: Difference between revisions

From Vectorworks Developer
Jump to navigation Jump to search
m (1 revision)
No edit summary
 
(One intermediate revision by one other user not shown)
Line 6: Line 6:
-----------------------------------------------------------------------------------------------------------
-----------------------------------------------------------------------------------------------------------
<desc>
<desc>
Returns numbers of risers of stair flights</desc>
Returns numbers of risers of stair flights 1-4. Returns -1 in case of error and for flights that don't exist.</desc>


-----------------------------------------------------------------------------------------------------------
-----------------------------------------------------------------------------------------------------------
Line 68: Line 68:


[[Category:VS Function Reference|StairGetNumRisers]]
[[Category:VS Function Reference|StairGetNumRisers]]
[[Category:VS Function Reference:StairCWVectorscripts|StairGetNumRisers]]
[[Category:VS Function Reference:Objects - Architectural|StairGetNumRisers]]

Latest revision as of 12:11, 8 December 2020

.VectorScript|VectorScript ..VS:Function Reference|Function Reference ..VS:Function_Reference_Appendix|Appendix

Description

Returns numbers of risers of stair flights 1-4. Returns -1 in case of error and for flights that don't exist.

FUNCTION StairGetNumRisers(
stair :HANDLE;
VAR NumRisers1 :INTEGER;
VAR NumRisers2 :INTEGER;
VAR NumRisers3 :INTEGER;
VAR NumRisers4 :INTEGER) : BOOLEAN;
def vs.StairGetNumRisers(stair):
    return (BOOLEAN, NumRisers1, NumRisers2, NumRisers3, NumRisers4)

Parameters

stair HANDLE
NumRisers1 INTEGER
NumRisers2 INTEGER
NumRisers3 INTEGER
NumRisers4 INTEGER

Version

Availability: from Vectorworks 2021