VS:IsPlanarObj: Difference between revisions

Revision as of 07:10, 30 December 2020

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

FUNCTION IsPlanarObj(
           object      :HANDLE;
           VAR refID   :LONGINT) : BOOLEAN;

def vs.IsPlanarObj(object):
    return (BOOLEAN, refID)

object		HANDLE		Object to test
refID		LONGINT		If object is planar, returns the planar refID of its plane

_c_ (2020.05.17)

Renamed "NewParam" into "refID", which is the name used for this variable everywhere else.

Availability: from Vectorworks 2016

@@ Line 7: / Line 7: @@
 <def>
 <funcDef lang="vs">
-FUNCTION IsPlanarObj(object:HANDLE; VAR NewParam:LONGINT) : BOOLEAN;
+FUNCTION IsPlanarObj(object:HANDLE; VAR refID:LONGINT) : BOOLEAN;
 </funcDef>
 <funcDef lang="py">
 def vs.IsPlanarObj(object):
-     return (BOOLEAN, NewParam)
+     return (BOOLEAN, refID)
 </funcDef>
 </def>
@@ Line 24: / Line 24: @@
 </line>
 <line>
-NewParam
+refID
 LONGINT
 If object is planar, returns the planar refID of its plane
@@ Line 32: / Line 32: @@
 -----------------------------------------------------------------------------------------------------------
-<remark></remark>
+<remark>
+[[User:CBM-c-|_c_]] (2020.05.17)
+Renamed "NewParam" into "refID", which is the name used for this variable everywhere else.
+</remark>
 -----------------------------------------------------------------------------------------------------------