From RGWiki
Contents
- 1 TSTK Reference: TGB - Quick Config
- 1.1 core objectConfiguration.cs
- 1.2 core prolog_epilog.cs
- 1.3 core typeCreation.cs
- 1.4 core utilities.cs
- 1.5 settings collidesWith.cs
- 1.6 settings collisionResponse.cs
- 1.7 settings damagePoints.cs
- 1.7.1 RGQC::setDamagePoints( %this, %srcType, %max, %disabledAt, %destroyedAt, %amountPerSecond )
- 1.7.2 RGQC::getDamagePoints_Max( %this, %srcType )
- 1.7.3 RGQC::getDamagePoints_DisabledAt( %this, %srcType )
- 1.7.4 RGQC::getDamagePoints_DestroyedAt( %this, %srcType )
- 1.7.5 RGQC::config_damagePoints( %this, %obj, %typeName )
- 1.7.6 RGQC::setAutoRepair( %this, %srcType, %amountPerSecond )
- 1.7.7 RGQC::getAutoRepair( %this, %srcType )
- 1.8 settings doesDamage_onCollision.cs
- 1.9 settings doesDrain_onCollision.cs
- 1.10 settings energyPoints.cs
- 1.10.1 RGQC::setEnergyPoints( %this, %srcType, %max, %disabledAt, %destroyedAt, %amountPerSecond )
- 1.10.2 RGQC::getEnergyPoints_Max( %this, %srcType )
- 1.10.3 RGQC::getEnergyPoints_DisabledAt( %this, %srcType )
- 1.10.4 RGQC::getEnergyPoints_DestroyedAt( %this, %srcType )
- 1.10.5 RGQC::config_energyPoints( %this, %obj, %typeName )
- 1.10.6 RGQC::setAutoRecharge( %this, %srcType, %amountPerSecond )
- 1.10.7 RGQC::getAutoRecharge( %this, %srcType )
- 1.11 settings immovable.cs
- 1.12 settings layer.cs
- 1.13 settings triggeredBy.cs
|
TSTK Reference: TGB - Quick Config
core objectConfiguration.cs
The following section documents all of the functions found in the file: TSTK/TGB/quickConfig/core/objectConfiguration.cs.
RGQC::applyQC( %this, %obj, %typeName )
| Description: Apply the QC configuration attributes to the specified object as defined for the type %typeName.
|
Top
core prolog_epilog.cs
The following section documents all of the functions found in the file: TSTK/TGB/quickConfig/core/prolog_epilog.cs.
RGQC::Prolog()
| Description: This routine must be run before using the RGQC system.
|
Top
RGQC::Epilog()
| Description: This routine should be run when you are completely done with the RGQC system. It does cleanup.
|
Top
RGQC::onAdd( %this )
| Description: Internal only. Congfigures RGQC system when the RGQC object is first created.
|
Top
core typeCreation.cs
The following section documents all of the functions found in the file: TSTK/TGB/quickConfig/core/typeCreation.cs.
RGQC::createType( %this, %typeName, %group )
| Description: Use this metod to create a new 'named' Quick Config type. You may optionally specify a specific graph group to associate with the type, but if one is not supplied, this method will choose one automatically.
|
Top
core utilities.cs
The following section documents all of the functions found in the file: TSTK/TGB/quickConfig/core/utilities.cs.
RGQC::getGraphGroup( %this, %typeName )
| Description: Return the graph group for specified type: %typeName.
|
Top
RGQC::getKnownTypes( %this )
| Description: Return the space-seperated list of known types.
|
Top
RGQC::getQCAttribute( %this, %typeName, %attr )
| Description: Return the generic QC attribute %attr for specified type: %typeName.
|
Top
RGQC::getQCAttributeAmount( %this, %srcType, %dstType, %attr )
| Description: Return the generic QC attribute %attr amount relationship for specified types: %srcType and %dstType.
|
Top
settings collidesWith.cs
The following section documents all of the functions found in the file: TSTK/TGB/quickConfig/settings/collidesWith.cs.
RGQC::collidesWith( %this, %srcType, %dstType )
| Description: Use this method to enable Collision between %srcType and or more %dstType types.
|
| Note: %dstType accepts a comma separated list of type names.
|
Top
RGQC::getCollisionBits( %this, %srcType )
| Description: Get a space separated list of numbers representing the bits that are to be set for the specified object type's (%srcType) collision settings.
|
Top
RGQC::getCollisionMask( %this, %srcType )
| Description: Get a bitmask representing the bits that are to be set for the specified object type's (%srcType) collision settings.
|
Top
RGQC::config_collidesWith( %this, %obj, %typeName )
| Description: Apply the collidesWith settings to a specified object using the specified type's settings.
|
| Called by 'RGQC::applyQC()'
|
Top
settings collisionResponse.cs
The following section documents all of the functions found in the file: TSTK/TGB/quickConfig/settings/collisionResponse.cs.
RGQC::onCollision_KILL( %this, %srcType )
| Description: Use this method to set the KILL onCollision response for one or more types.
|
| Note: %srcType accepts a comma separated list of type names.
|
Top
RGQC::onCollision_BOUNCE( %this, %srcType )
| Description: Use this method to set the BOUNCE onCollision response for one or more types.
|
| Note: %srcType accepts a comma separated list of type names.
|
Top
RGQC::config_collisionResponse( %this, %obj, %typeName )
| Description: Apply the collisionResponse settings to a specified object using the specified type's settings.
|
| Called by 'RGQC::applyQC()'
|
Top
settings damagePoints.cs
The following section documents all of the functions found in the file: TSTK/TGB/quickConfig/settings/damagePoints.cs.
RGQC::setDamagePoints( %this, %srcType, %max, %disabledAt, %destroyedAt, %amountPerSecond )
| Description: Use this method to set the damage (hit) points for one or more types.
|
| Note: %srcType accepts a comma separated list of type names.
|
Top
RGQC::getDamagePoints_Max( %this, %srcType )
| Description: Get a the specified type's 'maximum' damagePoints value.
|
Top
RGQC::getDamagePoints_DisabledAt( %this, %srcType )
| Description: Get a the specified type's 'disabled at' damagePoints value.
|
Top
RGQC::getDamagePoints_DestroyedAt( %this, %srcType )
| Description: Get a the specified type's 'destroyed at' damagePoints value.
|
Top
RGQC::config_damagePoints( %this, %obj, %typeName )
| Description: Apply the damagePoints settings to a specified object using the specified type's settings.
|
| Called by 'RGQC::applyQC()'
|
Top
RGQC::setAutoRepair( %this, %srcType, %amountPerSecond )
| Description: Use this method to set the autorepair rate for one or more types.
|
| Note: %srcType accepts a comma separated list of type names.
|
Top
RGQC::getAutoRepair( %this, %srcType )
| Description: Get the autorepair rate for a specified type.
|
Top
settings doesDamage_onCollision.cs
The following section documents all of the functions found in the file: TSTK/TGB/quickConfig/settings/doesDamage_onCollision.cs.
RGQC::doesDamage_onCollision( %this, %srcType, %dstType, %amount )
| Description: Use this method to set the damage %amount done by %srcType to %dstType upon collision.
|
| Note: %srcType accepts a comma separated list of type names.
|
Top
RGQC::getDamage_onCollisionBits( %this, %srcType )
| Description: Get a space separated list of numbers representing graph group of all objects that %srcType does damage to onCollision.
|
Top
RGQC::getDamage_onCollisionMask( %this, %srcType )
| Description: Get a bitmask representing graph group of all objects that %srcType does damage to onCollision.
|
Top
RGQC::getDamage_onCollisionAmount( %this, %srcType, %dstType )
| Description: Get the amount of damage %srcType does to %dstType onCollision.
|
Top
settings doesDrain_onCollision.cs
The following section documents all of the functions found in the file: TSTK/TGB/quickConfig/settings/doesDrain_onCollision.cs.
RGQC::doesDrain_onCollision( %this, %srcType, %dstType, %amount )
| Description: Use this method to set the energy drain %amount done by %srcType to %dstType upon collision.
|
| Note: %srcType accepts a comma separated list of type names.
|
Top
RGQC::getDrain_onCollisionBits( %this, %srcType )
| Description: Get a space separated list of numbers representing graph group of all objects that %srcType does energy drain to onCollision.
|
Top
RGQC::getDrain_onCollisionMask( %this, %srcType )
| Description: Get a bitmask representing graph group of all objects that %srcType does energy drain to onCollision.
|
Top
RGQC::getDrain_onCollisionAmount( %this, %srcType, %dstType )
| Description: Get the amount of energy drain %srcType does to %dstType onCollision.
|
Top
settings energyPoints.cs
The following section documents all of the functions found in the file: TSTK/TGB/quickConfig/settings/energyPoints.cs.
RGQC::setEnergyPoints( %this, %srcType, %max, %disabledAt, %destroyedAt, %amountPerSecond )
| Description: Use this method to set the energy points for one or more types.
|
| Note: %srcType accepts a comma separated list of type names.
|
Top
RGQC::getEnergyPoints_Max( %this, %srcType )
| Description: Get a the specified type's 'maximum' energyPoints value.
|
Top
RGQC::getEnergyPoints_DisabledAt( %this, %srcType )
| Description: Get a the specified type's 'disabled at' energyPoints value.
|
Top
RGQC::getEnergyPoints_DestroyedAt( %this, %srcType )
| Description: Get a the specified type's 'destroyed at' energyPoints value.
|
Top
RGQC::config_energyPoints( %this, %obj, %typeName )
| Description: Apply the energyPoints settings to a specified object using the specified type's settings.
|
| Called by 'RGQC::applyQC()'
|
Top
RGQC::setAutoRecharge( %this, %srcType, %amountPerSecond )
| Description: Use this method to set the autorecharge rate for one or more types.
|
| Note: %srcType accepts a comma separated list of type names.
|
Top
RGQC::getAutoRecharge( %this, %srcType )
| Description: Get the autorecharge rate for a specified type.
|
Top
settings immovable.cs
The following section documents all of the functions found in the file: TSTK/TGB/quickConfig/settings/immovable.cs.
RGQC::setImmovable( %this, %srcType, %val )
| Description: Use this method to set the immovable flag for one or more types.
|
| Note: %srcType accepts a comma separated list of type names.
|
Top
RGQC::config_immovable( %this, %obj, %typeName )
| Description: Apply the immovable settings to a specified object using the specified type's settings.
|
| Called by 'RGQC::applyQC()'
|
Top
settings layer.cs
The following section documents all of the functions found in the file: TSTK/TGB/quickConfig/settings/layer.cs.
RGQC::setLayer( %this, %srcType, %layer )
| Description: Use this method to set the layer for one or more types.
|
| Note: %srcType accepts a comma separated list of type names.
|
Top
RGQC::config_layer( %this, %obj, %typeName )
| Description: Apply the layer settings to a specified object using the specified type's settings.
|
| Called by 'RGQC::applyQC()'
|
Top
settings triggeredBy.cs
The following section documents all of the functions found in the file: TSTK/TGB/quickConfig/settings/triggeredBy.cs.
RGQC::triggeredBy( %this, %srcType, %dstType )
| Description: Use this method to enable Triggering of %srcType by one or more %dstType types.
|
| Note: Same as collision setup, so allow collidesWith to do the work.
|
| Note2: %dstType accepts a comma separated list of type names.
|
Top
