Lua Scripting API Reference Guide

143 Pages·2016·0.79 MB·English

by  Texas Instruments Incorporated

Lua Scripting API Reference Guide
ThisreferenceguideappliestoTI-Nspire™softwareversion4.2.Toobtainthelatestversionofthedocumentation,goto
education.ti.com/nspire/scripting.
Important Information
ExceptasotherwiseexpresslystatedintheLicensethataccompaniesaprogram,TexasInstrumentsmakesnowarranty,either
expressorimplied,includingbutnotlimitedtoanyimpliedwarrantiesofmerchantabilityandfitnessforaparticularpurpose,
regardinganyprogramsorbookmaterialsandmakessuchmaterialsavailablesolelyonan"as-is"basis.Innoeventshall
TexasInstrumentsbeliabletoanyoneforspecial,collateral,incidental,orconsequentialdamagesinconnectionwithorarising
outofthepurchaseoruseofthesematerials,andthesoleandexclusiveliabilityofTexasInstruments,regardlessoftheform
ofaction,shallnotexceedtheamountsetforthinthelicensefortheprogram.Moreover,TexasInstrumentsshallnotbeliable
foranyclaimofanykindwhatsoeveragainsttheuseofthesematerialsbyanyotherparty.
©2011-2016TexasInstrumentsIncorporated
Allrightsreserved
Trademarksandcopyrights
TheTI-Nspire™softwareusesLuaasscriptingenvironment.Forcopyrightandlicenseinformation,see
http://www.lua.org/license.html.
TheTI-Nspire™softwareusesChipmunkPhysicsversion5.3.4assimulationenvironment.Forlicenseinformation,see
http://chipmunk-physics.net/release/Chipmunk-5.x/Chipmunk-5.3.4-Docs/.
Microsoft®andWindows®areregisteredtrademarksofMicrosoftCorporationintheUnitedStatesand/orothercountries.
MacOS®,iPad®andOSX®areregisteredtrademarksofAppleInc.
Unicode®isaregisteredtrademarkofUnicode,Inc.intheUnitedStatesandothercountries.
Bluetooth®wordmarkandlogosareregisteredtrademarkownedbyBluetoothSIG,Inc.
i
Contents
Chapter1Standard Libraries 1
1.1BasicLibraryFunctions 1
1.1.1CoroutineSub-Library 1
1.2ModuleLibrary 1
1.3StringLibrary 1
1.4TableLibrary 2
1.5MathLibrary 2
1.6UnimplementedLibrariesandFunctions 2
Chapter2Touch Library 3
2.1Overview 3
2.1.1On-ScreenKeyboardandScreenResizeBehavior 3
2.1.2EventHandling 3
2.2LibraryFunctions 4
2.2.1ppi 4
2.2.2xppi 4
2.2.3yppi 4
2.2.4enabled 4
2.2.5isKeyboardAvailable 5
2.2.6isKeyboardVisible 5
2.2.7showKeyboard 5
Chapter32DEditorLibrary 6
3.1newRichText 6
3.2createChemBox 6
3.3createMathBox 7
3.4getExpression 7
3.5getExpressionSelection 7
3.6getText 7
3.7hasFocus 8
3.8isVisible 8
3.9move 8
3.10registerFilter 8
3.11resize 9
3.12setBorder 9
3.13setBorderColor 9
3.14setColorable 9
3.15setDisable2DinRT 9
3.16setExpression 9
3.17setFocus 10
3.18setFontSize 10
3.19setMainFont 10
3.20setReadOnly 11
3.21setSelectable 11
3.22setSizeChangeListener 11
ii
3.23setText 11
3.24setTextChangeListener 12
3.25setTextColor 12
3.26setVisible 12
3.27setWordWrapWidth 12
Chapter4Class Library 13
4.1class 13
Chapter5Clipboard Library 14
5.1addText 14
5.2getText 14
Chapter6CursorLibrary 15
6.1set 15
6.2hide 15
6.3show 15
Chapter7DocumentLibrary 16
7.1markChanged 16
Chapter8EventHandling 17
8.1activate 18
8.2arrowDown 18
8.3arrowKey 18
8.4arrowLeft 19
8.5arrowRight 19
8.6arrowUp 19
8.7charIn 19
8.8backspaceKey 19
8.9backTabKey 19
8.10clearKey 20
8.11construction 20
8.12contextMenu 20
8.13copy 20
8.14create 20
8.15createMathBox 20
8.16cut 21
8.17deactivate 21
8.18deleteKey 21
8.19destroy 21
8.20enterKey 21
8.21escapeKey 21
8.22getFocus 21
8.23getSymbolList 22
8.24grabDown 22
8.25grabUp 22
8.26help 22
8.27keyboardDown 23
iii
8.28keyboardUp 23
8.29loseFocus 23
8.30mouseDown 23
8.31mouseMove 23
8.32mouseUp 23
8.33paint 24
8.34paste 24
8.35propertiesChanged 24
8.36resize 24
8.37restore 24
8.38returnKey 25
8.39rightMouseDown 25
8.40rightMouseUp 25
8.41save 25
8.42tabKey 26
8.43timer 26
8.44varChange 26
Chapter9Graphics Library 27
9.1clipRect 27
9.2drawArc 27
9.3drawImage 27
9.4drawLine 28
9.5drawPolyLine 28
9.6drawRect 28
9.7drawString 28
9.8fillArc 28
9.9fillPolygon 28
9.10fillRect 29
9.11getStringHeight 29
9.12getStringWidth 29
9.13setColorRGB 29
9.14setFont 29
9.15setPen 29
Chapter10ImageLibrary 30
10.1new 30
10.2copy 30
10.3height 30
10.4rotate 30
10.5width 31
Chapter11LocaleLibrary 32
11.1name 32
Chapter12Math Library Extension 33
12.1eval 33
12.2evalStr 34
12.3getEvalSettings 34
iv
12.4setEvalSettings 35
Chapter13ModuleLibrary 37
Chapter14Platform Library 38
14.1apiLevel 38
14.2hw 38
14.3isColorDisplay 38
14.4isDeviceModeRendering 39
14.5isTabletModeRendering 39
14.6registerErrorHandler 39
14.7window 39
14.7.1heightandwidth 39
14.7.2invalidate 39
14.7.3setBackgroundColor 40
14.7.4setFocus 40
14.7.5getScrollHeight 40
14.7.6setScrollHeight 40
14.7.7displayInvalidatedRectangles 40
14.8withGC 41
14.9getDeviceID 41
Chapter15String Library Extension 42
15.1split 42
15.2uchar 42
15.3usub 42
15.4pack 42
15.5unpack 43
Chapter16TimerLibrary 44
16.1getMilliSecCounter 44
16.2start 44
16.3stop 44
Chapter17Tool PaletteLibrary 45
17.1register 45
17.2enable 45
17.3enableCut 46
17.4enableCopy 46
17.5enablePaste 46
Chapter18VariableLibrary 47
18.1list 47
18.2makeNumericList 47
18.3monitor 47
18.4recall 47
18.5recallAt 48
18.6recallStr 48
18.7store 48
v
18.8storeAt 48
18.9unmonitor 48
Chapter19Physics Library 49
19.1Miscellaneousroutines 49
19.1.1INFINITY 49
19.1.2momentForBox 49
19.1.3momentForCircle 49
19.1.4momentForPoly 50
19.1.5momentForSegment 50
19.2Vectors 50
19.2.1Vect 50
19.2.2add 51
19.2.3clamp 51
19.2.4cross 51
19.2.5dist 52
19.2.6distsq 52
19.2.7dot 52
19.2.8eql 52
19.2.9length 53
19.2.10lengthsq 53
19.2.11lerp 53
19.2.12lerpconst 53
19.2.13mult 54
19.2.14near 54
19.2.15neg 54
19.2.16normalize 54
19.2.17normalizeSafe 55
19.2.18perp 55
19.2.19project 55
19.2.20rotate 55
19.2.21rperp 56
19.2.22setx 56
19.2.23sety 56
19.2.24slerp 56
19.2.25slerpconst 57
19.2.26sub 57
19.2.27toangle 57
19.2.28unrotate 58
19.2.29x 58
19.2.30y 58
19.3BoundingBoxes 58
19.3.1BB 58
19.3.2b 59
19.3.3clampVect 59
19.3.4containsBB 59
19.3.5containsVect 59
19.3.6expand 60
19.3.7intersects 60
vi
19.3.8l 60
19.3.9merge 60
19.3.10setb 60
19.3.11r 61
19.3.12setl 61
19.3.13setr 61
19.3.14sett 61
19.3.15t 62
19.3.16wrapVect 62
19.4Bodies 62
19.4.1Body 62
19.4.2activate 62
19.4.3angle 63
19.4.4angVel 63
19.4.5applyForce 63
19.4.6applyImpulse 63
19.4.7data 64
19.4.8force 64
19.4.9isRogue 64
19.4.10isSleeping 64
19.4.11local2World 65
19.4.12kineticEnergy 65
19.4.13mass 65
19.4.14moment 65
19.4.15pos 66
19.4.16resetForces 66
19.4.17rot 66
19.4.18setAngle 66
19.4.19setAngVel 67
19.4.20setData 67
19.4.21setForce 67
19.4.22setMass 67
19.4.23setMoment 68
19.4.24setPos 68
19.4.25setPositionFunc 68
19.4.26setTorque 69
19.4.27setVel 69
19.4.28setVelocityFunc 69
19.4.29setVLimit 70
19.4.30setWLimit 70
19.4.31sleep 70
19.4.32sleepWithGroup 71
19.4.33torque 71
19.4.34updatePosition 71
19.4.35updateVelocity 71
19.4.36vel 72
19.4.37vLimit 72
19.4.38wLimit 72
vii
19.4.39world2Local 72
19.5Shapes 73
19.5.1BB 73
19.5.2body 73
19.5.3collisionType 73
19.5.4data 73
19.5.5friction 74
19.5.6group 74
19.5.7layers 74
19.5.8rawBB 74
19.5.9restitution 75
19.5.10sensor 75
19.5.11setCollisionType 75
19.5.12setData 75
19.5.13setFriction 76
19.5.14setGroup 76
19.5.15setLayers 76
19.5.16setRestitution 76
19.5.17setSensor 77
19.5.18setSurfaceV 77
19.5.19surfaceV 77
19.6CircleShapes 77
19.6.1CircleShape 78
19.6.2offset 78
19.6.3radius 78
19.7PolygonShapes 78
19.7.1PolyShape 78
19.7.2numVerts 79
19.7.3points 79
19.7.4vert 79
19.8SegmentShapes 79
19.8.1SegmentShape 80
19.8.2a 80
19.8.3b 80
19.8.4normal 80
19.8.5radius 81
19.9Spaces 81
19.9.1Space 81
19.9.2addBody 81
19.9.3addConstraint 81
19.9.4addCollisionHandler 82
19.9.5addPostStepCallback 82
19.9.6addShape 83
19.9.7addStaticShape 83
19.9.8damping 83
19.9.9data 83
19.9.10elasticIterations 83
19.9.11gravity 84
viii
19.9.12idleSpeedThreshold 84
19.9.13iterations 84
19.9.14rehashShape 84
19.9.15rehashStatic 85
19.9.16removeBody 85
19.9.17removeConstraint 85
19.9.18removeShape 85
19.9.19removeStaticShape 86
19.9.20resizeActiveHash 86
19.9.21resizeStaticHash 86
19.9.22setDamping 86
19.9.23setData 87
19.9.24setElasticIterations 87
19.9.25setGravity 87
19.9.26setIdleSpeedThreshold 87
19.9.27setIterations 88
19.9.28setSleepTimeThreshold 88
19.9.29sleepTimeThreshold 88
19.9.30step 89
19.10Constraints 89
19.10.1DampedRotarySpring 89
19.10.2DampedSpring 90
19.10.3GearJoint 90
19.10.4GrooveJoint 91
19.10.5PinJoint 91
19.10.6PivotJoint 91
19.10.7RatchetJoint 92
19.10.8RotaryLimitJoint 92
19.10.9SimpleMotor 93
19.10.10SlideJoints 93
19.11ArbitersandCollisionPairs 93
19.11.1# 94
19.11.2a 94
19.11.3b 94
19.11.4bodies 94
19.11.5depth 94
19.11.6elasticity 95
19.11.7friction 95
19.11.8impulse 95
19.11.9isFirstContact 95
19.11.10normal 96
19.11.11point 96
19.11.12setElasticity 96
19.11.13setFriction 96
19.11.14shapes 97
19.11.15totalImpulse 97
19.11.16totalImpulseWithFriction 97
19.12ShapeQueries 97
ix