Classes - Revision history

UberFoX: /* Magic Functions */

2015-09-21T18:39:49Z

Magic Functions

← Older revision		Revision as of 18:39, 21 September 2015
Line 318:		Line 318:
	printr(vardump($a)); # NULL		printr(vardump($a)); # NULL
	</syntaxhighlight>		</syntaxhighlight>
		+
		+	==== Magic Functions/Properties (others) ====
		+
		+	These magic functions and properties are used by other core functions that are nothing to do with classes directly (usually)but will work classes in a special way if you extend or do something that it requires.
		+
		+	* [[Core Function Count\|Count( )]] -- This lets you override what number count() will return when it is used against the class
		+	* [[Core Function JsonEncode\|JsonEncode( )]] -- This one lets you control what gets serialized and how

	==== Operator Overloads ====		==== Operator Overloads ====

UberFoX: /* Multiple Inheritance Classes */

2015-09-21T18:05:21Z

Multiple Inheritance Classes

← Older revision		Revision as of 18:05, 21 September 2015
Line 361:		Line 361:

	Sputnik supports multiple inheritance in a rather unique and powerful way.		Sputnik supports multiple inheritance in a rather unique and powerful way.
		+
		+	<syntaxhighlight lang="sputnik">
		+	// Define a class we will inherit
		+	Class EngineInfo
		+	{
		+	// define an abstract function
		+	abstract Function Engine() { }
		+	// define two abstract properties
		+	Abstract my $GearVer { }
		+	Abstract my $GearBox { }
		+	// define a normal Function
		+	// the final class will inherit this
		+	// and since it is not an abstract it will
		+	// appear as if it was literally inside the
		+	// original
		+	Function EngineTest()
		+	{
		+	say "Testing engine...";
		+	}
		+	}
		+
		+	// Define another class we will inherit
		+	Class CarColour
		+	{
		+	// define an abstract property
		+	Abstract my $Colour { }
		+	// define a normal Function
		+	// the final class will inherit this
		+	// and since it is not an abstract it will
		+	// appear as if it was literally inside the
		+	// original
		+	Function ColourTest()
		+	{
		+	say "Testing colours...";
		+	}
		+	}
		+
		+	// Define the final class
		+	// We will multiple inherit both
		+	// EngineInfo AND CarColour
		+	Class Car extends EngineInfo, CarColour
		+	{
		+	// override the abstract function Engine()
		+	override Function Engine()
		+	{
		+	return "V8";
		+	}
		+	// streamlined properties
		+	override my $GearVer { get { return "1.0"; } }
		+	override my $Colour { get { return "Red"; } }
		+	// expanded property
		+	override my $GearBox
		+	{
		+	get
		+	{
		+	return "12Gears";
		+	}
		+	}
		+	}
		+
		+	my $c = new Car();
		+	say "Colour: " . $c->$Colour;
		+	say "Engine: " . $c->Engine();
		+	say "GearVer: " . $c->$GearVer;
		+	say "GearBox: " . $c->$GearBox;
		+	$c->EngineTest();
		+	$c->ColourTest();
		+	// PRINTS
		+	// Colour: Red
		+	// Engine: V8
		+	// GearVer: 1.0
		+	// GearBox: 12Gears
		+	// Testing engine...
		+	// Testing colours...
		+	</syntaxhighlight>

	=== Cast Overloading ===		=== Cast Overloading ===

UberFoX: /* Abstract/Override Functions */

2015-09-21T18:01:25Z

Abstract/Override Functions

← Older revision		Revision as of 18:01, 21 September 2015
Line 203:		Line 203:

	==== Abstract/Override Functions ====		==== Abstract/Override Functions ====
		+
		+	Works exactly same as functions above but this time it will be marked as abstract so any class inheriting our class must implement a function by the same name as this one.
		+
		+	To implement it you must use the override keyword as shown in the example below.
		+
		+	<syntaxhighlight lang="sputnik">
		+	// Define a class we will inherit
		+	Class EngineInfo
		+	{
		+	// define an abstract function
		+	abstract Function Engine() { }
		+	// define two abstract properties
		+	Abstract my $GearVer { }
		+	Abstract my $GearBox { }
		+	}
		+
		+	// Define the final class
		+	Class Car extends EngineInfo
		+	{
		+	// override the abstract function Engine()
		+	override Function Engine()
		+	{
		+	return "V8";
		+	}
		+	// streamlined property
		+	override my $GearVer { get { return "1.0"; } }
		+	// expanded property
		+	override my $GearBox
		+	{
		+	get
		+	{
		+	return "12Gears";
		+	}
		+	}
		+	}
		+
		+	my $c = new Car();
		+	say "Engine: " . $c->Engine();
		+	say "GearVer: " . $c->$GearVer;
		+	say "GearBox: " . $c->$GearBox;
		+	// PRINTS
		+	// Engine: V8
		+	// GearVer: 1.0
		+	// GearBox: 12Gears
		+	</syntaxhighlight>
		+
		+	Of note :
		+	* Since this is an abstract class you do not define any statements in the { } block of the abstract function or else you will get an error.

	==== Static Functions ====		==== Static Functions ====

UberFoX: /* Abstract Properties */

2015-09-21T17:55:26Z

Abstract Properties

← Older revision		Revision as of 17:55, 21 September 2015
Line 119:		Line 119:
	* If you somehow create a normal variable with the same name as the property it will override the property.		* If you somehow create a normal variable with the same name as the property it will override the property.

−	==== Abstract Properties ====	+	==== Abstract/Override Properties ====

	Works exactly same as property above but this time it will be marked as abstract so any class inheriting our class must implement a property by the same name as this one.		Works exactly same as property above but this time it will be marked as abstract so any class inheriting our class must implement a property by the same name as this one.
		+
		+	To implement it you must use the override keyword as shown in the example below.

	<syntaxhighlight lang="sputnik">		<syntaxhighlight lang="sputnik">
Line 131:		Line 133:
	Class foo extends cat		Class foo extends cat
	{		{
		+	my $_id;
	override my $ID		override my $ID
	{		{
	get		get
	{		{
−	return ++$ID;	+	return ++$_id;
	}		}
	}		}
Line 151:		Line 154:
	# UniqueID: 3		# UniqueID: 3
	# UniqueID: 4		# UniqueID: 4
−	~~# UniqueID: 5~~
	</syntaxhighlight>		</syntaxhighlight>

	Of note :		Of note :
−	* Since this is an abstract class you do not ~~need to~~ define a GET or SET accessor.	+	* Since this is an abstract class you do not define a GET or SET accessor or else you will get an error.

	==== Functions ====		==== Functions ====

UberFoX: /* Static Functions */

2015-09-21T17:37:55Z

Static Functions

← Older revision		Revision as of 17:37, 21 September 2015
Line 199:		Line 199:
	# then throws an exception		# then throws an exception
	</syntaxhighlight>		</syntaxhighlight>
		+
		+	==== Abstract/Override Functions ====

	==== Static Functions ====		==== Static Functions ====

UberFoX: /* Multiple Inheritance Classes */

2015-09-21T17:37:26Z

Multiple Inheritance Classes

← Older revision		Revision as of 17:37, 21 September 2015
Line 307:		Line 307:

	=== Multiple Inheritance Classes ===		=== Multiple Inheritance Classes ===
		+
		+	Sputnik supports multiple inheritance in a rather unique and powerful way.

	=== Cast Overloading ===		=== Cast Overloading ===

UberFoX: /* Abstract Properties */

2015-09-21T17:36:25Z

Abstract Properties

← Older revision		Revision as of 17:36, 21 September 2015
Line 131:		Line 131:
	Class foo extends cat		Class foo extends cat
	{		{
−	my $ID	+	override my $ID
	{		{
	get		get

UberFoX: /* Remarks */

2015-09-20T10:06:54Z

Remarks

← Older revision		Revision as of 10:06, 20 September 2015
Line 270:		Line 270:

	==== Cast Overloads ====		==== Cast Overloads ====
		+
		+	=== Embedding ===
		+
		+	A class can be embedded inside an IF statement (or any statement) so that it can be created on a conditional for example:
		+
		+	<syntaxhighlight lang="sputnik">
		+	// Check if the class already exists and
		+	// if it does already exists don't create it
		+	if (!ClassExists("Cat"))
		+	{
		+	// Create the class using the Embedded keyword
		+	Embedded Class Cat
		+	{
		+	Function __construct()
		+	{
		+	say "testy!";
		+	}
		+	}; // note ; is required here
		+	}
		+	$a = new cat();
		+	// PRINTS
		+	// testy!
		+	</syntaxhighlight>

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

UberFoX at 10:04, 20 September 2015

2015-09-20T10:04:10Z

← Older revision		Revision as of 10:04, 20 September 2015
Line 16:		Line 16:
	casting overloads		casting overloads
	...		...
−	};	+	}
	</pre>		</pre>

Line 32:		Line 32:
	casting overloads		casting overloads
	...		...
−	};	+	}
	</pre>		</pre>

Line 48:		Line 48:
	casting overloads		casting overloads
	...		...
−	};	+	}
	</pre>		</pre>

Line 64:		Line 64:
	casting overloads		casting overloads
	...		...
−	};	+	}
	</pre>		</pre>

Line 98:		Line 98:
	}		}
	}		}
−	};	+	}

	$a = new cat();		$a = new cat();
Line 127:		Line 127:
	{		{
	Abstract my $ID { }		Abstract my $ID { }
−	};	+	}

	Class foo extends cat		Class foo extends cat
Line 138:		Line 138:
	}		}
	}		}
−	};	+	}

	$a = new foo();		$a = new foo();
Line 186:		Line 186:
	say "Foo: $value";		say "Foo: $value";
	}		}
−	};	+	}

	$a = new Test();		$a = new Test();
Line 251:		Line 251:
	printr $data;		printr $data;
	}		}
−	};	+	}

	$a = new Test();		$a = new Test();
Line 335:		Line 335:
	return "Account '$Name' Credits '$Credits'";		return "Account '$Name' Credits '$Credits'";
	}		}
−	};	+	}
	$nacc = New Account("FoX", 777);		$nacc = New Account("FoX", 777);
	println( (string)$nacc ); // Prints Account 'FoX' Credits '777'		println( (string)$nacc ); // Prints Account 'FoX' Credits '777'
Line 458:		Line 458:
	$this->$z++;		$this->$z++;
	}		}
−	};	+	}
	$cat1 = new Vec3(10, 20, 30);		$cat1 = new Vec3(10, 20, 30);
	println("BEFORE ++");		println("BEFORE ++");
Line 500:		Line 500:
	$this->$z--;		$this->$z--;
	}		}
−	};	+	}
	$cat1 = new Vec3(10, 20, 30);		$cat1 = new Vec3(10, 20, 30);
	println("BEFORE --");		println("BEFORE --");
Line 611:		Line 611:
	}		}

−	};	+	}
−		+

	my $Testy = new Testy();		my $Testy = new Testy();
Line 666:		Line 665:
	return &$this->$Values[]!;		return &$this->$Values[]!;
	}		}
−	};	+	}
−		+
−		+
	my $Testy = new Testy();		my $Testy = new Testy();
	// Now we use use the new index that was returned and place stuff in it		// Now we use use the new index that was returned and place stuff in it
Line 722:		Line 719:
	}		}

−	};	+	}
−		+
−		+
	my $Testy = new Testy();		my $Testy = new Testy();
	*$Testy[] = "One";		*$Testy[] = "One";
Line 744:		Line 739:
	}		}

−	};	+	}
	my $Testy = new Testy();		my $Testy = new Testy();
	printr $Testy[<=>];		printr $Testy[<=>];

UberFoX at 19:17, 18 September 2015

2015-09-18T19:17:11Z

← Older revision		Revision as of 19:17, 18 September 2015
Line 318:		Line 318:

	==== Overloading Cast: double ====		==== Overloading Cast: double ====
−
−	~~==== Overloading Cast: charptr ====~~

	==== Overloading Cast: string ====		==== Overloading Cast: string ====
Line 343:		Line 341:

	==== Overloading Cast: binary ====		==== Overloading Cast: binary ====
−
−	~~==== Overloading Cast: charptr ====~~

	=== Operator Overloading ===		=== Operator Overloading ===