| Package | org.si.sion.effector |
| Class | public class SiEffectModule |
| Inheritance | SiEffectModule  Object |
| Property | Defined By | ||
|---|---|---|---|
| globalEffectCount : int [read-only] Number of global effect | SiEffectModule | ||
| slot0 : Array [write-only] effector slot 0 | SiEffectModule | ||
| slot1 : Array [write-only] effector slot 1 | SiEffectModule | ||
| slot2 : Array [write-only] effector slot 2 | SiEffectModule | ||
| slot3 : Array [write-only] effector slot 3 | SiEffectModule | ||
| slot4 : Array [write-only] effector slot 4 | SiEffectModule | ||
| slot5 : Array [write-only] effector slot 5 | SiEffectModule | ||
| slot6 : Array [write-only] effector slot 6 | SiEffectModule | ||
| slot7 : Array [write-only] effector slot 7 | SiEffectModule | ||
| Method | Defined By | ||
|---|---|---|---|
SiEffectModule(module:SiOPMModule) Constructor. | SiEffectModule | ||
clear(slot:int):void Clear effector slot. | SiEffectModule | ||
connect(slot:int, effector:SiEffectBase):void Connect effector to the global/master slot. | SiEffectModule | ||
deleteLocalEffect(inst:SiEffectStream):void Delete local effector connector | SiEffectModule | ||
getEffectorList(slot:int):Vector.<SiEffectBase> Get effector list of specifyed slot
| SiEffectModule | ||
getInstance(name:String):SiEffectBase [static] Get effector instance by name
| SiEffectModule | ||
initialize():void Initialize all effectors. | SiEffectModule | ||
Create new local effector connector. | SiEffectModule | ||
parseMML(slot:int, mml:String, postfix:String):void Parse MML for global/master effectors
| SiEffectModule | ||
register(name:String, cls:Class):void [static] Register effector class
| SiEffectModule | ||
setEffectorList(slot:int, list:Array):void Set effector list of specifyed slot
| SiEffectModule | ||
| globalEffectCount | property |
globalEffectCount:int [read-only] Number of global effect
public function get globalEffectCount():int| slot0 | property |
slot0:Array [write-only] effector slot 0
public function set slot0(value:Array):void| slot1 | property |
slot1:Array [write-only] effector slot 1
public function set slot1(value:Array):void| slot2 | property |
slot2:Array [write-only] effector slot 2
public function set slot2(value:Array):void| slot3 | property |
slot3:Array [write-only] effector slot 3
public function set slot3(value:Array):void| slot4 | property |
slot4:Array [write-only] effector slot 4
public function set slot4(value:Array):void| slot5 | property |
slot5:Array [write-only] effector slot 5
public function set slot5(value:Array):void| slot6 | property |
slot6:Array [write-only] effector slot 6
public function set slot6(value:Array):void| slot7 | property |
slot7:Array [write-only] effector slot 7
public function set slot7(value:Array):void| SiEffectModule | () | Constructor |
| clear | () | method |
public function clear(slot:int):voidClear effector slot.
Parameters
slot:int — Effector slot number.
|
| connect | () | method |
public function connect(slot:int, effector:SiEffectBase):voidConnect effector to the global/master slot.
Parameters
slot:int — Effector slot number.
| |
effector:SiEffectBase — Effector instance.
|
| deleteLocalEffect | () | method |
public function deleteLocalEffect(inst:SiEffectStream):voidDelete local effector connector
Parameters
inst:SiEffectStream |
| getEffectorList | () | method |
public function getEffectorList(slot:int):Vector.<SiEffectBase>Get effector list of specifyed slot
Parameters
slot:int — Effector slot number.
|
Vector.<SiEffectBase> — Vector of Effector list.
|
| getInstance | () | method |
public static function getInstance(name:String):SiEffectBaseGet effector instance by name
Parameters
name:String — Effector name in mml.
|
SiEffectBase |
| initialize | () | method |
public function initialize():voidInitialize all effectors. This function is called from SiONDriver.play() with the 2nd argment true. When you want to connect effectors by code, you have to call this first, then call connect() and SiONDriver.play() with the 2nd argment false.
| newLocalEffect | () | method |
public function newLocalEffect(depth:int, list:Vector.<SiEffectBase>):SiEffectStreamCreate new local effector connector. deeper effectors executes first.
Parameters
depth:int | |
list:Vector.<SiEffectBase> |
SiEffectStream |
| parseMML | () | method |
public function parseMML(slot:int, mml:String, postfix:String):voidParse MML for global/master effectors
Parameters
slot:int — Effector slot number.
| |
mml:String — MML string.
| |
postfix:String — Postfix string.
|
| register | () | method |
public static function register(name:String, cls:Class):voidRegister effector class
Parameters
name:String — Effector name.
| |
cls:Class — SiEffectBase based class.
|
| setEffectorList | () | method |
public function setEffectorList(slot:int, list:Array):voidSet effector list of specifyed slot
Parameters
slot:int — Effector slot number.
| |
list:Array — Effector list to set
|