|
Blink 3D BlinkScript API - Classes and Objects
|
Utility
|
| Class |
Scope |
Properties |
Methods |
Callbacks |
|
Rotation
|
global |
|
Rotation()
Rotation( sAxis, dAngle )
Rotation( sAxes, dAngle1,dAngle2, dAngle3 )
Rotation( vVector, dAngle )
Rotation( dRotation1, dRotation2 )
Rotation( rRotation.toString() )
Rotation( rRotation1, rRotation2.toString(), sAxis, dAngle, ... )
|
|
| local |
type
|
blend( rRotation, dFraction )
map( vVector )
mapAxis( iAxis )
scale( dScale )
same( rRotation )
dot( rRotation )
inverse()
getPitch()
getYaw()
getRoll()
toString()
|
|
|
Transform
|
global |
|
Transform()
Transform( vTranslate )
Transform( rRotation )
Transform( vTranslate, rRotation )
Transform( tRansfrom1, tTransform2 )
Transform( vTranslateVector, tTransform, rRotation, ... )
Transform( tTransform.toString() )
|
|
| local |
type
rotation
translation
|
blend( tTransform, dFraction )
map( vVector )
scale( dPow )
inverse()
toString()
|
|
|
Vector
|
global |
|
Vector()
Vector( dX,dY, dZ )
Vector( [ dX, dY, dZ ] )
Vector( vVector.toString() )
|
|
| local |
type
x, y, z
length
squaredLength
|
change( iIndex, dValue )
add( vVector )
cross( vVector )
dot( vVector )
same( vVector )
dist( vVector )
subtract( vVector )
addScaled( vVector, dScale )
blend( vVector, dFraction )
scale( dScale )
inverse()
normalized()
floor( vVector )
ceil( vVector )
perpendicular()
randomDeviant( dAngle )
toString()
|
|
|
Color
|
global |
|
Color()
Color( dR, dG, dB, dA )
Color( [ dR, dG, dB, dA ] )
Color( cColor.toString() )
|
|
| local |
type
r, g, b, a
|
change( iIndex, dValue )
add( cColor )
same( cColor )
subtract( cColor )
blend( cColor, dFraction )
toString()
|
|
Misc
|
| Class |
Scope |
Properties |
Methods |
Callbacks |
Application
|
global |
Application
|
|
|
| local |
type
controlKeyDown
shiftKeyDown
downArrowKeyDown
leftArrowKeyDown
rightArrowKeyDown
upArrowKeyDown
mouseButtonDown
chatPaneVisible
splitPercentage
toolbarVisible
mouseInitialized
numTimesteps
version
build
context
statsVisible
hostURL
lastFPS
bestFPS
worstFPS
averageFPS
triCount
|
createView( camCamera, iZOrder )
getView( iIndex )
getViewByZOrder( iZOrder )
getViewCount()
deleteView( oView )
createCamera( sCameraName )
getCamera( sCameraName )
deleteCamera( oCamera )
addTimestep( oObject )
removeTimestep( oObject )
addListener( oObject )
removeListener( oObject )
sendJS( sCommand )
loadScriptFile( sFileName [sResourceGroupName] )
downloadEnvx( sURL, sResourceGroupName, bLoad [,vPosition, rRotation ] )
loadEnvx( sResourceGroupName, bRun )
runEnvx( sResourceGroupName )
unloadEnvx( sResourceGroupName, bDelete )
isEnvxDownloaded( sResourceGroupName )
getEnvxDownloadSize( sResourceGroupName )
getEnvxBytesDownloaded( sResourceGroupName )
exit()
createSocket()
createXMLSocket()
createXMPP( sServerName, bCollaborationService )
createXML( sXML, sRootNodeName )
|
timestep( dElapsedTime, dDeltaTime )
onDownload( sResourceGroupName )
onAvatarDownload()
|
Blink
|
global |
Blink
|
|
|
| local |
type
radiansInCircle
isSnapTo
gridSize
isDesignTime
|
behaviorLoaded( sBehaviorName )
sendStatusMessage( sMessage )
sendErrorMessage( sMessage )
propertyValueChanged( sBehaviorName, sPropertyName, sValue )
readOnlyValueChanged( sBehaviorName, sPropertyName, bReadOnly )
browseableValueChanged( sBehaviorName, sPropertyName, bBrowsable )
maxValueChanged( sBehaviorName, sPropertyName, dMaxValue )
minValueChanged( sBehaviorName, sPropertyName, dMinValue )
stepValueChanged( sBehaviorName, sPropertyName, dStepValue )
defaultValueChanged( sBehaviorName, sPropertyName, sDefValue )
listValueChanged( sBehaviorName, sPropertyName, sListValue )
helpTextChanged( sBehaviorName, sPropertyName, sHelpText )
dataTypeUIChanged( sBehaviorName, sPropertyName, sUIType )
dataTypeChanged( sBehaviorName, ssPropertyName, sDataType )
lTrim( sValue )
rTrim( sValue )
toBoolean( uValue )
toLogicalNumber( uValue )
toString( uValue )
toStringVector( uValue )
toColor( sValue )
dateTimeToNumber( sValue )
dateToNumber( sValue )
timeToNumber( sValue )
colorToNumber( cColor )
degreesToRadians( dDegrees )
radiansToDegrees( dRadians )
setPropertyValue( oBehavior, sPropertyName, sValue1 [, sValue2, sValue3] )
getPropertyValue( oBehavior, sPropertyName [, sValue1, sValue2, sValue3] )
setSuperPropertyValue( oBehavior, sPropertyName, sValue1 [, sValue2, sValue3] )
getSuperPropertyValue( oBehavior, sPropertyName [, sValue1, sValue2, sValue3] )
resolveBehaviorRef( oBehavior, sBehaviorDispName, sPropertyName [,bAssigneNode] )
displayNameToName( sDisplayName )
nameToDisplayName( sBehaviorName )
getBehavior( sBehaviorName )
onEvent( oBehavior, sEventName, sValueSource, sValue )
snapToPosition( vCurPos )
getSuggestedInitPosition( [oEntity ])
|
|
|
Key
|
global |
Key
|
isKeyDown( iKey )
addListener( oObject )
removeListener( oObject )
|
|
| local |
type
buffered
|
|
onKeyDown()
onKeyUp()
onEvent()
|
Mouse
|
global |
Mouse
|
isButtonDown( dButton )
addListener( oObject [, sObject ] )
removeListener( oObject )
|
|
| local |
type
buffered
cursor
hide
|
|
onEvent( iMouseX, iMouseY, iMouseZ oObject )
onClick( iMouseX, iMouseY, iMouseZ, oObject )
onMove( iMouseX, iMouseY, iMouseZ, oObject )
onOver( iMouseX, iMouseY, iMouseZ, oObject )
onOut( iMouseX, iMouseY, iMouseZ )
|
Chat
|
global |
Chat
|
addListener( oObject )
removeListener( oObject )
|
|
|
local
|
type
debugOutput
fontName
fontSize
rightAlign
|
input( uValue, ... )
print( uValue, ... )
printColor( sChatMsg, cColor )
printDebug( uValue, ... )
dump( oObject )
clear())
|
onChatIn( sChatMsg )
onChatOut( sChatMsg )
|
System
|
global |
System
|
|
|
| local |
type
viewerType
rendererType
hasAudio
hasEAX2
hasHardwareEAX2
screenResolutionX
screenResolutionY
navigationInputFreq
garbageCollectionFreq
networkingFreq
receivedChatFreq
soundFreq
avatarEnvLoadFreq
timestepUHighFreq
timestepHighFreq
timestepMediumFreq
timestepLowFreq
|
hasRendererCapability( dCapability )
isGPUSyntaxSupported( [dSyntax | sSyntax] )
loadEnv( sURL, bPrevSettings, bForceDownload, iProgressBarStyle [,sEntryPoint] )
|
|
View
|
global |
|
|
|
| local |
type
imageHeight
imageWidth
imageTop
imageLeft
relativeHeight
relativeWidth
relativeTop
relativeLeft
backgroundColor
zOrder
clearEveryFrame
displayOverlays
displayShadows
displaySkies
mouseX
mouseY
dofEnabled
nearDepth
farDepth
focalDepth
farBlurCutoff
hasCompositorChain
materialSchemeName
|
setCamera( sCameraName )
getCamera()
update()
createCompositor( sName, [ sResourceGroupName ] )
addCompositor( sName, [ iChainPosition ] )
getCompositor( sName )
removeCompositor( sName )
getCompositorChain()
removeCompositorChain()
setCompositorEnabled( sName, bEnabled )
|
|
Effects
|
| Class |
Scope |
Properties |
Methods |
Callbacks |
Fog
|
global |
Fog
|
|
|
|
local
|
type
active
color
dropOff
near
far
density
|
|
|
SoundSystem
|
global |
SoundSystem
|
|
|
| local |
type
volume
distanceModel
speedOfSound*
dopplerFactor
noFocusMute
numBuffers
worldSpacePosition
direction
velocity
overridePosition
overrideDirection
environment
environmentSize
environmentDiffusion
room
roomHF
roomRolloff
decayTime
scaleDecayTimeAuto
reflections
reflectionsDelay
scaleReflectionsAuto
scaleReflectionsDelayAuto
reverb
reverbDelay
scaleReverbAuto
scaleReverbDelayAuto
airAbsorption
clipDecayTimeHFAuto
deferred
|
createSound()
destroySound( oSound )
play()
pause()
resume()
stop()
commit()
|
|
Sound
|
global |
|
|
|
| local |
type
ambient
loopCount
numLoops
volume
minVolume
maxVolume
pitch
isStereo
isPlaying
isPaused
far
near
rolloff
worldSpacePosition
direction
velocity
duration
elapsedTime
coneInnerAngle
coneOuterAngle
coneOuterVolume
outsideVolume
obstruction
obstructionMuffling
obstructionLF
occlusion
occlusionMuffling
occlusionLF
occlusionRoom
direct
directHF
directHFAuto
room
roomAuto
roomHF
roomHFAuto
roomRolloff
airAbsorption
deferred
|
setFileName( sFileName [, sResourceGroupName] )
getFileName()
squareWave( dFreq )
tone( dFreq )
pinkNoise()
whiteNoise()
play()
pause()
rewind()
stop()
close()
attachToObject( oSceneNode )
getAttachedObject()
detachFromObject()
commit()
|
onEnd()
|
SkyDome
|
global |
|
|
|
| local |
type
enable
materialName
curvature
tiling
distance
orientation
drawFirst
segmentsX
segmentsY
segmentsKeepY
resourceGroupName
|
|
|
SkyBox
|
global |
|
|
|
| local |
type
enable
materialName
distance
orientation
drawFirst
resourceGroupName
|
|
|
SkyPlane
|
global |
|
|
|
| local |
type
enable
materialName
scale
tiling
bow
distance
normal
drawFirst
segmentsX
segmentsY
resourceGroupName
|
|
|
Movable
|
| Class |
Scope |
Properties |
Methods |
Callbacks |
|
Actor
|
global |
Actor
|
|
|
| local |
type
name
avatarURL
remoteAvatarURL
nickname
allowAvatarChange
allowNicknameChange
parentSceneNode
showAvatar
showBoundingBox
preferenceShowMyAvatar
isLoaded
position
orientation
transform
scale
facing
avatarYaw
velocity
angularVelocity
momentum
angularMomentum
verticalThrusters
keySpacebarResets
keyForwardBackwardMoves
keyLeftRightMoves
keyLeftRightTurns
keyUpDownMoves
keyUpDownTurns
mouseLeftRightMoves
mouseLeftRightTurns
mouseUpDownMoves
mouseUpDownTurns
mouseForwardBackwardMoves
cameraDistanceAdjust
cameraUpDownOrbit
cameraLeftRightOrbit
cameraRotationLocked
cameraPositionLocked
keyMoveInsteadOfTurn
leftRightOrbitEnabled
upDownOrbitEnabled
navigationStyle
navigationPhysicsType
keyMoveSpeed
keyRotateSpeed
mouseMoveSpeed
mouseRotateSpeed
animationSpeed
cameraOrbitSpeed
cameraDistance
cameraPitch
cameraYaw
cameraSelfPitch
cameraSelfYaw
collisionGroup
collisionNotifyGroup
collisionGeometryType
physicalMaterial
maxVelocity
maxAngularVelocity
dampingFactor
angularDampingFactor
mass
cameraOffsetY
cameraOffsetX
navigationNode
forceMode
gravity
skinWidth
stepOffset
geomOffsetPosition
geomOffsetOrientation
lockXAxis
lockYAxis
scale
maxGameCamAngle
minGameCamAngle
idleAnimationEnabled
walkAnimationEnabled
isMoving
userData
|
dist( vPosition )
lookAt( vPosition )
alignAvatarAndCameraTo( rRotation )
getAvatarOrientation()
getCameraOrientation()
getNavigationView()
setNavigationView( oView )
setCollisionSetting( bCollide, bForce )
getCollisionSetting()
setGravitySetting( bGravity, bForce )
getGravitySetting()
applyForce( vForce [, bLocal ] )
applyTorque( vTorque [, bLocal ] )
setMovementAnimation( sName, bIdle, dSpeedAdjust, vExtents )
setIdleAnimation( sName, dSpeedAdjust, vExtents )
resetMovementAnimation()
resetIdleAnimation()
hasAnimation( sName )
getAnimationStateNames()
getNumAnimationStates()
getAnimationState( iIndex )
getAnimationStateByName( sName )
attachObjectToBone( sBoneName, oObject, rOffset, vOffset )
detachObjectFromBone( sBoneName )
|
|
BillboardSet
|
global |
|
|
|
| local |
type
isAttached
isInScene
parentNode
parentSceneNode
name
worldSpacePosition
worldSpaceOrientation
worldSpaceTransform
renderQueueGroup
boundsMin
boundsMax
visible
castShadows
materialName
cullIndividually
defaultWidth
defaultHeight
billboardType
commonDirection
origin
poolSize
autoExtendPool
userData
|
createBillboard( vPosition )
getNumBillboards()
getBillboard( iIndex )
destroyBillboard( iIndex )
|
|
Billboard
|
global |
|
|
|
| local |
type
hasOwnDimensions
width
height
rotation
position
color
|
resetDimensions()
|
|
Camera
|
global |
|
|
|
| local |
type
name
position
orientation
transform
worldSpacePosition
worldSpaceOrientation
worldSpaceTransform
fieldOfView
lockToOffset
farClipDistance
nearClipDistance
autoAspectRatio
aspectRatio
lodBias
projectionType
detailLevel
isReflected
isLockedTo
isAttached
isInScene
parentNode
parentSceneNode
frameSize
focalDistance
focalLength
fStop
hyperfocalLength
userData
|
setLockToObject( oSceneNode )
getLockToObject()
setReflectionPlane( oPlane )
getReflectionPlane()
lookAt( vVector )
getPixelXCoordFromRayDirection( vDirection )
getPixelYCoordFromRayDirection( vDirection )
getRayDirectionFromPixelCoords( iPixelX, iPixelY)
recalculateDepthOfField( oView )
|
|
Entity
|
global |
|
|
|
| local |
type
name
isAttached
isInScene
parentNode
parentSceneNode
renderQueueGroup
boundsMin
boundsMax
origin
worldSpaceOrigin
visible
castShadows
hasSkeleton
isSkeletonShared
skeleton
mesh
normalizeNormals
hasPhysicalModel
collisionGeometryType
fixed
kinematic
collide
mass
gravity
angularDamping
damping
maxAngularVelocity
velocity
angularVelocity
momentum
angularMomentum
kineticEnergy
sleepAngularVelocity
sleepVelocity
isSleeping
isGroupSleeping
collisionGroup
collisionNotifyGroup
massInertiaTensor
massWorldSpaceInertiaTensor
centerOfMassPosition
centerOfMassWorldSpacePosition
centerOfMassOrientation
centerOfMassWorldSpaceOrientation
ccdMotionThreshold
solverIterationCount
skinWidth
physicalMaterial
physicalWheel
geomOffsetPosition
geomOffsetOrientation
geomSize
userData
|
getNumSubEntities()
getSubEntity( iIndex )
getSubEntityByName( sName )
getNumAnimationStates()
getAnimationState( iIndex )
getAnimationStateByName( sName )
attachObjectToBone( sBoneName, oObject, rOffset, vOffset )
detachObjectFromBone( sBoneName )
setDetailLevel( dDetailLevel )
setDisplaySkeleton( bDisplay )
shareSkeleton( oEntity )
setMaterialName( sName )
createPhysicalModel( [[[ vPosition ], rOrientation ], vScale ] )
destroyPhysicalModel()
setLockPositionAxis( iAxis, bLock )
getLockPositionAxis( iAxis )
setLockRotationAxis( iAxis, bLock )
getLockRotationAxis( iAxis )
sleep( [dFrames] )
getVelocityAt( vPosition [,bLocal ] )
applyTorque( vTorque, iMode [,bLocal ] )
applyForce( vForce,
iMode [,bLocal ] )
applyForceAt( vForce, vPosition,
iMode [,bLocal ] )
applyLocalForceAt( vForce, vPosition, iMode [,bLocal ] )
movePosition( vPosition )
moveOrientation( rOrientation )
|
|
SubEntity
|
global |
|
|
|
| local |
type
materialName
worldSpacePosition
worldSpaceOrientation
worldSpaceTransform
visible
detailLevel
|
getSubMesh()
getMaterial()
getTechnique()
getCastShadows()
setCustomParameters( iIndex, aValues )
getCustomParameters( iIndex )
|
|
Line
|
global |
|
|
|
| local |
type
name
isAttached
isInScene
parentNode
parentSceneNode
renderQueueGroup
visible
castShadows
userData
|
addLine( vStart, vEnd, cColor )
destroyAllLines()
draw()
|
|
Portal
|
global |
|
|
|
| local |
type
name
position
active
visible
proximity
height
URL
texture
textureScaleU
textureScaleV
enableScrolling
entryPoint
forceDownload
usePrevSettings
progressBarStyle
targetSceneNode
parentSceneNode
entity
|
|
|
MovablePlane
|
global |
|
|
|
| local |
type
name
isAttached
isInScene
parentNode
parentSceneNode
renderQueueGroup
boundsMin
boundsMax
visible
castShadows
normal
distance
|
getDistance( vPoint )
getSide( vPoint )
|
|
ParticleSystem
|
global |
|
|
|
| local |
type
isAttached
isInScene
parentNode
parentSceneNode
name
renderQueueGroup
boundsMin
boundsMax
visible
castShadows
materialName
resourceGroupName
maxParticles
speedFactor
cullIndividually
defaultWidth
defaultHeight
renderer
billboardType
commonDirection
userData
|
createEmitter( dType )
getNumEmitters()
getEmitter( iIndex )
destroyEmitter( iIndex )
createAffector( dType )
getNumAffectors()
getAffector( iIndex )
destroyAffector( iIndex )
createParticle()
getNumParticles()
getParticle( iIndex )
fastForward( dTime, dInterval )
|
|
Particle
|
global |
|
|
|
| local |
type
hasOwnDimensions
width
height
rotation
direction
worldSpacePosition
color
timeToLive
totalTimeToLive
rotationSpeed
|
resetDimensions()
|
|
ParticleAffector
|
global |
|
|
|
| local |
type
affectorType
red1
green1
blue1
alpha1
red2
green2
blue2
alpha2
stateChange
image
time0
color0
time1
color1
time2
color2
forceVector
forceApplication
scale
rotationSpeedRangeStart
rotationSpeedRangeEnd
rotationAngleRangeStart
rotationAngleRangeEnd
|
|
|
ParticleEmitter
|
global |
|
|
|
| local |
type
emitterType
enabled
emissionRate
startTime
position
direction
angle
velocity
minVelocity
maxVelocity
timeToLive
minTimeToLive
maxTimeToLive
color
colorRangeStart
colorRangeEnd
duration
minDuration
maxDuration
repeatDelay
minRepeatDelay
maxRepeatDelay
width
height
depth
innerWidth
innerHeight
innerDepth
|
|
|
Rectangle
|
global |
|
|
|
| local |
type
name
isAttached
isInScene
parentNode
parentSceneNode
renderQueueGroup
boundsMin
boundsMax
visible
castShadows
materialName
|
setCorners( dLeft, dRight, dTop, dBottom )
getMaterial()
|
|
Text
|
global |
|
|
|
| local |
type
name
isAttached
isInScene
parentNode
parentSceneNode
visible
castShadows
text
fontName
characterHeight
spaceWidth
vertAlignment
horzAlignment
additionalHeight
color
depthBias
alwaysOnTop
renderQueueGroup
userData
|
|
|
DistantLight
|
global |
|
|
|
| local |
type
direction
worldSpaceDirection
diffuseColor
specularColor
castShadows
visible
isAttached
isInScene
parentNode
parentSceneNode
name
|
|
|
SpotLight
|
global |
|
|
|
| local |
type
position
direction
worldSpacePosition
worldSpaceDirection
diffuseColor
specularColor
attenuationRange
attenuationConstant
attenuationLinear
attenuationQuadric
castShadows
innerAngle
outerAngle
falloff
visible
isAttached
isInScene
parentNode
parentSceneNode
name
userData
|
|
|
PointLight
|
global |
|
|
|
| local |
type
position
worldSpacePosition
diffuseColor
specularColor
attenuationRange
attenuationConstant
attenuationLinear
attenuationQuadric
castShadows
visible
isAttached
isInScene
parentNode
parentSceneNode
name
userData
|
|
|
VisualizeShape
|
global |
|
|
|
| local |
type
name
shape
position
orientation
transform
worldSpacePosition
worldSpaceOrientation
worldSpaceTransform
width
height
depth
radius
color
visible
sceneNode
|
|
|
Scene Elements
|
| Class |
Scope |
Properties |
Methods |
Callbacks |
Scene
|
global |
Scene
|
|
|
| local |
type
rootNode
ambientLightColor
showBoundingBoxes
numMipmaps
defaultAnisotropyLevel
shadowColor
shadowFar
shadowTextureCount
shadowTextureSize
shadowIndexBufferSize
shadowDirLightExtrusionDist
shadowTechnique
debugShadows
shadowTexturePixelFormat
shadowTextureSelfShadow
|
loadWorldGeometry( sConfigFile )
setShowSceneNodes( bEnable )
createMaterial( sName, sResourceGroupName )
getMaterial( sName )
getDefaultMaterial()
setDefaultTextureFiltering()
createSkeleton( sName, sResourceGroupName )
createSceneNode( sName )
getSceneNode( sName )
destroySceneNode( oSceneNode )
createEntity( sName, sMesh [[, sResourceGroupName], bBuildTangentVectors] )
createPrefabEntity( sName, dPrefab )
getEntity( sName )
destroyEntity( oEntity )
createBillboardSet( sName, )
getBillboardSet( sName )
destroyBillboardSet( oBillboardSet )
createAnimation( sName, dLength )
getAnimation( sName )
destroyAnimation( oAnimation )
createAnimationState( sName )
getAnimationState( sName )
destroyAnimationState( oAnimationState )
createParticleSystem( sName, sResourceGroupName )
createParticleSystemFromFile( sName, sTemplate )
getParticleSystem( sName )
destroyParticleSystem( oParticleSystem )
createPointLight( sName )
getPointLight( sName )
destroyPointLight( oPointLight )
createSpotLight( sName )
getSpotLight( sName )
destroySpotLight( oSpotLight )
createDistantLight( sName )
getDistantLight( sName )
destroyDistantLight( oDistantLight )
createText( sName )
getText( sName )
destroyText( oText )
createLine( sName )
getLine( sName )
destroyLine( oLine )
createRectangle( sName )
getRectangle( sName )
destroyRectangle( oRectangle )
createRenderTexture( sName, iWidth, iHeight )
destroyRenderTexture( sName )
createSkyBox()
createSkyPlane()
createSkyDome()
createGround( sName,
sMaterial, dWidth, dHeight, bPhysics [[, iCollisionGeom ], sResourceGroupName ] )
destroyGround()
createStaticGeometry( sName )
getStaticGeometry( sName )
destroyStaticGeometry()
setShadowUseInfiniteFarPlane( bEnable )
setShadowTextureFadeNear( dNear )
setShadowTextureFadeFar( dFar )
setShadowDirLightTextureOffset( dOffset )
setShadowTextureCasterMaterial( sMaterialName )
setShadowTextureReceiverMaterial( sMaterialName )
createMovablePlane( sName )
createPlane( bEnable )
createPlaneMesh( sName,
dWidth, dHeight, iXSegments, iYSegments, bNormals, iNumTextCoordSets,
dUTile, dVTile, vUp [, sGroupName, dVertexBufferUsage, dIndexBufferUsage,
vVertexShadowBuffer, bIndexShadowBuffer ] )
createCurvedPlaneMesh( sName,
dWidth, dHeight, dBow, iXSegments, iYSegments, bNormals, iNumTextCoordSets,
dUTile, dVTile, vUp [, sGroupName, dVertexBufferUsage, dIndexBufferUsage,
vVertexShadowBuffer, bIndexShadowBuffer ] )
createCurvedIllusionPlaneMesh( sName,
dWidth, dHeight, dCurvature, iXSegments, iYSegments, bNormals, iNumTextCoordSets,
dUTile, dVTile, vUp [, sGroupName, dVertexBufferUsage, dIndexBufferUsage,
vVertexShadowBuffer, bIndexShadowBuffer, iYSegmentsToKeep ] )
rayIntersectionDistance( vPosition, vDir [, iCount ] )
rayIntersectionObject( vPosition, vDir [, iCount ] )
createOverlay( sName )
getOverlay( sName )
destroyOverlay( sName )
destroyAllOverlays()
createHTMLMaterial(sMaterialName
[, sURL, sResourceGroup, dPageWidth, dPageHeight] )
getHTMLMaterial( sMaterialName )
destroyHTMLMaterial( sMaterialName )
createVideoMaterial(sMaterialName
[, sURL, sResourceGroup, dVideoWidth, dVideoHeight])
getVideoMaterial( sMaterialName )
destroyVideoMaterial( sMaterialName )
createVisualizeShape( sName, dShapeType )
getVisualizeShape( sName )
destroyVisualizeShape( sName )
createPortal( sName )
getPortal( sName )
destroyPortal( sName )
createHardwareVertexBuffer( iSize, iNumVerts, dOptions, bUseShadowBuf )
loadMesh( sMeshName [[,sResourceGroup ], dVertexUsage, dIndexUsage, bVertexShadowBuf, bIndexShadowBuf ] )
|
|
SceneNode
|
global |
|
|
|
| local |
type
name
position
transform
orientation
worldSpacePosition
worldSpaceOrientation
worldSpaceTransform
fixedYawAxis
initialPosition
initialTransform
initialOrientation
initialScale
lockToOffset
isLockedTo
isAttached
isInScene
parentNode
parentSceneNode
showBoundingBox
scale
inheritScale
|
yaw( dAngle, dTransformType )
pitch( dAngle, dTransformType )
roll( dAngle, dTransformType )
rotate( rRotation, dTransformType )
translate( vVector, dTransformType )
lookAt( vPosition , dTransformType )
setLockToObject( oSceneNode )
getLockToObject()
attachObject( oObject )
getNumObjects()
getObject( iIndex )
getObjectByName( sName )
detachObject( iIndex )
detachObjectByName( sName )
createChildNode( sName )
addChildNode( oSceneNode )
getNumChildren()
getChildNode( iIndex )
getChildNodeByName( sName )>
destroyChildNode( oSceneNode )
removeChildNode( oSceneNode )
getTechnique()
getMaterial()
setInitialState()
resetToInitialState()
|
|
Mesh
|
global |
|
|
|
| local |
type
name
isLodManual
isLoaded
isVertexBufferShadowed
isIndexBufferShadowed
boundsMin
boundsMax
hasSkeleton
skeletonName
skeleton
autoBuildEdgeLists
|
getNumSubMeshes()
getSubMesh( iIndex )
getSubMeshByName( sName )
addBoneAssignment( iBoneIndex, iVertexIndex, dWeight )
clearBoneAssignments()
createManualLodLevel( dDepth, sMeshName )
updateManualLodLevel( iIndex, sMeshName )
getNumLodLevels()
getLodIndex( dDepth )
getLodIndexSquaredDepth( dDepth )
getLodLevel( iIndex )
load()
unload()
reload()
setVertexBufferPolicy( dDetailLevel )
getVertexBufferPolicy()
setIndexBufferPolicy( bDisplay )
getIndexBufferPolicy()
buildTangentVectors( [ iSourceTexCoordSet, iDestTexCoordSet ] )
createAnimation( sName, dLength )
|
|
SubMesh
|
global |
|
|
|
| local |
type
materialName
isMaterialInitialized
|
addBoneAssignment( iBoneIndex, iVertexIndex, dWeight )
clearBoneAssignments()
compileBoneAssignments()
|
|
Plane
|
global |
|
|
|
| local |
type
normal
distance
|
getDistance( vPoint )
getSide( vPoint )
|
|
StaticGeometry
|
global |
|
|
|
| local |
type
name
squaredRenderingDistance
renderingDistance
renderQueueGroup
regionDimensions
origin
visible
castShadows
|
addEntity( oEntity
[[[, vPosition] , rOrientation ], vScale ] )
addSceneNode( oSceneNode )
build()
destroy()
reset()
|
|
Ground
|
global |
|
|
|
| local |
type
name
materialName
resourceGroupName
width
height
segmentsY
segmentsX
tileU
tileV
numTexCoordSets
normals
renderQueueGroup
visible
castShadows
hasPhysicalModel
physicalMaterial
collisionGeometryType
collisionGroup
collisionNotifyGroup
|
createPhysicalModel()
destroyPhysicalModel()
|
|
HardwareVertexBuffer
|
global |
|
|
|
| local |
type
isSystemMemory
hasShadowBuffer
isLocked
vertexSize
numVertices
sizeInBytes
bufferUsage
|
lock( dOptions [,iOffset, iLength ] )
unlock()
readData( iOffset, iLength )
writeData( iOffset, iLength, sData, bDiscard )
updateFromShadow()
suppressHardwareUpdate( bSuppress )
|
|
Compositor
|
| Class |
Scope |
Properties |
Methods |
Callbacks |
Compositor
|
global |
|
|
|
| local |
type
name
isManuallyLoaded
|
createTechnique()
getTechnique( iIndex )
getNumTechniques()
destroyTechnique( iIndex )
destroyAllTechniques()
getNumSupportedTechniques()
getSupportedTechnique( iIndex )
load()
unload()
reload()
|
|
CompositorInstance
|
global |
|
|
|
| local |
type
enabled
compositor
technique
chain
|
|
|
CompositorChain
|
global |
|
|
|
| local |
type
view
|
addCompositor( oCompositor )
getNumCompositors()
getCompositor( iIndex )
removeCompositor( iIndex )
removeAllCompositors()
setCompositorEnabled( sName ,bEnabled )
|
|
CompositionTechnique
|
global |
|
|
|
| local |
type
parentCompositor
|
createTextureDefinition( sName )
getNumTextureDefinitions()
getTextureDefinition( iIndex )
destroyTextureDefinition( iIndex )
destroyAllTextureDefinitions()
createTargetPass()
getNumTargetPasses()
getTargetPass( iIndex )
destroyTargetPass( iIndex )
destroyAllTargetPasses()
getOutputTargetPass()
isSupported( bSupported )
|
|
CompositionTargetPass
|
global |
|
|
|
| local |
type
inputMode
outputName
onlyInitial
visibilityMask
materialScheme
lodBias
parentTechnique
|
createPass()
getNumPasses()
getPass( iIndex )
destroyPass( iIndex )
destroyAllPasses()
|
|
CompositionPass
|
global |
|
|
|
| local |
type
passType
identifier
material
firstRenderQueue
lastRenderQueue
clearBuffers
clearColor
clearDepth
clearStencil
stencilCheck
stencilFunc
stencilRefValue
stencilMask
stencilFailOp
stencilDepthFailOp
stencilPassOp
stencilTwoSidedOperation
compositionTargetPassParent
numInputs
|
setInput( iID, sName )
getInput( iID )
clearAllInputs()
setMaterialName( sMaterialName )
|
|
CompositionTextureDefinition
|
global |
|
|
|
| local |
type
name
width
height
format
|
|
|
Materials
|
| Class |
Scope |
Properties |
Methods |
Callbacks |
Material
|
global |
|
|
|
| local |
type
name
isTransparent
transparencyCastsShadows
receiveShadows
isManuallyLoaded
|
compile()
createTechnique()
getNumTechniques()
getTechnique( iIndex )
destroyTechnique( iIndex )
getBestTechnique( iLodIndex )
getNumSupportedTechniques()
getSupportedTechnique( iIndex )
setCullingMode( dMode )
setManualCullingMode( dMode )
setDynamicLighting( bEnabled )
setShadingMode( dMode )
setDepthBias( dBias [, dBiasSlopeScale ])
setTextureFiltering( dMode )
setSceneBlendingType( dType )
setSceneBlendingFactor( dSourceFactor, dDestFactor )
setTextureAnisotropy( iMaxAniso )
setShininess( iShininesss )
setFog( bOverride, dMode, cColor, dDensity, dNear, dFar )
getNumLodLevels()
setLodLevels( aLODDistances )
getLodIndex( dDepth )
setAmbientColor( cColor )
setDiffuseColor( cColor )
setSpecularColor( cColor )
setEmissiveColor( cColor )
setDepthFunction( dFunc )
setDepthCheck( bEnabled )
setDepthWrite( bEnabled )
setColorWrite( bEnabled )
load()
unload()
reload()
|
|
Technique
|
global |
|
|
|
| local |
type
isTransparent
isDepthWriteEnabled
isDepthCheckEnabled
isLoaded
isSupported
resourceGroup
schemeName
|
createPass()
getNumPasses()
getPass( iIndex )
destroyPass( iIndex )
setCullingMode( dMode )
setManualCullingMode( dMode )
setDynamicLighting( bEnabled )
setShadingMode( dMode )
setDepthBias( dBias [,dBiasSlopeScale ])
setTextureFiltering( dMode )
setSceneBlendingType( dType )
setSceneBlendingFactor( dSourceFactor, dDestFactor )
setTextureAnisotropy( iMaxAniso )
setShininess( iShininesss )
setFog( bOverride, dMode, cColor, dDensity, dNear, dFar )
setLodIndex( iIndex )
getLodIndex()
setAmbientColor( cColor )
setDiffuseColor( cColor )
setSpecularColor( cColor )
setEmissiveColor( cColor )
setDepthFunction( dFunc )
setDepthCheck( bEnabled )
setDepthWrite( bEnabled )
setColorWrite( bEnabled )
|
|
Pass
|
global |
|
|
|
| local |
type
index
resourceGroup
isProgrammable
isTransparent
isLoaded
isAmbientOnly
hasVertexProgram
hasFragmentProgram
ambientColor
diffuseColor
specularColor
emissiveColor
vertexColorTracking
shadingMode
shininess
dynamicLighting
maxSimultaneousLights
depthBias
depthBiasSlopeScale
depthWriteEnabled
depthCheckEnabled
colorWriteEnabled
depthFunction
sceneBlend
cullingMode
manualCullingMode
alphaRejectFunction
alphaRejectValue
isIteratePerLight
isRunOnlyForOneLightType
onlyLightType
vertexProgramName
vertexProgramParameters
fragmentProgramName
fragmentProgramParameters
shadowCasterVertexProgramName
shadowCasterVertexProgramParameters
shadowReceiverVertexProgramName
shadowReceiverVertexProgramParameters
fogMode
fogColor
fogNear
fogFar
fogDensity
fogOverride
detailLevel
pointSize
pointSpritesEnabled
pointAttenuationEnabled
pointAttenuationConstant
pointAttenuationLinear
pointAttenuationQuadratic
pointSizeMin
pointSizeMax
|
createTexture( [ sName [, iTextCoordSet ]] )
addTexture( oTexture )
getNumTextures()
getTexture( iIndex )
destroyTexture( iIndex )
setTextureFiltering( dMode )
setTextureAnisotropy( iMaxAniso )
setSceneBlendingType( dType )
setSceneBlendingFactor( dSourceFactor, dDestFactor )
getSourceBlendFactor()
getDestBlendFactor()
setFog( bOverride, dMode, cColor, dDensity, dNear, dFar )
|
|
Texture
|
global |
|
|
|
| local |
type
name
nameAlias
isLoaded
isBlank
is3D
isCubic
isAlpha
currentFrame
numFrames
animationDuration
textureType
addressingModeU
addressingModeV
addressingModeW
textureAnisotropy
coordSet
hasRelativeCoordGeneration
borderColor
scrollU
scrollV
scaleU
scaleV
rotate
bindingType
numMipmaps
pixelFormat
|
setTextureName( sName [, dTextureType, iMipMaps ])
setCubicTextureName( sName, bForUVW )
setAnimatedTextureName( sName, iNumFrames, dDuration )
setColorOperationEx( dOperation, dSource1, dSource2, cColor1, cColor2, dManualBlend )
setColorOperation( dOperation )
setAlphaOperation( dOperation, dSource1, dSource2, dArg1, dArg2, dManualBlend )
setColorOpMultiPassFallback( dSourceFactor, dDestFactor )
getColorBlendFallbackSource()
getColorBlendFallbackDest()
setEnvironmentMap( dEnvMap, bEnable )
setScrollAnimation( dSpeedU, dSpeedV )
setRotateAnimation( dSpeed )
setTransformAnimation( dTransformType, dWaveType, dBase, dFreq, dPhase, dAmp )
setProjectiveTexturing( camCamera, bEnable )
setBlank()
setTextureFiltering( dTextureFilterOptions )
setTextureFilteringBasic( dFilterType, dFilterOptions )
setTextureFilteringAdvanced( dMinFilterOptions, dMagFilterOptions, dMipFilterOptions )
getAnimationDuration()
getNumFrames()
getFrameTextureName( iFrameNum )
getTextureWidth( iFrameNum )
getTextureHeight( iFrameNum )
|
|
GPUProgramParams
|
global |
|
|
|
| local |
type
hasRealConstantParams
hasIntConstantParams
hasAutoConstants
|
setConstantVector4( iIndex, aValues )
setConstantVector3( iIndex, aValues )
setConstantMatrix4( iIndex, aValues )
setConstantFloat( iIndex, aValues )
setConstantDouble( iIndex, aValues )
setConstantInt( iIndex, aValues )
setConstantColor( iIndex, cValue )
setAutoConstant( iIndex, iType )
setAutoConstantReal( iIndex, iType, dExtraIndo )
setConstantFromTime( iIndex, dTime )
setNamedConstantVector4( sName, aValues )
setNamedConstantVector3( sName, aValues )
setNamedConstantMatrix4( sName, aValues )
setNamedConstantFloat( sName, aValues )
setNamedConstantDouble( sName, aValues )
setNamedConstantInt( sName, aValues )
setNamedConstantColor( sName, cValue )
setNamedAutoConstant( sName, iType )
setNamedConstantFromTime( sName, dTime )
setAutoAddParamName( bAutoAdd )
resetRealConstants()
resetIntConstants()
getRealConstantCount()
getIntConstantCount()
clearAutoConstants()
getParamIndex( sName )
copyConstantsFrom( oGPUParam )
|
|
RenderTexture
|
global |
|
|
|
| local |
type
name
width
height
active
autoUpdate
colorDepth
|
createView( sName, iZOrder )
getView( iIndex )
getViewCount()
deleteView( iIndex )
update()
addListener( oObject )
removeListener( oObject )
|
onPreRenderTargetUpdate()
onPostRenderTargetUpdate()
onPreViewUpdate( oView )
onPostViewUpdate( oView )
|
HTMLMaterial
|
global |
|
|
|
| local |
type
materialName
updateFactor
staticImage
|
setURLHTML( sURLHTML )
getURLHTML()
forceUpdate()
sendJS( sJavaScript )
sendMouseClick(iButton, iXPos, iYPos [,bDoubleCLick] )
setFocus( bFocus )
|
|
VideoMaterial
|
global |
|
|
|
| local |
type
materialName
volume
balance
duration
elapsedTime
isPlaying
isPaused
loopCount
numLoops
|
play()
pause()
rewind()
stop()
|
|
Overlays
|
| Class |
Scope |
Properties |
Methods |
Callbacks |
Overlay
|
global |
|
|
|
| local |
type
name
zOrder
visible
rotate
scrollX
scrollY
scaleX
scaleY
worldSpacePosition
worldSpaceOrientation
|
getChild( sName )
clear()
findElementAt( iPosX, iPosY )
add2D( oOverlayElement )
remove2D( oOverlayElement )
add3D( oSceneNode )
remove3D( oSceneNode )
createOverlayPanelElement( sName )
createOverlayBorderPanelElement( sName )
createOverlayTextAreaElement( sName )
getOverlayElement( sName )
destroyOverlayElement( sName )
destroyAllOverlayElements( sName )
|
|
OverlayPanelElement
|
global |
|
|
|
| local |
type
name
textureUV
transparent
visible
enabled
width
height
top
left
materialName
material
isContainer
caption
color
metricsMode
horizontalAlignment
verticalAlignment
parent
worldSpacePosition
worldSpaceOrientation
|
addChild( oOverlayElement )
getChild( sName )
removeChild( oOverlayElement )
contains( iPosX, iPosY )
getZOrder()
findElementAt( iPosX, iPosY )
setTileX( iTileX [, iLayer ] )
setTileY( iTileY [, iLayer ] )
getTileX( [ iLayer ] )
getTileY( [ iLayer ] )
|
|
OverlayBorderPanelElement
|
global |
|
|
|
| local |
type
name
leftBorderSize
rightBorderSize
topBorderSize
bottomBorderSize
leftBorderUV
rightBorderUV
topBorderUV
bottomBorderUV
topLeftBorderUV
topRightBorderUV
bottomLeftBorderUV
bottomRightBorderUV
textureUV
transparent
visible
enabled
width
height
top
left
borderMaterialName
materialName
material
isContainer
caption
color
metricsMode
horizontalAlignment
verticalAlignment
parent
worldSpacePosition
worldSpaceOrientation
|
addChild( oOverlayElement )
getChild( sName )
removeChild( oOverlayElement )
contains( iPosX, iPosY )
getZOrder()
findElementAt( iPosX, iPosY )
setTileX( iTileX [, iLayer ] )
setTileY( iTileY [, iLayer ] )
getTileX( [ iLayer ] )
getTileY( [ iLayer ] )
|
|
OverlayTextAreaElement
|
global |
|
|
|
| local |
type
name
charHeight
spaceWidth
fontName
colorBottom
colorTop
color
visible
enabled
width
height
top
left
materialName
material
isContainer
caption
metricsMode
horizontalAlignment
verticalAlignment
textAlignment
parent
worldSpacePosition
worldSpaceOrientation
|
contains( iPosX, iPosY )
getZOrder()
findElementAt( iPosX, iPosY )
|
|
Animation
|
| Class |
Scope |
Properties |
Methods |
Callbacks |
Animation
|
global |
|
|
|
| local |
type
name
length
interpolationMode
rotationInterpolationMode
|
createAnimationTrack( iIndex )
createVertexAnimationTrack( iIndex, dAnimationType )
getNumAnimationTracks()
getAnimationTrack( iIndex )
destroyAnimationTrack( iIndex )
apply( dTimePos, dWeight, bAccumulate )
applyToSkeleton( oSkeleton, dTimePos, dWeight, bAccumulate )
|
|
AnimationState
|
global |
|
|
|
| local |
type
name
length
timePosition
weight
enabled
loop
|
addTime( dTimePos, dWeight, bAccumulate )
notifyDirty()
|
|
AnimationTrack
|
global |
|
|
|
| local |
type
associatedNode
useShortestRotationPath
|
createKeyFrame( dTimePos )
getKeyFrame( iIndex )
getNumKeyFrames()
destroyKeyFrame( iIndex )
apply( dTimePos, dWeight, bAccumulate )
applyToNode( oSceneNode, dTimePos, dWeight, bAccumulate )
|
|
VertexAnimationTrack
|
global |
|
|
|
| local |
type
animationType
targetMode
hasNonZeroKeyFrames
|
createKeyFrame( dTimePos )
getKeyFrame( iIndex )
getNumKeyFrames()
destroyKeyFrame( iIndex )
apply( dTimePos, dWeight, bAccumulate )
optimize()
createVertexMorphKeyFrame( dTimePos )
getVertexMorphKeyFrame( iIndex )
createVertexPoseKeyFrame( dTimePos )
getVertexPoseKeyFrame( iIndex )
|
|
KeyFrame
|
global |
|
|
|
| local |
type
time
translate
rotation
scale
|
|
|
VertexMorphKeyFrame
|
global |
|
|
|
| local |
type
time
vertexBuffer
|
|
|
VertexPoseKeyFrame
|
global |
|
|
|
| local |
type
time
|
addPoseReference( iPoseIndex, dInfluence )
updatePoseReference( iPoseIndex, dInfluence )
removePoseReference( iIndex )
removeAllPoseReferences()
getNumPoseReferences()
getPoseReference( iIndex )
|
|
Skeleton
|
global |
|
|
|
| local |
type
name
isLoaded
isManuallyLoaded
isMaster
blendMode
hasPhysics
active
inertiaTensor
dynamicFriction
staticFriction
restitution
|
createRootBone( sName )
getNumBones()
getRootBone()
getBone( iIndex )
getBoneByName( sName )
createAnimation( sName, iLength )
removeAnimation( sName )
getAnimation( iIndex )
getAnimationByName( sName )
getNumAnimations()
optimizeAllAnimations()
setBindingPose()
reset( bResetManualBones )
reload()
load()
unload()
|
|
Bone
|
global |
|
|
|
| local |
type
name
position
transform
orientation
worldSpacePosition
worldSpaceOrientation
worldSpaceTransform
initialPosition
initialTransform
initialOrientation
initialScale
parentBone
scale
inheritScale
manuallyControlled
|
yaw( dAngle, dTransformType )
pitch( dAngle, dTransformType )
roll( dAngle, dTransformType )
rotate( rRotation, dTransformType )
translate( vVector, dTransformType )
createChildBone( iHandle )
createChildBoneByName( sName )
getHandle()
setBindingPose()
reset()
getTechnique()
getMaterial()
setInitialState()
resetToInitialState()
|
|
TagPoint
|
global |
|
|
|
| local |
type
name
position
transform
orientation
worldSpacePosition
worldSpaceOrientation
worldSpaceTransform
initialPosition
initialTransform
initialOrientation
initialScale
parentNode
parentEntity*
scale
inheritScale
manuallyControlled
|
setChildObject( oMovableObject )*
yaw( dAngle, dTransformType )
pitch( dAngle, dTransformType )
roll( dAngle, dTransformType )
rotate( rRotation, dTransformType )
translate( vVector, dTransformType )
createChildBone( iHandle )
getHandle()
setBindingPose()
reset()
getTechnique()
getMaterial()
setInitialState()
resetToInitialState()
|
|
Graphical User Interface
|
| Class |
Scope |
Properties |
Methods |
Callbacks |
GUISystem
|
global |
GUISystem
|
|
|
| local |
type
defaultFont
defaultGUILook*
rootWindow*
singleClickTimeout
multiClickTimeout
multiClickAreaHeight
multiClickAreaWidth
defaultMouseCursor
mouseMoveScaling
hideMouse
useApplicationMouse
|
createRootWindow( sName )*
createFrameWindow( sName )
createButton( sName )
createCheckBox( sName )
createRadioButton( sName )
createProgressBar( sName )
createProgressBarAlt( sName )
createSlider( sName )
createEditBox( sName )
createMultiLineEditBox( sName )
createListBox( sName )
createStaticText( sName )
createStaticImage( sName )
createComboBox( sName )
createListBoxTextItem( sText )
createGUIFont( sName )
createGUIFontFromTTF( sName, sTTFFIleName)
createGUIRect( sName )
createGUIColorRect( sName )
getWindow( sName )
getWindowContainingMouse()
isWindowPresent( sName )
addChildWindow( oGUIWindow )
removeChildWindow( sName )
destroyWindow( sName )
destroyAllWindows()
loadWindowLayout( sName, sPrefix [, sResourceGroupName ] )
loadScheme( sName [, sResourceGroupName ] )
isSchemePresent( sName )
unloadScheme( sName )
unloadAllSchemes()
createImageSetFromFile( sFileName [, sResourceGroupName ] )
createImageSetFromTexture( sName oGUITexture )
getImageSet( sName )
isImageSetPresent( sName )
destroyImageSet( sName )
destroyAllImageSets()
createTexture( sName [, sResourceGroupName ] )
destroyTexture( oGUITexture )
destroyAllTextures()
|
|
GUI Window (All windows inherit these properties and methods)
|
global |
|
|
|
| local |
type
name
alwaysOnTop
enabled
visible
active
text
zOrdering
clippedByParent
parent
alpha
inheritAlpha
effectiveAlpha
rect
positionX
positionY
width
height
minWidth
minHeight
maxWidth
maxHeight
mouseCursor
autoRepeatDelay
wantsMultiClickEvents
mouseAutoRepeat
innerRect
unclippedRect
unclippedInnerRect
|
isAncestor( sName )
isChild( sName )
isHit( dPosX, dPosY )
getNumChildren()
getChild( iIndex )
getChildByName( sName )
getChildAtPosition( dPosX, dPosY )
getActiveChild()
moveToFront()
moveToBack()
addChildWindow( oGUIWindow )
removeChildWindow( sName )
addListener( dListenerType )
removeListener( dListenerType )
|
|
FrameWindow
|
global |
|
|
|
| local |
type
sizingEnabled
frameEnabled
titleBarEnabled
closeButtonEnabled
rollupEnabled
rollup
sizingBorderThickness
titlebarFont
captionColor
|
|
|
Button
|
global |
|
|
|
| local |
type
isHovering
isPushed
|
|
|
ComboBox
|
global |
|
|
|
| local |
type
hasInputFocus
isTextValid
dropList
singleClickEnabled
readOnly
normalTextColor
selectedTextColor
normalSelectBrushColor
inactiveSelectBrushColor
validationString
caratIndex
selectionStartIndex
selectionEndIndex
maxTextLength
sortingEnabled
vertScrollbarAlwaysShown
horizScrollbarAlwaysShown
|
getSelectionLength()
getItemCount()
getItem( iIndex )
getItemIndex( oTextItem )
isItemSelected( iIndex )
search( sText [,oTextItem ] )
setItemSelectState( iIndex, bState )
update()
resetList()
addItem( oTextItem )
insertItem( oInsertTextItem, oAfterTextItem )
removeItem( oTextItem )
clearAllSelections()
|
|
CheckBox
|
global |
|
|
|
| local |
type
isHovering
isPushed
selected
|
|
|
EditBox
|
global |
|
|
|
| local |
type
hasInputFocus
isTextValid
readOnly
textMasked
validationString
caratIndex
selectionStartIndex
selectionEndIndex
maskCodePoint
maxTextLength
|
getSelectionLength()
|
|
ListBox
|
global |
|
|
|
| local |
type
sortingEnabled
multiSelectEnabled
vertScrollbarAlwaysShown
horizScrollbarAlwaysShown
|
getItemCount()
getSelectedCount()
getFirstSelectedItem()
getNextSelectedItem( oTextItem )
getItem( iIndex )
getItemIndex( oTextItem )
isItemSelected( iIndex )
search( sText [,oTextItem ] )
isItemInList( oTextItem )
setItemSelectState( iIndex, bState )
update()
ensureItemIsVisible( oTextItem )
resetList()
addItem( oTextItem )
insertItem( oInsertTextItem, oAfterTextItem )
removeItem( oTextItem )
clearAllSelections()
|
|
MultiLineEditBox
|
global |
|
|
|
| local |
type
hasInputFocus
readOnly
caratIndex
selectionStartIndex
selectionEndIndex
maxTextLength
wordWrap
|
getSelectionLength()
makeCaratVisible()
|
|
ProgressBar
|
global |
|
|
|
| local |
type
stepSize
progress
|
step()
adjustProgress( dDelta )
|
|
RadioButton
|
global |
|
|
|
| local |
type
isHovering
isPushed
selected
groupID
|
|
|
Slider
|
global |
|
|
|
| local |
type
currentValue
clickStep
maxValue
|
|
|
StaticImage
|
global |
|
|
|
| local |
type
image
horizFormatting
vertFormatting
frameEnabled
backgroundEnabled
imageColors
frameColors
backgroundColors
backgroundImage
|
|
|
StaticText
|
global |
|
|
|
| local |
type
horizFormatting
vertFormatting
vertScrollbarEnabled
horizScrollbarEnabled
frameEnabled
backgroundEnabled
textColors
frameColors
backgroundColors
backgroundImage
|
|
|
ListBoxTextItem
|
global |
|
|
|
| local |
type
text
font
textColors
selected
disabled
autoDeleted
ownerWindow
selectColors
selectBrushImage
pixelWidth
pixelHeight
|
|
|
GUIRect
|
global |
|
|
|
| local |
type
positionX
positionY
width
height
|
getIntersection( oGUIRect )
offset( dPosX, dPosY )
isPointInRect( dPosX, dPosY )
constrainSizeMax( dHeight, dWidth )
constrainSizeMin( dHeight, dWidth )
|
|
GUIURect
|
global |
|
|
|
| local |
type
position
size
width
height
|
|
|
GUIUDim
|
global |
|
GUIUDim( dRel, dAbs )
|
|
| local |
type
absolute
relative
|
change( iIndex, guvValue )
add( gudDim )
same( gudDim )
subtract( gudDim )
scale( gudDim )
toString()
|
|
GUIUVector
|
global |
|
GUIUVector( gudX, gudY )
|
|
| local |
type
x
y
|
change( iIndex, gudValue )
add( guvVector )
same( guvVector )
subtract( guvVector )
scale( guvVector )
toString()
|
|
GUIColorRect
|
global |
|
|
|
| local |
type
colorTopLeft
colorTopRight
colorBottomLeft
colorBottomRight
|
setColors( oColor )
setTopAlpha( dAlpha )
setBottomAlpha( dAlpha, )
setLeftAlpha( dAlpha )
setRightAlpha( dAlpha, )
getSubRectangle( dLeft, dRight, dTop, dBottom )
getColorAtPoint( dPosX, dPosY )
|
|
GUITexture
|
global |
|
|
|
| local |
type
width
height
|
loadFromFile( sFileName [, sResourceGroupName ] )
|
|
GUIImageSet
|
global |
|
|
|
| local |
type
name
autoScaled
nativeResolutionWidth
nativeResolutionHeight
|
getImageCount()
getImage( sName )
isImageDefined( sName )
undefineImage( sName )
undefineAllImages()
defineImage( sName, oGUIRect, dPosX, dPosY )
getImageHeight( sName )
getImageWidth( sName )
getImageOffsetX( sName )
getImageOffsetY( sName )
|
|
GUIImage
|
global |
|
|
|
| local |
type
name
imagesetName
width
height
offsetX
offsetY
|
|
|
GUIFont
|
global |
|
|
|
| local |
type
name
autoScaling
nativeResolutionWidth
nativeResolutionHeight
pointSize
antiAliased
|
getTextExtent( sText [, dScale] )
getLineSpacing( [dScale] )
getFontHeight( [dScale] )
getBaseline( [dScale] )
getCharAtPixel( sText ,dPixel [, dScale] )
getCharAtPixelFrom( sText ,iStartChar ,dPixel [, dScale] )
isCodePointAvailable( iCodePoint )
getFormattedLineCount( sText ,oGUIRect ,dFormating [, dScale] )
getFormattedTextExtent( sText ,oGUIRect ,dFormating [, dScale] )
|
|
Physics
|
| Class |
Scope |
Properties |
Methods |
Callbacks |
PhysicsSystem
|
global |
PhysicsSystem
|
|
|
| local |
type
skinWidth
gravity
distanceScale
sleepLinearVelocitySquared
sleepAngularVelocitySquared
maxAngularVelocity
bounceThreshold
dynamicFrictionScaling
staticFrictionScaling
ccd
ccdEpsilon
adaptiveForce
filterJointedObjects
sensorCallbacks
solverConvergence
hardwareBroadPhase
visualDebugGroup
visualDebugScale
hasHardware
usingHardware
maxTimestep
maxIterations
|
createPhysicalMaterial( sName )
destroyPhysicalMaterial( sName )
getPhysicalMaterialByName( sName )
getPhysicalMaterial( iMaterialIndex )
getNumPhysicalMaterials()
setGroupCollision( iCollisionGroup1, iCollisionGroup2, bEnable )
getGroupCollision( iCollisionGroup1, iCollisionGroup2 )
setGroupCollisionNotify( iNotifyGroup1, iNotifyGroup2, iNotifyOption )
getGroupCollisionNotify( iNotifyGroup1, iNotifyGroup2 )
setCollisionNotify( oObject1, oObject2, iNotifyOption )
getCollisionNotify( oObject1, nObject2 )
setVisualDebugType( iDebugType, bEnable )
getVisualDebugType( iDebugType )
createCapsuleSensor( sName [, vPosition[, rRotation ]] )
createBoxSensor( sName [, vPosition[, rRotation ]] )
createSphereSensor( sName [, vPosition[, rRotation ]] )
destroySensor( sName )
getSensor( sName )
createBallJoint( sName oObject1, oObject2, vPosition, vAxis )
createHingeJoint( sName oObject1, oObject2, vPosition, vAxis )
createFixedJoint( sName oObject1, oObject2 )
createDistanceJoint( sName oObject1, oObject2, vPosition, vPosition2, vAxis )
createSlidingJoint( sName oObject1, oObject2, vPosition, vAxis )
createPrismaticJoint( sName oObject1, oObject2, vPosition, vAxis )
createPlaneJoint( sName oObject1, oObject2, vPosition, vAxis )
createLineJoint( sName oObject1, oObject2, vPosition, vAxis )
createMultiJoint( sName oObject1, oObject2, vPosition, vAxis )
createPulleyJoint( sName oObject1, oObject2, vPosition, vAxis )
destroyJoint( sName )
getJoint( sName )
addListener( oObject [, oFilterObject1
[, oFilterObject2 ]] )
removeListener( oObject )
|
onCollision( oObject1, oObject2, vSumFrictionForce, vSumNormalForce, nNotifyType [, oWheelContact ] )
onEnter( oSensor, oObject )
onExit( oSensor, oObject )
onStay( oSensor, oObject )
onBrokenJoint( oJoint, oObject1, oObject2, nForce )
|
PhysicalMaterial
|
global |
|
|
|
| local |
type
index
dirOfAnisotropy
dynamicFriction
staticFriction
dynamicFrictionV
staticFrictionV
frictionCombineMode
anisotropicFriction
friction
strongFriction
restitution
restitutionCombineMode
|
|
|
PhysicalWheel
|
global |
|
|
|
| local |
type
suspensionSpring
suspensionDamper
suspensionTargetValue
longExtremumSlip
latExtremumSlip
longExtemumValue
latExtemumValue
longAsymptoteSlip
latAsymptoteSlip
longAsymptoteValue
latAsymptoteValue
longStiffnessFactor
latStiffnessFactor
longInputSlipVelocity
latInputSlipVelocity
axisContactNormal
unscaledSpringBehavior
axleSpeedOverride
suspensionTravel
inverseWheelMass
motorTorque
brakeTorque
steerAngle
axleSpeed
|
|
|
PhysicalWheelContact
|
global |
|
|
|
| local |
type
contactPoint
contactNormal
contactForce
physicalMaterial
longDirection
longSlip
longImpulse
latDirection
latSlip
latImpulse
|
|
|
CapsuleSensor
|
global |
|
|
|
| local |
type
name
active
worldSpacePosition
worldSpaceOrientation
worldSpaceTransform
radius
height
triggerOnEnter
triggerOnExit
triggerOnStay
|
|
onEnter( oSensor, oObject )
onExit( oSensor, oObject )
onStay( oSensor, oObject )
|
BoxSensor
|
global |
|
|
|
| local |
type
active
name
worldSpacePosition
worldSpaceOrientation
worldSpaceTransform
width
height
depth
triggerOnEnter
triggerOnExit
triggerOnStay
|
|
onEnter( oSensor, oObject )
onExit( oSensor, oObject )
onStay( oSensor, oObject )
|
SphereSensor
|
global |
|
|
|
| local |
type
active
name
worldSpacePosition
worldSpaceOrientation
worldSpaceTransform
radius
triggerOnEnter
triggerOnExit
triggerOnStay
|
|
onEnter( oSensor, oObject )
onExit( oSensor, oObject )
onStay( oSensor, oObject )
|
BallJoint
|
global |
|
|
|
| local |
type
name
isBroken
blockInteractions
linearBreakThreshold
angularBreakThreshold
object1
object2
worldSpacePosition
axis
projectionMode
projectionDistance
swingAxis
twistLimitEnabled
swingLimitEnabled
twistSpringEnabled
swingSpringEnabled
jointSpringEnabled
jointSpringCoefficient
jointSpringDamper
jointSpringTargetValue
twistSpringCoefficient
twistSpringDamper
twistSpringTargetValue
swingSpringCoefficient
swingSpringDamper
swingSpringTargetValue
twistLimitLowValue
twistLimitLowRestitution
twistLimitLowHardness
twistLimitHighValue
twistLimitHighRestitution
twistLimitHighHardness
swingLimitValue
swingLimitRestitution
swingLimitHardness
userData
|
addLimitPlane( vNormal, vPointInPlane )
deleteAllLimitPlanes()
setLimitPoint( vPosition, bOnActor2 )
getLimitPoint()
|
|
HingeJoint
|
global |
|
|
|
| local |
type
name
isBroken
blockInteractions
linearBreakThreshold
angularBreakThreshold
object1
object2
worldSpacePosition
axis
projectionMode
projectionDistance
projectionAngle
hingeAngle
angularVelocity
limitsEnabled
motorEnabled
springEnabled
highLimitValue
highLimitRestitution
highLimitHardness
lowLimitValue
lowLimitRestitution
lowLimitHardness
motorVelocityTarget
motorMaxForce
motorFreeSpin
springCoefficient
springDamper
springTargetValue
userData
|
addLimitPlane( vNormal, vPointInPlane )
deleteAllLimitPlanes()
setLimitPoint( vPosition, bOnActor2 )
getLimitPoint()
|
|
FixedJoint
|
global |
|
|
|
| local |
type
name
isBroken
blockInteractions
linearBreakThreshold
angularBreakThreshold
object1
object2
userData
|
addLimitPlane( vNormal, vPointInPlane )
deleteAllLimitPlanes()
setLimitPoint( vPosition, bOnActor2 )
getLimitPoint()
|
|
DistanceJoint
|
global |
|
|
|
| local |
type
name
isBroken
blockInteractions
linearBreakThreshold
angularBreakThreshold
object1
object2
axis
position1
position2
maxDistanceEnabled
minDistanceEnabled
springEnabled
maxDistance
minDistance
springCoefficient
springDamper
springTargetValue
userData
|
addLimitPlane( vNormal, vPointInPlane )
deleteAllLimitPlanes()
setLimitPoint( vPosition, bOnActor2 )
getLimitPoint()
|
|
SlidingJoint
|
global |
|
|
|
| local |
type
name
isBroken
blockInteractions
linearBreakThreshold
angularBreakThreshold
object1
object2
axis
worldSpacePosition
userData
|
addLimitPlane( vNormal, vPointInPlane )
deleteAllLimitPlanes()
setLimitPoint( vPosition, bOnActor2 )
getLimitPoint()
|
|
PrismaticJoint
|
global |
|
|
|
| local |
type
name
isBroken
blockInteractions
linearBreakThreshold
angularBreakThreshold
object1
object2
worldSpacePosition
axis
userData
|
addLimitPlane( vNormal, vPointInPlane )
deleteAllLimitPlanes()
setLimitPoint( vPosition, bOnActor2 )
getLimitPoint()
|
|
PlaneJoint
|
global |
|
|
|
| local |
type
name
isBroken
blockInteractions
linearBreakThreshold
angularBreakThreshold
object1
object2
worldSpacePosition
axis
userData
|
addLimitPlane( vNormal, vPointInPlane )
deleteAllLimitPlanes()
setLimitPoint( vPosition, bOnActor2 )
getLimitPoint()
|
|
LineJoint
|
global |
|
|
|
| local |
type
name
isBroken
blockInteractions
linearBreakThreshold
angularBreakThreshold
object1
object2
worldSpacePosition
axis
userData
|
addLimitPlane( vNormal, vPointInPlane )
deleteAllLimitPlanes()
setLimitPoint( vPosition, bOnActor2 )
getLimitPoint()
|
|
PulleyJoint
|
global |
|
|
|
| local |
type
name
isBroken
blockInteractions
linearBreakThreshold
angularBreakThreshold
object1
object2
position1
position2
pulleyPosition1
pulleyPosition2
axis
rigid
distance
ratio
stiffness
motorEnabled
motorVelocityTarget
motorMaxForce
motorFreeSpin
userData
|
addLimitPlane( vNormal, vPointInPlane )
deleteAllLimitPlanes()
setLimitPoint( vPosition, bOnActor2 )
getLimitPoint()
|
|
MultiJoint
|
global |
|
|
|
| local |
type
name
isBroken
blockInteractions
linearBreakThreshold
angularBreakThreshold
object1
object2
worldSpacePosition
axis
projectionMode
projectionDistance
projectionAngle
driveAngularVelocity
driveLinearVelocity
driveOrientation
drivePosition
gearEnabled
gearRatio
linearLimitValue
linearLimitRestitution
linearLimitSpring
linearLimitDamping
slerpDriveEnabled
slerpDriveType
slerpDriveSpring
slerpDriveDamping
slerpDriveForceLimit
swing1Motion
swing1LimitValue
swing1LimitRestitution
swing1LimitSpring
swing1LimitDamping
swing2Motion
swing2LimitValue
swing2LimitRestitution
swing2LimitSpring
swing2LimitDamping
swingDriveType
swingDriveSpring
swingDriveDamping
swingDriveForceLimit
twistDriveType
twistDriveSpring
twistDriveDamping
twistDriveForceLimit
twistMotion
twistLimitLowValue
twistLimitLowRestitution
twistLimitLowSpring
twistLimitLowDamping
twistLimitHighValue
twistLimitHighRestitution
twistLimitHighSpring
twistLimitHighDamping
axisMotion
axisDriveType
axisDriveSpring
axisDriveDamping
axisDriveForceLimit
perpMotion
perpDriveType
perpDriveSpring
perpDriveDamping
perpDriveForceLimit
crossMotion
crossDriveType
crossDriveSpring
crossDriveDamping
crossDriveForceLimit
userData
|
addLimitPlane( vNormal, vPointInPlane )
deleteAllLimitPlanes()
setLimitPoint( vPosition, bOnActor2 )
getLimitPoint()
|
|
Networking, MultiPlayer and XML
|
| Class |
Scope |
Properties |
Methods |
Callbacks |
MultiPlayer
|
global |
MultiPlayer
|
|
|
| local |
type
numPlayers
remoteAvatars
updateFreq
hideAvatarDistance
chatMuteDistance
roomRollover
showNameTag
nameTagColor
nameTagFont
nameTagFontSize
|
addPlayer( sPlayerID, sPlayerName )
deletePlayer( sPlayerID )
chatReceived( sPlayerID, sChatMsg, sChatPrefix, cColor )
changeNickname( sPlayerID, sPlayerName )
changeAvatar( sPlayerID, sAvatarURL )
changePosition( sPlayerID, vPosition, rRotation )
getPlayerID( iIndex )
getNickname( sPlayerID )
getSceneNode( sPlayerID )
setUserData( sPlayerID, oObject )
getUserData( sPlayerID )
showBoundingBox( sPlayerID, bShow )
showBoundingBoxAll( bShow )
getShowBoundingBox( sPlayerID )
setVisible( sPlayerID, bShow )
setVisibleAll( bShow )
getVisible( sPlayerID )
setSharedObjectProperty( sSharedObjectName, sPropertyName, sValue )
getSharedObjectProperty( sSharedObjectName, sPropertyName )
triggerSharedObjectPropertyChange( sSharedObjectName, sPropertyName, sValue )
dumpSharedObject( [sSharedObjectName] )
addListener( oObject )
removeListener( oObject )
|
onJoin( sPlayerID, sNickname )
onLeave( sPlayerID, sNickname )
onNicknameChange( sPlayerID, sNewNickname )
onAvatarChange( sPlayerID, sNewAvatarURL )
onMove( sPlayerID, vPosition, rRotation )
onChatSent( sChatMsg )
onChatReceived( sPlayerID, sChatMsg )
onSharedObjectChange( sSharedObjectName, sPropertyName, sValue )
|
Socket
|
global |
|
|
|
| local |
type
isConnected
bytesAvailable
debug
|
connect( sAddress, iPort )
close()
send( sData )
receive()
addListener( oObject )
removeListener( oObject )
|
onConnect()
onClose()
onError( sErrorMsg )
onDataReceived( iBytesReceived )
onDataSent()
onSendProgress( iBytesToBeSent, iBytesSent )
|
XMLSocket
|
global |
|
|
|
| local |
type
isConnected
sendZeroByte
debug
|
connect( sAddress, iPort )
close()
send( sData | oXML )
addListener( oObject )
removeListener( oObject )
|
onConnect()
onClose()
onError( sErrorMsg )
onDataReceived( sData )
onXMLDataReceived( oXML )
onDataSent()
onSendProgress( iBytesToBeSent, iBytesSent )
|
XMPP
|
global |
|
|
|
| local |
type
groupChatServiceName
roomName
serverName
maxOcupants
roomRollover
chatHistory
isConnected
isRoomCreated
isCollaborationService
didUserCreateRoom
debug
sendZeroByte
nickname
password
email
defaultLanguage
|
connect( sAddress, iPort )
close()
sendMessage( iType, sTo, sBody [, ,sSubject ] )
sendPresence( iType, sTo [, ,sStatus ] )
sendXMLStanza( oXML )
sendRawStanza( sStanza )
escape( sString )
unescape( sString )
addListener( oObject )
removeListener( oObject )
|
onConnect()
onClose()
onError( sErrorMsg )
onXMLParse( iParseType, sElement, sAttribute, sValue )
|
XML
|
global |
|
|
|
| local |
type
name
hasChildNodes
childNodes
rootNode
hasAttributes
firstChild
lastChild
nextSibling
previousSibling
nodeType
nodeValue
encoding
standAlone
version
documentURI
|
createElement( sName )
createTextNode( sValue )
createCDATASection( sValue )
createComment( sValue )
appendChild( oXMLNode )
insertBefore( oNewXMLNode, oRefXMLNode )
removeNode( oXMLNode )
setAttribute( sName, sValue )
getAttribute( sName )
getElementsByTagName( sTagName )
parseXML( sXML )
toString()
|
|
XMLNode
|
global |
|
|
|
| local |
type
name
hasChildNodes
childNodes
parentNode
hasAttributes
firstChild
lastChild
nextSibling
previousSibling
nodeType
nodeValue
|
appendChild( oXMLNode )
insertBefore( oNewXMLNode, oRefXMLNode )
removeNode( oXMLNode )
cloneNode( [bDeep] )
setAttribute( sName, sValue )
getAttribute( sName )
removeAttribute( sName )
getElementsByTagName( sTagName )
toString()
|
|