MagicCaptainService/Assets/Plugins/DragonLi/Assemblies/EventFlow.xml

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>EventFlow</name>
    </assembly>
    <members>
        <member name="T:DragonLi.EventFlow.EventFlow">
            <summary>
            A event flow
            </summary>
        </member>
        <member name="F:DragonLi.EventFlow.EventFlow.UnitsRouter">
            <summary>
            All event units contain in this flow.
            </summary>
        </member>
        <member name="F:DragonLi.EventFlow.EventFlow.OffSet">
            <summary>
            Offset in editor
            </summary>
        </member>
        <member name="F:DragonLi.EventFlow.EventFlow.Blackboard">
            <summary>
            Data shared across all flow
            </summary>
        </member>
        <member name="F:DragonLi.EventFlow.EventFlow.Running">
            <summary>
            Unit who are currently running
            </summary>
        </member>
        <member name="F:DragonLi.EventFlow.EventFlow.AutoStart">
            <summary>
            Should this event start auto when scene start is called.
            </summary>
        </member>
        <member name="F:DragonLi.EventFlow.EventFlow.StartInSequence">
            <summary>
            Should this event flow use InitSequence(See Core Sequence chapter to know more information)
            </summary>
        </member>
        <member name="F:DragonLi.EventFlow.EventFlow.Sequence">
            <summary>
            If use SequenceInit, which order do you want this event in.
            </summary>
        </member>
        <member name="F:DragonLi.EventFlow.EventFlow.UpdateFrequency">
            <summary>
            Update times per seconds
            </summary>
        </member>
        <member name="P:DragonLi.EventFlow.EventFlow.IsRunning">
            <summary>
            Is event flow currently running ?
            </summary>
        </member>
        <member name="M:DragonLi.EventFlow.EventFlow.Init(System.Object[])">
            <summary>
            Do not call this function. this is just used for framework.
            </summary>
            <param name="_objs"></param>
        </member>
        <member name="M:DragonLi.EventFlow.EventFlow.Begin">
            <summary>
            Reset and begin flow
            </summary>
        </member>
        <member name="M:DragonLi.EventFlow.EventFlow.Resume">
            <summary>
            Resume event flow
            </summary>
        </member>
        <member name="M:DragonLi.EventFlow.EventFlow.Pause">
            <summary>
            Pause event flow
            </summary>
        </member>
        <member name="M:DragonLi.EventFlow.EventFlow.Stop">
            <summary>
            Stop flow
            </summary>
        </member>
        <member name="M:DragonLi.EventFlow.EventFlow.ResetFlow">
            <summary>
            Reset event flow
            </summary>
        </member>
        <member name="M:DragonLi.EventFlow.ConditionUnit.OnCondition">
            <summary>
            This function will be call when selector or other units
            who want the result of this condition.
            </summary>
            <returns>Result of the condition</returns>
        </member>
        <member name="M:DragonLi.EventFlow.TriggerUnit.GetCanMultipleExecution(System.Object)">
            <summary>
            Get parameter
            </summary>
            <param name="can"></param>
        </member>
        <member name="M:DragonLi.EventFlow.TriggerUnit.WillTransit">
            <summary>
            This function will be called every event flow update until return true.
            If you return true, this unit will transit to next units.
            </summary>
            <returns>Should transit to next units ?</returns>
        </member>
        <member name="T:DragonLi.EventFlow.UnitContext">
            <summary>
            Context
            </summary>
        </member>
        <member name="F:DragonLi.EventFlow.UnitContext.Position">
            <summary>
            Rect of the unit
            </summary>
        </member>
        <member name="F:DragonLi.EventFlow.UnitContext.LineCount">
            <summary>
            Content area height
            </summary>
        </member>
        <member name="F:DragonLi.EventFlow.UnitContext.Id">
            <summary>
            Id of this unit
            </summary>
        </member>
        <member name="F:DragonLi.EventFlow.UnitContext.Outs">
            <summary>
            Next units
            </summary>
        </member>
        <member name="F:DragonLi.EventFlow.UnitContext.Ins">
            <summary>
            Prev units
            </summary>
        </member>
        <member name="P:DragonLi.EventFlow.UnitContext.Status">
            <summary>
            The status of this unit
            </summary>
        </member>
        <member name="P:DragonLi.EventFlow.UnitContext.Executed">
            <summary>
            Was this unit be executed ever ?
            </summary>
        </member>
        <member name="P:DragonLi.EventFlow.UnitContext.MultipleExecution">
            <summary>
            Can this unit be executed multiple times ?
            </summary>
        </member>
        <member name="F:DragonLi.EventFlow.UnitContext.VarReferrences">
            <summary>
            All inputs of this unit
            </summary>
        </member>
        <member name="T:DragonLi.EventFlow.Unit">
            <summary>
            This is the base class of all types of unit. And do not inhert this class
            directly, see EventUnit and Condition Unit.
            </summary>
        </member>
        <member name="P:DragonLi.EventFlow.Unit.Context">
            <summary>
            Infomation about this unit
            </summary>
        </member>
        <member name="P:DragonLi.EventFlow.Unit.ContextClassType">
            <summary>
            Get context class type
            </summary>
        </member>
        <member name="M:DragonLi.EventFlow.Unit.Update">
            <summary>
            This function will be called every frame during this unit running.
            </summary>
            <returns>Currently running status of this unit, this will decide whether this unit should run or not.</returns>
        </member>
        <member name="M:DragonLi.EventFlow.Unit.OnEnd">
            <summary>
            On this unit end.
            </summary>
        </member>
        <member name="M:DragonLi.EventFlow.Unit.OnReset">
            <summary>
            On reset this unit
            </summary>
        </member>
        <member name="M:DragonLi.EventFlow.Unit.OnStart">
            <summary>
            On Start to run
            </summary>
        </member>
        <member name="M:DragonLi.EventFlow.Unit.OnInit">
            <summary>
            This function will be called once when this unit was init
            </summary>
        </member>
        <member name="M:DragonLi.EventFlow.Unit.GetUnitType">
            <summary>
            Get type of this unit
            </summary>
            <returns></returns>
        </member>
        <member name="F:DragonLi.EventFlow.ParameterTpyes.Generic">
            <summary>
            This means you must create variety to this parameter
            </summary>
        </member>
        <member name="T:DragonLi.EventFlow.UnitTypes">
            <summary>
            Unit Type
            </summary>
        </member>
        <member name="F:DragonLi.EventFlow.UnitTypes.Invalid">
            <summary>
            Invalid Type
            </summary>
        </member>
        <member name="F:DragonLi.EventFlow.UnitTypes.Event">
            <summary>
            Event unit
            </summary>
        </member>
        <member name="F:DragonLi.EventFlow.UnitTypes.Selector">
            <summary>
            Selector unit
            </summary>
        </member>
        <member name="F:DragonLi.EventFlow.UnitTypes.Condition">
            <summary>
            Condition unit
            </summary>
        </member>
        <member name="F:DragonLi.EventFlow.UnitTypes.Trigger">
            <summary>
            Trigger unit
            </summary>
        </member>
        <member name="F:DragonLi.EventFlow.UnitTypes.Variety">
            <summary>
            Variety unit
            </summary>
        </member>
        <member name="F:DragonLi.EventFlow.UnitTypes.Const">
            <summary>
            Const value unit
            </summary>
        </member>
        <member name="T:DragonLi.EventFlow.UnitRunningStatus">
            <summary>
            The running status of unit
            </summary>
        </member>
        <member name="F:DragonLi.EventFlow.UnitRunningStatus.Error">
            <summary>
            This unit has an error occured
            </summary>
        </member>
        <member name="F:DragonLi.EventFlow.UnitRunningStatus.Running">
            <summary>
            This unit is currently running
            </summary>
        </member>
        <member name="F:DragonLi.EventFlow.UnitRunningStatus.End">
            <summary>
            This unit is end
            </summary>
        </member>
        <member name="T:DragonLi.EventFlow.UnitStatus">
            <summary>
            The status of unit
            </summary>
        </member>
        <member name="F:DragonLi.EventFlow.UnitStatus.Error">
            <summary>
            This unit has an error occured
            </summary>
        </member>
        <member name="F:DragonLi.EventFlow.UnitStatus.Waiting">
            <summary>
            This unit is ready to run, if the event flow reaches this node, the node will run.
            </summary>
        </member>
        <member name="F:DragonLi.EventFlow.UnitStatus.Running">
            <summary>
            This unit is currently running
            </summary>
        </member>
        <member name="F:DragonLi.EventFlow.UnitStatus.End">
            <summary>
            This unit is end
            </summary>
        </member>
    </members>
</doc>