AngelScript
 
Loading...
Searching...
No Matches
Class constructors

Class constructors are specific methods that will be used to create new instances of the class. It is not required for a class to declare constructors, but doing so may make it easier to use the class as it will not be necessary to first instantiate the class and then manually set the properties.

The constructors are declared without a return type, and must have the same name as the class itself. Multiple constructors with different parameter lists can be implemented for different forms of initializations.

  class MyClass
  {
    // Implement a default constructor
    MyClass()
    {
    }

    // Implement the copy constructor
    MyClass(const MyClass &inout other)
    {
      // Copy the value of the other instance
    }

    // Implement other constructors with different parameter lists
    MyClass(int a, string b) {}
    MyClass(float x, float y, float z) {}

    // Implement conversion constructors 
    // The second can only be used explicitly
    MyClass(int a) {}
    MyClass(string a) explicit {}
  }

The copy constructor is a specific constructor that the compiler can use to build more performatic code when copies of an object must be made. Without the copy constructor the compiler will be forced to first instantiate the copy using the default constructor, and then copy the attributes with the opAssign method.

A constructor that takes a single argument can be used in type conversions. By default the compiler can use these to perform the conversion implicitly when necessary. If that is not desired, then it is possible to prohibit this by adding the explicit decorator after the constructor.

One constructor cannot call another constructor. If you wish to share implementations in the constructors you should use a specific method for that.

How the members shall be initialized can also be defined directly in the declaration of the members. When this is done the initialization expression will automatically be compiled in the constructor without the need to write the initialization again.

See also
Initialization of class members, Type conversion operators

Auto-generated constructors

The compiler will automatically generate a default constructor and copy constructor in some cases.

The default constructor will be generated automatically if no other constructor is explicitly declared. This constructor will simply call the default constructor for all object members and set all handles to null, unless members have explicit initializations in which case those are executed. Any compilation error in the member initialization will be reported as usual.

The copy constructor will be generated automatically if no copy constructor is explicitly declared. This constructor will attempt to do a copy construct for each member, or if no copy constructor is available it will first do a default construct followed by an assignment. If any compilation error is encountered, e.g. if a member cannot be copied, then the copy constructor will not be generated and the error message surpressed.

If the auto generated constructors are not desired, then they can be explicitly excluded by flagging them as deleted.

  class MyClass
  {
        MyClass() delete;
        MyClass(const MyClass &inout) delete;
  }