Viv JavaScript Runtime - v0.10.2
    Preparing search index...

    Interface RunSiftingPatternArgs

    Arguments parameterizing a request to run a specified sifting pattern.

    These are the effective arguments to runSiftingPattern.

    interface RunSiftingPatternArgs {
        patternName: string;
        precastBindings?: RoleBindings;
        searchDomain?: string;
    }
    Index

    Properties

    patternName precastBindings? searchDomain?

    Properties

    patternName: string

    The name of the sifting pattern to run.

    precastBindings?: RoleBindings

    Partial or complete role bindings to use when running the sifting pattern.

    searchDomain?: string

    The entity ID for a character whose memories will serve as the search domain.

    When this field is present, the sifting pattern is run against the given character's memories, and otherwise the pattern is run against the entire chronicle (meaning all actions that have ever occurred in the simulation instance at hand).

    Settings

    Member Visibility

    On This Page

    Properties