Script v1.4.4.0
- Handtools
- Events
- Objects
- Placeables
- Triggers
- Utils
- BaleUtil
- ConfigurationUtil
- DebugUtil
- FillUtil
- FruitUtil
- FSUtils
- GameSettings
- MaterialUtil
- ObjectChangeUtil
- ParticleUtil
- SplitUtil
- TipUtil
- TreePlantUtil
- Utils
- Vehicles
- Specializations
Engine v7.0.0.2
- General
- Entity
- Node
- Scenegraph
- Lighting
- Camera
- Shape
- Particle System
- Physics
- Spline
- Animation
- Overlays
- Sound
- Input
- XML
- Network
- Callbacks
- Text Rendering
- Terrain Detail
- Tire Track
- Editor
- Rendering
- String
- Math
- I3D
- Fillplanes
Foundation Reference
TreePlantUtil
DescriptionTreePlantUtilFunctions
- registerTreeType
- initTreesData
- deleteTreesData
- canPlantTree
- plantTree
- loadTreeNode
- updateTrees
- addTreeCutJoint
- cleanupDeletedTrees
- loadFromAttributesAndNodes
- getSaveAttributesAndNodes
- getTreeSaveAttributesAndNodes
- readFromServerStream
- writeToClientStream
registerTreeType
DescriptionRegister tree typeDefinition
registerTreeType(string name, string nameI18N, table treeFilenames, float growthTimeHours)Arguments
| string | name | name |
| string | nameI18N | localized name |
| table | treeFilenames | list of filenames for each growth state |
| float | growthTimeHours | growth time hours |
initTreesData
DescriptionInitalize tree dataDefinition
initTreesData(table treeData)Arguments
| table | treeData | tree data |
deleteTreesData
DescriptionDelete tree dataDefinition
deleteTreesData(table treeData)Arguments
| table | treeData | tree data |
canPlantTree
DescriptionReturns if tree can be plantedDefinition
canPlantTree()Return Values
| boolean | canPlant | can plant tree |
plantTree
DescriptionPlant treeDefinition
plantTree(table treesData, table treeData, float x, float y, float z, float rx, float ry, float rz, float growthState, integer growthStateI, boolean isGrowing, integer splitShapeFileId)Arguments
| table | treesData | trees data |
| table | treeData | tree data |
| float | x | x world position |
| float | y | z world position |
| float | z | z world position |
| float | rx | x world rotation |
| float | ry | y world rotation |
| float | rz | z world rotation |
| float | growthState | growth state |
| integer | growthStateI | growth state |
| boolean | isGrowing | is growing |
| integer | splitShapeFileId | split shape file id |
loadTreeNode
DescriptionLoad tree nodeDefinition
loadTreeNode(table treesData, table treeData, float x, float y, float z, float rx, float ry, float rz, integer growthStateI, integer splitShapeFileId)Arguments
| table | treesData | trees data |
| table | treeData | tree data |
| float | x | x world position |
| float | y | z world position |
| float | z | z world position |
| float | rx | x world rotation |
| float | ry | y world rotation |
| float | rz | z world rotation |
| integer | growthStateI | growth state |
| integer | splitShapeFileId | split shape file id |
| integer | treeId | id of tree |
| integer | splitShapeFileId | split shape file id |
updateTrees
DescriptionUpdate treesDefinition
updateTrees(table treesData, float dt, integer dtGame)Arguments
| table | treesData | trees data |
| float | dt | time since last call in ms |
| integer | dtGame | dt of game |
addTreeCutJoint
DescriptionAdd tree cut jointDefinition
addTreeCutJoint(table treesData, integer jointIndex, integer shape, float nx, float ny, float nz, float maxAngle, float maxLifetime)Arguments
| table | treesData | trees data |
| integer | jointIndex | index of joint |
| integer | shape | if of shape |
| float | nx | x world direction |
| float | ny | y world direction |
| float | nz | z world direction |
| float | maxAngle | max angle |
| float | maxLifetime | max lifetime |
cleanupDeletedTrees
DescriptionCleanup deleted treesDefinition
cleanupDeletedTrees(table treesData)Arguments
| table | treesData | trees data |
loadFromAttributesAndNodes
DescriptionLoading from attributes and nodesDefinition
loadFromAttributesAndNodes(table treesData, integer xmlFile, string baseKey)Arguments
| table | treesData | tress data |
| integer | xmlFile | id of xml object |
| string | baseKey | baseKey |
getSaveAttributesAndNodes
DescriptionGet Save attributes and nodesDefinition
getSaveAttributesAndNodes(table treesData, string nodeIdent)Arguments
| table | treesData | tress data |
| string | nodeIdent | node ident |
| string | attributes | attributes |
| string | nodes | nodes |
getTreeSaveAttributesAndNodes
DescriptionGet tree save attributes and nodesDefinition
getTreeSaveAttributesAndNodes(table treesData, string nodeIdent, table tree, boolean isGrowing, boolean firstTreeWritten)Arguments
| table | treesData | tress data |
| string | nodeIdent | node ident |
| table | tree | tree |
| boolean | isGrowing | is growing |
| boolean | firstTreeWritten | is first tree written |
| string | attributes | attributes |
readFromServerStream
DescriptionRead from server streamDefinition
readFromServerStream(table treesData, integer streamId)Arguments
| table | treesData | trees data |
| integer | streamId | stream id |
writeToClientStream
DescriptionWrite to client streamDefinition
writeToClientStream(table treesData, integer streamId)Arguments
| table | treesData | trees data |
| integer | streamId | stream id |