{"type":"doc","content":[{"type":"expand","attrs":{"title":"Version 9 and Older Versions"},"content":[{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Version 9 (OS 9)","type":"text","marks":[{"type":"link","attrs":{"href":"https://brightsign.atlassian.net/wiki/download/attachments/370674351/BrightScriptReferenceManual_ver9.pdf?version=1&modificationDate=1681926520148&cacheVersion=1&api=v2"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Version 8 (OS 8)","type":"text","marks":[{"type":"link","attrs":{"href":"https://brightsign.atlassian.net/wiki/download/attachments/370674351/BrightScriptReferenceManual%20(ver%208).pdf?version=1&modificationDate=1681851693731&cacheVersion=1&api=v2"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Version 7.1","type":"text","marks":[{"type":"link","attrs":{"href":"https://brightsign.atlassian.net/wiki/download/attachments/370674351/BrightScript%20Reference%20Manual%20(ver%207.1).pdf?version=1&modificationDate=1681851450896&cacheVersion=1&api=v2"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Version 7.0","type":"text","marks":[{"type":"link","attrs":{"href":"https://brightsign.atlassian.net/wiki/download/attachments/370674351/BrightScript%20Reference%20Manual%20(ver%207.0).pdf?version=1&modificationDate=1681851517656&cacheVersion=1&api=v2"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Version 6.2","type":"text","marks":[{"type":"link","attrs":{"href":"https://brightsign.atlassian.net/wiki/download/attachments/370674351/BrightScript%20Reference%20Manual%20(ver%206.2).pdf?version=1&modificationDate=1681851180597&cacheVersion=1&api=v2"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Version 6.1","type":"text","marks":[{"type":"link","attrs":{"href":"https://brightsign.atlassian.net/wiki/download/attachments/370674351/BrightSignReferenceManual_V6.1.pdf?version=1&modificationDate=1681851246728&cacheVersion=1&api=v2"}}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Previous Versions","type":"text","marks":[{"type":"link","attrs":{"href":"https://support.brightsign.biz/hc/en-us/articles/218067797-Legacy-Documentation-and-User-Guides"}}]},{"text":" ","type":"text"}]}]}]}]},{"type":"expand","attrs":{"title":"Table of Contents"},"content":[{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{"indent":{"value":"20px"}},"macroMetadata":{"macroId":{"value":"74774967-8531-4daa-8aea-40c646d14d97"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}},"localId":"c9cdbaad-08b8-45b5-904c-b8148ea72c09"}}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"BrightScript Objects","type":"text"}]},{"type":"paragraph","content":[{"text":"Though BrightScript operates independently of its object architecture and library, they are both required for programming BrightScript applications. The API of a BrightSign platform is exposed to BrightScript as a library objects: Platforms must register a new BrightScript object to expose some part of its API.","type":"text"}]},{"type":"paragraph","content":[{"text":"BrightScript objects are written in C (or a compatible language such as C++), and are robust against version changes: Scripts are generally backwards compatible with objects that have undergone revisions. ","type":"text"}]},{"type":"paragraph","content":[{"text":"BrightScript objects keep a reference count; they delete themselves when the reference count reaches zero.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Wrapper Objects","type":"text"}]},{"type":"paragraph","content":[{"text":"All intrinsic BrightScript types (Boolean, Integer, Float, Double, String, and Invalid) have object equivalents. If one of these intrinsic types is passed to a function that expects an object, the appropriate wrapper object will be created, assigned the correct value, and passed to the function (this is sometimes referred to as \"autoboxing\"): This allows, for example, ","type":"text"},{"text":"roArray ","type":"text","marks":[{"type":"em"}]},{"text":"objects to store values (e.g. integers and strings) as well as objects.","type":"text"}]},{"type":"paragraph","content":[{"text":"Any expression that expects one of the above types will work with the corresponding wrapper object as well: ","type":"text"},{"text":"roBoolean","type":"text","marks":[{"type":"em"}]},{"text":", ","type":"text"},{"text":"roInt","type":"text","marks":[{"type":"em"}]},{"text":", ","type":"text"},{"text":"roFloat","type":"text","marks":[{"type":"em"}]},{"text":", ","type":"text"},{"text":"roDouble","type":"text","marks":[{"type":"em"}]},{"text":", ","type":"text"},{"text":"roString","type":"text","marks":[{"type":"em"}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"The following examples illustrate how wrapper objects work:","type":"text"}]},{"type":"codeBlock","content":[{"text":"Print 5.tostr()+\"th\"\nPrint \"5\".toint()+5\n \n-5.tostr() 'This will cause an error. Instead, use the following:\n(-5).tostr()\n \nif type(5.tostr())<> \"String\" then stop\nif (-5).tostr()<>\"-5\" then stop\nif (1+2).tostr()<>\"3\" then stop\ni=-55\nif i.tostr()<>\"-55\" then stop\nif 100%.tostr()<>\"100\" then stop\nif (-100%).tostr()<>\"-100\" then stop\ny%=10\nif y%.tostr()<>\"10\" then stop\n \nif \"5\".toint()<>5 or type(\"5\".toint())<>\"Integer\" then stop\nif \"5\".tofloat()<>5.0 or type(\"5\".tofloat())<>\"Float\" then stop\nfs=\"-1.1\"\nif fs.tofloat()<>-1.1 or fs.toint()<>-1 then stop\n \nif \"01234567\".left(3)<>\"012\" then stop\nif \"01234567\".right(4)<>\"4567\" then stop\nif \"01234567\".mid(3)<>\"34567\" then stop\nif \"01234567\".mid(3,1)<>\"3\" then stop\nif \"01234567\".instr(\"56\")<>5 then stop\nif \"01234567\".instr(6,\"56\")<>-1 then stop\nif \"01234567\".instr(0,\"0\")<>0 then stop","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Interfaces","type":"text"}]},{"type":"paragraph","content":[{"text":"Interfaces in BrightScript operate similarly to Java or Microsoft COM: An interface is a known set of member functions that implement a set of logic. In some ways, an interface is similar to a virtual base class in C++; any script or program that is compatible with C can use an object interface without regards to the type of object it belongs to: For example, the ","type":"text"},{"text":"roSerialPort ","type":"text","marks":[{"type":"em"}]},{"text":"object, which controls the standard serial interface, implements three interfaces: ","type":"text"},{"text":"ifSerialControl","type":"text","marks":[{"type":"em"}]},{"text":", ","type":"text"},{"text":"ifStreamReceive","type":"text","marks":[{"type":"em"}]},{"text":", and ","type":"text"},{"text":"ifStreamSend","type":"text","marks":[{"type":"em"}]},{"text":". Since the print statement sends its output to any object that has an ","type":"text"},{"text":"ifStreamSend","type":"text","marks":[{"type":"em"}]},{"text":" interface, it works with the ","type":"text"},{"text":"roSerialPort","type":"text","marks":[{"type":"em"}]},{"text":" object, as well as any other object with the ","type":"text"},{"text":"ifStreamSend ","type":"text","marks":[{"type":"em"}]},{"text":"interface.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Statement and Interface Integration","type":"text"}]},{"type":"paragraph","content":[{"text":"Some BrightScript statements have integrated functionality with interfaces. This section describes how to use statements with interfaces.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"PRINT","type":"text"}]},{"type":"paragraph","content":[{"text":"Using the ","type":"text"},{"text":"PRINT","type":"text","marks":[{"type":"code"}]},{"text":" statement in the following format will print into an object that has an ","type":"text"},{"text":"ifStreamSend ","type":"text","marks":[{"type":"em"}]},{"text":"interface, including the ","type":"text"},{"text":"roTextField ","type":"text","marks":[{"type":"em"}]},{"text":"and ","type":"text"},{"text":"roSerialPort ","type":"text","marks":[{"type":"em"}]},{"text":"objects:","type":"text"}]},{"type":"codeBlock","content":[{"text":"port = CreateObject(\"roSerialPort\",0,115200)\nprint port, \"string\"","type":"text"}]},{"type":"paragraph","content":[{"text":"If the expression being printed evaluates to an object with an ","type":"text"},{"text":"ifEnum ","type":"text","marks":[{"type":"em"}]},{"text":"interface, the ","type":"text"},{"text":"PRINT","type":"text","marks":[{"type":"code"}]},{"text":" statement will print every item that can be enumerated.","type":"text"}]},{"type":"paragraph","content":[{"text":"In addition to printing the values of intrinsic types, the ","type":"text"},{"text":"PRINT","type":"text","marks":[{"type":"code"}]},{"text":" statement can also be used to print any object that exposes one of the following interfaces: ","type":"text"},{"text":"ifString","type":"text","marks":[{"type":"em"}]},{"text":", ","type":"text"},{"text":"ifInt","type":"text","marks":[{"type":"em"}]},{"text":", ","type":"text"},{"text":"ifFloat","type":"text","marks":[{"type":"em"}]},{"text":".","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"WAIT","type":"text"}]},{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"WAIT","type":"text","marks":[{"type":"code"}]},{"text":" statement can work in conjunction with any object that has an ","type":"text"},{"text":"ifMessagePort ","type":"text","marks":[{"type":"em"}]},{"text":"interface.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Expression Parsing","type":"text"}]},{"type":"paragraph","content":[{"text":"Any expression that expects a certain type of variable—including Integer, Float, Double, Boolean, or String—can accept an object with an interface equivalent of that type: ","type":"text"},{"text":"ifInt","type":"text","marks":[{"type":"em"}]},{"text":", ","type":"text"},{"text":"ifFloat","type":"text","marks":[{"type":"em"}]},{"text":", ","type":"text"},{"text":"ifDouble","type":"text","marks":[{"type":"em"}]},{"text":", ","type":"text"},{"text":"ifBoolean","type":"text","marks":[{"type":"em"}]},{"text":", ","type":"text"},{"text":"ifString","type":"text","marks":[{"type":"em"}]},{"text":".","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Array Operator","type":"text"}]},{"type":"paragraph","content":[{"text":"The [ ] array operator works with any object that has an ","type":"text"},{"text":"ifArray ","type":"text","marks":[{"type":"em"}]},{"text":"or ","type":"text"},{"text":"ifAssociativeArray","type":"text","marks":[{"type":"em"}]},{"text":" interface, including arrays, associative arrays, and lists.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Member Access Operator","type":"text"}]},{"type":"paragraph","content":[{"text":"The member access operator (i.e. ","type":"text"},{"text":"Dot Operator","type":"text","marks":[{"type":"link","attrs":{"href":"/wiki/spaces/DOC/pages/6525036#Operators-Dot_Operator"}}]},{"text":") works with any object that has an ","type":"text"},{"text":"ifAssociativeArray ","type":"text","marks":[{"type":"em"}]},{"text":"interface. It also works with any object when used to call a member function (i.e. method). It also has special meaning when used on an ","type":"text"},{"text":"roXMLElement ","type":"text","marks":[{"type":"em"}]},{"text":"or ","type":"text"},{"text":"roXMLList ","type":"text","marks":[{"type":"em"}]},{"text":"object.","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]}],"version":1}

Browser not supported