Core Function isVarClass - Revision history

UberFoX at 11:33, 22 June 2015

2015-06-22T11:33:21Z

← Older revision		Revision as of 11:33, 22 June 2015
Line 1:		Line 1:
	<pre>		<pre>
−	isVarClass( $variable, <type> )	+	isVarClass( $variable, <type>, <strict> )
	</pre>		</pre>

Line 12:		Line 12:

	The variable to check.		The variable to check.
		+
		+	==== type ====
		+
		+	Optional; A class name to check for
		+
		+	Default: this is ignored entirely and as long as the variable contains a class of any type it will return true.
		+
		+	==== strict ====
		+
		+	Optional; If true the the class type will be required as absolute and will not allow for inherited classes by that name.
		+
		+	Default: false

	=== Return Value ===		=== Return Value ===

UberFoX: 1 revision

2015-06-14T12:38:14Z

1 revision

← Older revision

Revision as of 12:38, 14 June 2015

UberFoX: 1 revision

2014-08-11T21:40:32Z

1 revision

← Older revision

Revision as of 21:40, 11 August 2014

UberFoX: /* Return Value */

2013-08-29T10:41:54Z

Return Value

← Older revision		Revision as of 10:41, 29 August 2013
Line 15:		Line 15:
	=== Return Value ===		=== Return Value ===

−	Success: Returns 1.	+	Success: Returns true.

−	Failure: Returns ~~0 if parameter is not an array variable~~.	+	Failure: Returns false.

	=== Remarks ===		=== Remarks ===

UberFoX: /* Example */

2013-08-21T14:26:07Z

Example

← Older revision		Revision as of 14:26, 21 August 2013
Line 63:		Line 63:
	println( isVarClass($cat1, "vec3") ? "TRUE" : "FALSE" );		println( isVarClass($cat1, "vec3") ? "TRUE" : "FALSE" );
	println( isVarClass($moo, "vec3") ? "TRUE" : "FALSE" );		println( isVarClass($moo, "vec3") ? "TRUE" : "FALSE" );
		+	</syntaxhighlight>
		+
		+	Alternative way to see if a variable contains a class object by name
		+
		+	<syntaxhighlight lang="sputnik">
		+	Class Vec3
		+	{
		+	my $x = 0;
		+	my $y = 0;
		+	my $z = 0;
		+	Function Vec3($x1 = 0, $y1 = 0, $z1 = 0)
		+	{
		+	$this->$x = (double)$x1;
		+	$this->$y = (double)$y1;
		+	$this->$z = (double)$z1;
		+	}
		+	};
		+	$cat1 = new Vec3(10, 20, 30);
		+	println( $cat1 ~~ Vec3 ? "TRUE" : "FALSE" );
		+	println( $moo ~~ Vec3 ? "TRUE" : "FALSE" );
		+	</syntaxhighlight>
		+
		+	Yet another alternative way to see if a variable contains a class object by name
		+
		+	<syntaxhighlight lang="sputnik">
		+	Class Vec3
		+	{
		+	my $x = 0;
		+	my $y = 0;
		+	my $z = 0;
		+	Function Vec3($x1 = 0, $y1 = 0, $z1 = 0)
		+	{
		+	$this->$x = (double)$x1;
		+	$this->$y = (double)$y1;
		+	$this->$z = (double)$z1;
		+	}
		+	};
		+	$cat1 = new Vec3(10, 20, 30);
		+	println( $cat1 is Vec3 ? "TRUE" : "FALSE" );
		+	println( $moo is Vec3 ? "TRUE" : "FALSE" );
	</syntaxhighlight>		</syntaxhighlight>

	[[Category:Core Function]]		[[Category:Core Function]]

Alexpja at 20:23, 4 December 2011

2011-12-04T20:23:20Z

← Older revision		Revision as of 20:23, 4 December 2011
Line 45:		Line 45:
	</syntaxhighlight>		</syntaxhighlight>

−	Same example but this time making sure the class is a vec3 and nothing else :	+	Same example but this time making sure the class is a vec3 and nothing else:

	<syntaxhighlight lang="sputnik">		<syntaxhighlight lang="sputnik">

UberFoX: Created page with "

 isVarClass( $variable,  )

=== Description === Check if a variable's object type is a class. === Parameters === ==== variable ==== The variable to check. ..."

2011-11-20T01:54:34Z

Created page with "<pre> isVarClass( $variable, <type> ) </pre> === Description === Check if a variable's object type is a class. === Parameters === ==== variable ==== The variable to check. ..."

New page

<pre>
isVarClass( $variable, <type> )
</pre>

=== Description ===

Check if a variable's object type is a class.

=== Parameters ===

==== variable ====

The variable to check.

=== Return Value ===

Success: Returns 1.

Failure: Returns 0 if parameter is not an array variable.

=== Remarks ===

Can be useful to validate array/non-array parameters to user-defined functions.

=== Example ===

A simple example to see if a variable is a class variable :

<syntaxhighlight lang="sputnik">
Class Vec3
{
my $x = 0;
my $y = 0;
my $z = 0;
Function Vec3($x1 = 0, $y1 = 0, $z1 = 0)
{
$this->$x = (double)$x1;
$this->$y = (double)$y1;
$this->$z = (double)$z1;
}
};
$cat1 = new Vec3(10, 20, 30);
println( isVarClass($cat1) ? "TRUE" : "FALSE" );
println( isVarClass($moo) ? "TRUE" : "FALSE" );
</syntaxhighlight>

Same example but this time making sure the class is a vec3 and nothing else :

<syntaxhighlight lang="sputnik">
Class Vec3
{
my $x = 0;
my $y = 0;
my $z = 0;
Function Vec3($x1 = 0, $y1 = 0, $z1 = 0)
{
$this->$x = (double)$x1;
$this->$y = (double)$y1;
$this->$z = (double)$z1;
}
};
$cat1 = new Vec3(10, 20, 30);
println( isVarClass($cat1, "vec3") ? "TRUE" : "FALSE" );
println( isVarClass($moo, "vec3") ? "TRUE" : "FALSE" );
</syntaxhighlight>

[[Category:Core Function]]