GTAdhocAPI
Gran Turismo (6) Adhoc API Documentation
Loading...
Searching...
No Matches
System::Module Class Reference

Built-in type that represents a module (or namespace in C++). More...

Inheritance diagram for System::Module:
System::Object Binary::__module__ IO::File IO::Path IO::__module__ Math::__module__ System::Class System::STArray System::STBool System::STByte System::STDouble System::STFloat System::STLong System::STShort System::STString System::STStructure System::STType System::STUByte System::STULong System::STUShort System::__module__ Time::__module__ __toplevel__::__module__ gtengine::__module__ menu::MNode menu::MSystemOSK menu::__module__ pdiext::__module__ pdistd::MPjson pdistd::__module__

Public Member Functions

 Module ()
 constructor taking no param More...
 
 Module (String name)
 Constructs. More...
 
Bool load (String scriptName)
 Loads all modules from the specified script. More...
 
void defineModule (Module module)
 Defines a new module within this module. More...
 
void defineModule (Object symbol, Module module)
 Defines a new module within this module. More...
 
void defineClass (Class class)
 Defines a new class within this module. More...
 
void defineClass (Object symbol, Class class)
 Defines a new class within this module. More...
 
void defineStatic (String staticName, Object staticValue)
 Defines a new static within this module. More...
 
void defineAttribute (String attributeName, Object attributeValue)
 Defines a new attribute within this module. More...
 
void import (Module module, Object symbol)
 Imports a module onto this one. More...
 
void import (Module module, Object symbol, Object alias)
 Imports a module onto this one with the specified alias. More...
 
void removeStatic (String staticName)
 Removes a specific static member from the module by name. More...
 
void clearStatic ()
 Clears all static members from the module. More...
 
void each_attribute (FunctionObject< Array > func)
 Performs a callback on each attribute in the module. More...
 
void map_attribute (FunctionObject< Array > func)
 Creates a new array populated with the results of calling a provided function on every element in the calling array. More...
 
Array find_all (FunctionObject func)
 Finds all static members that matches the precondition. More...
 
Object find_static (FunctionObject precondition)
 Finds a static member that matches the precondition. More...
 
String getModulePath ()
 Gets the module's path name. More...
 
Object getModuleAttribute (String path)
 
void setModuleAttribute (String path, Object value)
 
Object getScopeAttribute (String path)
 
void setScopeAttribute (String path, Object value)
 
- Public Member Functions inherited from System::Object
 Object ()
 constructor taking no param More...
 
Bool isInstanceOf (Class classType)
 Returns whether an object is of a specific class/type. More...
 
Object getDeepCopy ()
 Gets a deep copy of this object. More...
 
void setDeepCopy (Object obj)
 Unk. More...
 
String dump ()
 Dumps all info about an object. More...
 
Object getObjectAttribute (string path)
 
void setObjectAttribute (string path, Object value)
 
Bool hasPrimitiveInterface ()
 Returns whether this object has a primitive interface. More...
 
Bool toBool ()
 Casts this object to Bool. More...
 
Byte toByte ()
 Casts this object to Byte. More...
 
Short toShort ()
 Casts this object to Short. More...
 
Int toInt ()
 Casts this object to Int. More...
 
Long toLong ()
 Casts this object to Long. More...
 
UByte toUByte ()
 Casts this object to UByte. More...
 
UShort toUShort ()
 Casts this object to UShort. More...
 
UInt toUInt ()
 Casts this object to UInt. More...
 
ULong toULong ()
 Casts this object to ULong. More...
 
Float toFloat ()
 Casts this object to Float. More...
 
Double toDouble ()
 Casts this object to Double. More...
 
String toString ()
 Casts this object to String. More...
 
Symbol toSymbol ()
 Casts this object to Symbol. More...
 
Bool hasArrayInterface ()
 Returns whether this object has an Array interface. More...
 
Int getArrayCount ()
 Gets the Array item count for this object. More...
 
void setArrayCount ()
 Sets the Array item count for this object. More...
 
Object getArrayElement (Object arg0)
 Gets an Array item for this object. More...
 
void setArrayElement (Object arg0, Object arg1)
 Sets the Array item for this object. More...
 
Bool hasMapInterface ()
 Returns whether this object has a Map interface. More...
 
int getMapCount ()
 Returns the count of items in the map. More...
 
void setMapElement (Object arg0, Object arg1)
 Returns whether the Map has a specific object key. Bool hasMapElement(Object arg0);. More...
 
Object getMapElement (Object arg0)
 Gets a Map element by key. More...
 
void hasGeneratorInterface ()
 Returns whether this object has a generator interface. More...
 
Iterator generator ()
 Returns generator (?) More...
 
void hasIteratorInterface ()
 Returns whether this object has an iterator. More...
 
Iterator iterator ()
 Gets the iterator for this object. More...
 
void hasVariableInterface ()
 Returns whether this object is a variable. More...
 
void hasFunctionInterface ()
 Returns whether this object has a function interface. More...
 
Object call ()
 Calls this object as a function. More...
 
Bool hasByteDataInterface ()
 Returns whether this object has a byte data interface. More...
 
Int getByteDataCount ()
 Returns the ByteData size for this object. More...
 
void setByteDataCount (Int count)
 Sets the ByteData size for this object. More...
 
Int getByteDataCapacity ()
 Returns the ByteData capacity for this object. More...
 
void setByteDataCapacity (Int capacity)
 Sets the ByteData capacity for this object. More...
 
ByteData getByteData ()
 Gets the underlaying ByteData. More...
 
void setByteData (ByteData bytedata)
 Sets the underlaying ByteData. More...
 
void hasObjectSelectorInterface ()
 Returns whether this object has an object selector interface. More...
 
void self ()
 Gets the get for this object if it has a get interface. More...
 
void getArchiveTree ()
 
void setArchiveTree ()
 
ByteData serialize ()
 Serializes this object. More...
 
void deserialize (ByteData serializedData)
 Deserializes this object. More...
 
void defined (Object obj)
 Returns whether a certain object is defined within this object. More...
 
Array find_all (FunctionObject func)
 Finds all the elements in this object that matches the predicates. More...
 
void each_all (FunctionObject func)
 Applies callback to all elements in this object. More...
 
Array map_all (FunctionObject< Object > func)
 Maps all the elements in this object. More...
 
Bool operator!= ()
 Returns whether this object is not equal to another. More...
 
Bool operator== ()
 Returns whether this object is equal to another. More...
 

Public Attributes

String name
 Returns the module name. More...
 
- Public Attributes inherited from System::Object
Int rc_size
 Getter-only. Reference counter size of this object. More...
 
Object rc_class
 Getter-only. Type name of the object. More...
 
Int rc_count
 Getter-only. Reference count of this object. More...
 
Int weak_count
 Getter-only. Weak reference count of this object. More...
 
Class class_id
 Class (type) object for this object. More...
 

Detailed Description

Built-in type that represents a module (or namespace in C++).

Definition at line 4 of file Module.cpp.

Constructor & Destructor Documentation

◆ Module() [1/2]

System::Module::Module ( )
inline

constructor taking no param

Definition at line 9 of file Module.cpp.

◆ Module() [2/2]

System::Module::Module ( String  name)
inline

Constructs.

a new module with the specified name.

Definition at line 14 of file Module.cpp.

Member Function Documentation

◆ clearStatic()

void System::Module::clearStatic ( )

Clears all static members from the module.

◆ defineAttribute()

void System::Module::defineAttribute ( String  attributeName,
Object  attributeValue 
)

Defines a new attribute within this module.

◆ defineClass() [1/2]

void System::Module::defineClass ( Class  class)

Defines a new class within this module.

◆ defineClass() [2/2]

void System::Module::defineClass ( Object  symbol,
Class  class 
)

Defines a new class within this module.

◆ defineModule() [1/2]

void System::Module::defineModule ( Module  module)

Defines a new module within this module.

◆ defineModule() [2/2]

void System::Module::defineModule ( Object  symbol,
Module  module 
)

Defines a new module within this module.

◆ defineStatic()

void System::Module::defineStatic ( String  staticName,
Object  staticValue 
)

Defines a new static within this module.

◆ each_attribute()

void System::Module::each_attribute ( FunctionObject< Array func)

Performs a callback on each attribute in the module.

Parameters
funcCallback. Array is [Symbol, ModuleVariable]

◆ find_all()

Array System::Module::find_all ( FunctionObject  func)

Finds all static members that matches the precondition.

◆ find_static()

Object System::Module::find_static ( FunctionObject  precondition)

Finds a static member that matches the precondition.

◆ getModuleAttribute()

Object System::Module::getModuleAttribute ( String  path)

◆ getModulePath()

String System::Module::getModulePath ( )

Gets the module's path name.

◆ getScopeAttribute()

Object System::Module::getScopeAttribute ( String  path)

◆ import() [1/2]

void System::Module::import ( Module  module,
Object  symbol 
)

Imports a module onto this one.

var mod = Module("myModule");
mod.import(main, "*");
var dir = mod["PROJECT_ROOT_DIR"];
return dir;
Module()
constructor taking no param
Definition: Module.cpp:9

◆ import() [2/2]

void System::Module::import ( Module  module,
Object  symbol,
Object  alias 
)

Imports a module onto this one with the specified alias.

◆ load()

Bool System::Module::load ( String  scriptName)

Loads all modules from the specified script.

Returns
Returns whether the script was successfully loaded.
Parameters
scriptNamePath to script (without extension or with .adc extension, nothing else)

Example

var mod = Module("MyModule");
// Load scripts/gt6/util/GameParameterUtilImpl.adc
var res = mod.load("scripts/gt6/util/GameParameterUtilImpl");
if (res)
{
// Module loaded
}

◆ map_attribute()

void System::Module::map_attribute ( FunctionObject< Array func)

Creates a new array populated with the results of calling a provided function on every element in the calling array.

Parameters
funcCallback. Array is [Symbol, ModuleVariable]

◆ removeStatic()

void System::Module::removeStatic ( String  staticName)

Removes a specific static member from the module by name.

◆ setModuleAttribute()

void System::Module::setModuleAttribute ( String  path,
Object  value 
)

◆ setScopeAttribute()

void System::Module::setScopeAttribute ( String  path,
Object  value 
)

Member Data Documentation

◆ name

String System::Module::name

Returns the module name.

Definition at line 17 of file Module.cpp.


The documentation for this class was generated from the following file: