Anders: /* Functions */

2025-08-12T18:18:59Z

Functions

← Older revision		Revision as of 18:18, 12 August 2025
Line 100:		Line 100:
	\|[[SceneNode:getAllScript()\|getAllScript]]()		\|[[SceneNode:getAllScript()\|getAllScript]]()
	\|Return all script from this node.		\|Return all script from this node.
			\|-
			\|number
			\|[[SceneNode:countAllNodeInTree()\|countAllNodeInTree]]()
			\|Return a number counting all nodes
	\|-		\|-
	\|[[LuaScript]]		\|[[LuaScript]]

Anders: Created page with "{{:SceneNodeExampleCode}} ==Static functions== {| class="wikitable" !|return !|function !|description |- |SceneNode |new() |Create a new Instance of the the SceneNode |- |SceneNode |new(string name) |Create a new Instance of the the SceneNode |- |SceneNode |newNil() |return a null pointer of type SceneNode |- |} ==Functions== {| class="wikitable" !|return !|function !|description..."

2025-07-05T13:04:21Z

Created page with "{{:SceneNodeExampleCode}} ==Static functions== {| class="wikitable" !|return !|function !|description |- |SceneNode |new() |Create a new Instance of the the SceneNode |- |SceneNode |new(string name) |Create a new Instance of the the SceneNode |- |SceneNode |newNil() |return a null pointer of type SceneNode |- |} ==Functions== {| class="wikitable" !|return !|function !|description..."

New page

{{:SceneNodeExampleCode}}

==Static functions==
{| class="wikitable"
!|return
!|function
!|description
|-
|[[SceneNode]]
|[[SceneNode:new()|new]]()
|Create a new Instance of the the SceneNode
|-
|[[SceneNode]]
|[[SceneNode:new(string name)|new]]([[string]] name)
|Create a new Instance of the the SceneNode
|-
|[[SceneNode]]
|[[SceneNode:newNil()|newNil]]()
|return a null pointer of type SceneNode
|-
|}

==Functions==
{| class="wikitable"
!|return
!|function
!|description
|-
|
|[[SceneNode:destroy()|destroy]]()
|Destroy this node.
|-
|
|[[SceneNode:destroyTree()|destroyTree]]()
|Destroy this node and all nodes towards leaf nodes.
This is the only way to a node completely.
|-
|[[NodeId]]
|[[SceneNode:getNodeType()|getNodeType]]()
|Returns the node id, Check [[NodeId]].
|-
|[[SceneNode]]
|[[SceneNode:toSceneNode()|toSceneNode]]()
|Converts the pointer to a sceneNode.
|-
|[[SceneNode]]
|[[SceneNode:getRootNode()|getRootNode]]()
|Returns root node of the scene tree.
|-
|[[string]]
|[[SceneNode:getSceneName()|getSceneName]]()
|Returns this nodes scene name.
|-
|[[SceneNode]]
|[[SceneNode:getParent()|getParent]]()
|Returns this nodes parent. If this node is a [[rootNode]] null is returned.
|-
|int
|[[SceneNode:getId()|getId]]()
|Returns this nodes unique id.
|-
|[[PlayerNode]]
|[[SceneNode:getPlayerNode()|getPlayerNode]]()
|Returns the player node. The player node is only returned if the parent to this node is of the type [[PlayerNode]].
This should always return a node except when this function is called from [[Camera]] or [[rootNode]]
|-
|[[BoundType]]
|[[SceneNode:getBoundType()|getBoundType]]()
|Returns the Bounding type.
|-
|[[Vec3]]
|[[SceneNode:getGlobalPosition()|getGlobalPosition]]()
|Returns the [[global]] position.
|-
|[[Vec3]]
|[[SceneNode:getLocalPosition()|getLocalPosition]]()
|Returns the local position.
|-
|[[Matrix]]
|[[SceneNode:getGlobalMatrix()|getGlobalMatrix]]()
|Returns the [[global]] [[matrix]].
|-
|[[Matrix]]
|[[SceneNode:getLocalMatrix()|getLocalMatrix]]()
|Returns the local [[matrix]].
|-
|[[Box]]
|[[SceneNode:getGlobalBoundingBox()|getGlobalBoundingBox]]()
|Returns the [[global]] [[box]].
|-
|[[Sphere]]
|[[SceneNode:getGlobalBoundingSphere()|getGlobalBoundingSphere]]()
|Returns the [[global]] [[sphere]].
|-
|[[LuaScript]]
|[[SceneNode:getScriptByName(string scriptName)|getScriptByName]]([[string]] scriptName)
|Returns the script with the given name.
|-
|{LuaScript()}
|[[SceneNode:getAllScript()|getAllScript]]()
|Return all script from this node.
|-
|[[LuaScript]]
|[[SceneNode:getCurrentScript()|getCurrentScript]]()
|Returns the current running script.
|-
|bool
|[[SceneNode:getisUpdatedEnabled()|getisUpdatedEnabled]]()
|Returns if this node accepts update.
|-
|bool
|[[SceneNode:getVisibleInCamera()|getVisibleInCamera]]()
|Returns true is this sceneNode was visible in any camera during last frame.
|-
|[[Work]]
|[[SceneNode:getWork()|getWork]]()
|Returns this nodes worker.
|-
|bool
|[[SceneNode:getCollisionEnabled()|getCollisionEnabled]]()
|Returns true if collision is enabled on this node.
|-
|bool
|[[SceneNode:getVisible()|getVisible]]()
|Returns this nodes visible variable set by setVisible().
|-
|{SceneNode()}
|[[SceneNode:findAllNodeByNameTowardsLeaf(string sceneName)|findAllNodeByNameTowardsLeaf]]([[string]] sceneName)
|Returns all nodes with the given name towards the leafNodes.
|-
|{SceneNode()}
|[[SceneNode:findAllNodeByNameTowardsLeaf(table sceneNames)|findAllNodeByNameTowardsLeaf]]([[table]] sceneNames)
|Returns all nodes with the given name towards the leafNodes.
|-
|{SceneNode()}
|[[SceneNode:findAllNodeByNameTowardsRoot(string sceneName)|findAllNodeByNameTowardsRoot]]([[string]] sceneName)
|Returns all nodes with the given name towards the root node.
|-
|{SceneNode()}
|[[SceneNode:findAllNodeByNameTowardsRoot(table sceneNames)|findAllNodeByNameTowardsRoot]]([[table]] sceneNames)
|Returns all nodes with the given name towards the root node.
|-
|{SceneNode()}
|[[SceneNode:findAllNodeByTypeTowardsLeaf(NodeId id)|findAllNodeByTypeTowardsLeaf]]([[NodeId]] id)
|Returns all nodes with the given nodeId towards the leaf node.
|-
|{SceneNode()}
|[[SceneNode:findAllNodeByTypeTowardsLeaf(table idList)|findAllNodeByTypeTowardsLeaf]]([[table]] idList)
|Returns all nodes with the given nodeIds towards the leaf node.
|-
|{SceneNode()}
|[[SceneNode:getAllNodeByTypeTowardsLeafWithinSphere(NodeId id, Sphere aSphere)|getAllNodeByTypeTowardsLeafWithinSphere]]([[NodeId]] id, [[Sphere]] aSphere)
|Returns all nodes with the given nodeId within the sphere towards the leaf node.
|-
|[[SceneNode]]
|[[SceneNode:findNodeByName(string sceneName)|findNodeByName]]([[string]] sceneName)
|Returns the first node with the given name.
Looks first towards the leafNodes then look toward the root node
|-
|[[SceneNode]]
|[[SceneNode:findNodeByType(NodeId id)|findNodeByType]]([[NodeId]] id)
|Returns the first node with the given nodeId.
Looks first towards the leafNodes then look toward the root node
|-
|[[SceneNode]]
|[[SceneNode:findNodeByTypeTowardsLeafe(NodeId id)|findNodeByTypeTowardsLeafe]]([[NodeId]] id)
|Returns the first node with the given nodeId towards leaf nodes.
|-
|[[SceneNode]]
|[[SceneNode:findNodeByTypeTowardsRoot(NodeId id)|findNodeByTypeTowardsRoot]]([[NodeId]] id)
|Returns the first node with the given nodeId towards root node.
|-
|
|[[SceneNode:setSceneName(string name)|setSceneName]]([[string]] name)
|Set the name of the sceneNode.
|-
|
|[[SceneNode:setLocalMatrix(Matrix mat)|setLocalMatrix]]([[Matrix]] mat)
|Set local [[matrix]].
|-
|
|[[SceneNode:setLocalPosition(Vec3 position)|setLocalPosition]]([[Vec3]] position)
|Set local position.
|-
|
|[[SceneNode:setVisible(bool visible)|setVisible]](bool visible)
|Set if node should be visible.
|-
|
|[[SceneNode:setParent(SceneNode parent)|setParent]](SceneNode parent)
|Set the parent.
|-
|
|[[SceneNode:setEnableUpdates(bool enabled)|setEnableUpdates]](bool enabled)
|Set if this node should be updated. if this nodes update is disabeld all children will not ether get updated.
|-
|
|[[SceneNode:setCollisionEnabled(bool enabled)|setCollisionEnabled]](bool enabled)
|Set if this node should have collision enabled, by default all node has collision enabled.
|-
|
|[[SceneNode:DisableBoundingVolumesDynamicUpdates()|DisableBoundingVolumesDynamicUpdates]]()
|changing position rotation and scale should not effect parrent bounding volume.
This is an optimization for dynamic object that changes it's local matrix but not actually it's position.
|-
|
|[[SceneNode:setBoundingVolumeCanShrink(bool canShrink)|setBoundingVolumeCanShrink]](bool canShrink)
|Config the bounding volume never to shrink. this is useful to increase performance on object that may move around internal but have a somewhat constant bounding volume.
|-
|
|[[SceneNode:createBoundVolumeGroup()|createBoundVolumeGroup]]()
|Force create a bound volume group.
|-
|[[Work]]
|[[SceneNode:createWork()|createWork]]()
|create a [[work]] from this node.
This function is not needed at all. It's used to make some very specific optimization.
|-
|[[SceneNode]]
|[[SceneNode:collision(Line3D line)|collision]]([[Line3D]] line)
|Perform [[collision]] against this node. Return this sceneNode if [[collision]] was found.
|-
|[[SceneNode]]
|[[SceneNode:collision(Line3D line, Vec3 normal)|collision]]([[Line3D]] line, [[Vec3]] normal)
|Perform [[collision]] against this node. Return this sceneNode if [[collision]] was found and the normal of the [[collision]].
|-
|[[SceneNode]]
|[[SceneNode:collisionTree(Line3D line)|collisionTree]]([[Line3D]] line)
|Perform collision against this node and all nodes towards the leaf nodes. Return the sceneNode from the closest [[collision]]. if no [[collision]] was detected return null.
|-
|[[SceneNode]]
|[[SceneNode:collisionTree(Line3D line, Vec3 normal)|collisionTree]]([[Line3D]] line, [[Vec3]] normal)
|Perform [[collision]] against this node and all nodes towards the leaf nodes. Return the sceneNode from the closest [[collision]] and the normal. if no [[collision]] was detected return null.
|-
|[[SceneNode]]
|[[SceneNode:collisionTree(Line3D line, NodeId id)|collisionTree]]([[Line3D]] line, [[NodeId]] id)
|Perform [[collision]] against this node and all towards the leaf nodes with the same [[nodeId]]. Return the sceneNode from the closest [[collision]]. if no [[collision]] was detected return null.
|-
|[[SceneNode]]
|[[SceneNode:collisionTree(Line3D line, table whiteListedNodeIds)|collisionTree]]([[Line3D]] line, table whiteListedNodeIds)
|Perform collision against this node and all towards the leaf nodes if the NodeId of the sceneNode is contained in the table.
|-
|[[SceneNode]]
|[[SceneNode:collisionTree(Line3D line, Vec3 normal, table whiteListedNodeIds)|collisionTree]]([[Line3D]] line, [[Vec3]] normal, table whiteListedNodeIds)
|Perform collision against this node and all towards the leaf nodes if the NodeId of the sceneNode is contained in the table.
|-
|{SceneNode()}
|[[SceneNode:collisionTree(Frustrum aFrustrum, table whiteListedNodeIds)|collisionTree]]([[Frustrum]] aFrustruml, table whiteListedNodeIds)
|Perform collision against this node and all towards the leaf nodes if the NodeId of the sceneNode is contained in the table.
|-
|[[SceneNode]]
|[[SceneNode:addChild(SceneNode child)|addChild]](SceneNode child)
|Add the node as a child to this one
|-
|bool
|[[SceneNode:removeChild(SceneNode child)|removeChild]](SceneNode child)
|Remove the child. Returns true if the child was removed else false.
|-
|[[SceneNode]]
|[[SceneNode:getChildNode(int index)|getChildNode]](int index)
|Get child by index.
|-
|int
|[[SceneNode:getChildSize()|getChildSize]]()
|Get number of children.
|-
|[[SceneNode]]
|[[SceneNode:getVisibleChildNode(int index)|getVisibleChildNode]](int index)
|Get visible child by index.
|-
|int
|[[SceneNode:getVisibleChildSize()|getVisibleChildSize]]()
|Get number of visible children.
|-
|bool
|[[SceneNode:getCanBeSaved()|getCanBeSaved]]()
|Get if the this scene can be saved by the saveScene() function.
|-
|
|[[SceneNode:loadLuaScriptAndRunOnce(String scriptName)|loadLuaScriptAndRunOnce]]([[String]] scriptName)
|Try to load a new script from file and immediately execute the script and then destroy the script.
|-
|
|[[SceneNode:loadLuaScriptAndRunOnce(string scriptName)|loadLuaScriptAndRunOnce]]([[string]] scriptName)
|Try to load a new script from file and immediately execute the script and then destroy the script.
|-
|[[LuaScript]]
|[[SceneNode:loadLuaScript(String scriptName)|loadLuaScript]]([[String]] scriptName)
|Try to load a new script from file. return null if failed
|-
|[[LuaScript]]
|[[SceneNode:loadLuaScript(string scriptName)|loadLuaScript]](string scriptName)
|Try to load a new script from file. return null if failed
|-
|
|[[SceneNode:removeScript(String scriptName)|removeScript]]([[String]] scriptName)
|Removes a script with the given name.
|-
|
|[[SceneNode:removeScript(string scriptName)|removeScript]]([[string]] scriptName)
|Removes a script with the given name.
|-
|
|[[SceneNode:update()|update]]()
|Update node. This function is automatically called by the game if the nood is connected to the main sceneNode.
|-
|
|[[SceneNode:setCanBeSaved(bool canBeSaved)|setCanBeSaved]](bool canBeSaved)
|Set if the this scene can be saved by the saveScene() function.
|-
|
|[[SceneNode:saveScene(string fileName)|saveScene]](string fileName)
|Save the tree hierarchy from this scene node. This will save all nodes and some local state.
Used to create save and load functionality for map editor.
This is NOT a in game save functionality.
|-
|[[SceneNode]]
|[[SceneNode:loadScene(string fileName)|loadScene]](string fileName)
|Load a scene node hierarchy as a child to this node.
|-
|}

==Overloaded returns==
{| class="wikitable"
!|return
!|function
!|Parameter
|-
|SceneNode
|findNodeByType
|id
|-
|{SceneNode()}
|findAllNodeByTypeTowardsLeaf
|id
|-
|SceneNode
|findNodeByTypeTowardsLeafe
|id
|-
|SceneNode
|findNodeByTypeTowardsRoot
|id
|-
|{SceneNode()}
|getAllNodeByTypeTowardsLeafWithinSphere
|id
|-
|SceneNode
|addChild
|child
|-
|SceneNode
|[[collision]]
|id
|-
|}

SceneNode - Revision history

Anders: /* Functions */