EngineRequestTXD: Difference between revisions
Jump to navigation
Jump to search
TheNormalnij (talk | contribs) (Created page with "__NOTOC__ {{Client function}} {{New feature/item|3.0160|1.6.0|22190|This function is used to register the next available TXD ID.}} ==Syntax== <syntaxhighlight lang="lua"> int engineRequestTXD ( string name ) </syntaxhighlight> ===Required Arguments=== *'''name''': TXD name string up to 24 characters. ===Returns=== {{New feature/item|3.0160|1.6.0|22190| Returns an ''integer'' of the TXD ID that was available to be assigned to game models, ''false'' if no free TXD ID avai...") |
m (Fixed a typo in the example section) |
||
| (One intermediate revision by one other user not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Client function}} | {{Client function}} | ||
{{New feature/item|3. | {{New feature/item|3.0161|1.6.0|22190|This function is used to register the next available TXD ID.}} | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
| Line 29: | Line 29: | ||
-- Assign TXD to game models | -- Assign TXD to game models | ||
engineSetModelTXDID(17697, newTxdId) | |||
engineSetModelTXDID(17925, newTxdId) | |||
engineSetModelTXDID(3646, newTxdId) | |||
</syntaxhighlight> | </syntaxhighlight> | ||
Latest revision as of 10:49, 10 September 2023
Syntax
int engineRequestTXD ( string name )
Required Arguments
- name: TXD name string up to 24 characters.
Returns
Returns an integer of the TXD ID that was available to be assigned to game models, false if no free TXD ID available. Do not rely on the id numbers returned being consistent across multiple clients or multiple runs of resources. There is no guarantee for the order of the numbers.
Example
This example replaces textures for some Grove Street buildings.
-- Load IMG archive
local img = engineLoadIMG('worldmod.img')
-- Enable streaming from this IMG
engineAddImage(img)
-- Allocate a new TXD
local newTxdId = engineRequestTXD("WESTERNHOUSES01")
-- Link IMG files to TXD
engineImageLinkTXD(img, "western.txd", newTxdId)
-- Assign TXD to game models
engineSetModelTXDID(17697, newTxdId)
engineSetModelTXDID(17925, newTxdId)
engineSetModelTXDID(3646, newTxdId)
Requirements
| Minimum server version | n/a |
|---|---|
| Minimum client version | 1.6.0-22190 |
Note: Using this feature requires the resource to have the above minimum version declared in the meta.xml <min_mta_version> section. e.g. <min_mta_version client="1.6.0-22190" />
See Also
- engineAddImage
- engineApplyShaderToWorldTexture
- engineFreeModel
- engineGetModelFlags
- engineGetModelIDFromName
- engineGetModelLODDistance
- engineGetModelNameFromID
- engineGetModelPhysicalPropertiesGroup
- engineGetModelTextureNames
- engineGetModelTextures
- engineGetModelTXDID
- engineGetModelVisibleTime
- engineGetObjectGroupPhysicalProperty
- engineGetSurfaceProperties
- engineGetVisibleTextureNames
- engineImageGetFilesCount
- engineImageGetFiles
- engineImageGetFile
- engineImageLinkDFF
- engineImageLinkTXD
- engineImportTXD
- engineLoadCOL
- engineLoadDFF
- engineLoadIMG
- engineLoadIFP
- engineLoadTXD
- engineRemoveImage
- engineRemoveShaderFromWorldTexture
- engineReplaceAnimation
- engineReplaceCOL
- engineReplaceModel
- engineRequestModel
- engineResetModelFlags
- engineResetModelLODDistance
- engineResetSurfaceProperties
- engineRestoreAnimation
- engineRestoreCOL
- engineRestoreDFFImage
- engineRestoreModel
- engineRestoreModelPhysicalPropertiesGroup
- engineRestoreObjectGroupPhysicalProperties
- engineRestoreTXDImage
- engineRestreamWorld
- engineSetAsynchronousLoading
- engineSetModelFlag
- engineSetModelFlags
- engineSetModelLODDistance
- engineSetModelPhysicalPropertiesGroup
- engineSetModelVisibleTime
- engineSetObjectGroupPhysicalProperty
- engineSetSurfaceProperties
- engineStreamingFreeUpMemory
- engineStreamingGetUsedMemory