ArrayHandling.array_contains_ic (CommandHelper 3.3.1-SNAPSHOT API)

java.lang.Object
- com.laytonsmith.core.functions.AbstractFunction
- - com.laytonsmith.core.functions.ArrayHandling.array_contains_ic

All Implemented Interfaces:

Documentation, Function, FunctionBase

Enclosing class:

ArrayHandling
```
public static class ArrayHandling.array_contains_ic
extends AbstractFunction
```

Nested Class Summary
- Nested classes/interfaces inherited from interface com.laytonsmith.core.functions.Function
  Function.CodeBranch

Constructor Summary

Constructors
Constructor and Description

ArrayHandling.array_contains_ic()

Constructors
Constructor and Description
`ArrayHandling.array_contains_ic()`

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`docs()` Returns documentation in a format that is specified by the code type
`ExampleScript[]`	`examples()` Returns an array of example scripts, which are used for documentation purposes.
`Construct`	`exec(Target t, Environment environment, Construct... args)` This function is invoked when the script is run.
`String`	`getName()` The name of this code element
`boolean`	`isRestricted()` Whether or not a function needs to be checked against the permissions file, if there are possible security concerns with a user compiling, or running this function.
`Integer[]`	`numArgs()` The number of arguments this function can accept.
`Boolean`	`runAsync()` Whether or not to run this function asynchronously from the main server thread.
`CHVersion`	`since()` Returns the version number of when this functionality was added.
`Exceptions.ExceptionType[]`	`thrown()` Returns the types of catchable exceptions this function can throw.

Methods inherited from class com.laytonsmith.core.functions.AbstractFunction
allowBraces, appearInDocumentation, execs, getBundledDocs, getBundledDocs, getPermission, optimize, optimizeDynamic, preResolveVariables, profileAt, profileMessage, profileMessageS, shouldProfile, useSpecialExec, varList

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ArrayHandling.array_contains_ic
```
public ArrayHandling.array_contains_ic()
```
- Method Detail
  - getName
```
public String getName()
```
    Description copied from interface: Documentation
    
    The name of this code element
    
    Returns:
  - numArgs
```
public Integer[] numArgs()
```
    Description copied from interface: FunctionBase
    
    The number of arguments this function can accept. Some functions may be able to accept multiple numbers of arguments, so this function returns an array. If you return Integer.MAX_VALUE as one of the items in the array, then any number of arguments may be sent.
    
    Returns:
  - docs
```
public String docs()
```
    Description copied from interface: Documentation
    
    Returns documentation in a format that is specified by the code type
    
    Returns:
    A string with the documentation, or null, which will give a standard message to the user telling them there is no documentation for this function yet.
  - thrown
```
public Exceptions.ExceptionType[] thrown()
```
    Description copied from interface: Function
    
    Returns the types of catchable exceptions this function can throw. (Uncatchable exceptions need not be listed)
    
    Returns:
    An array of the exception enums, or null, if the function throws no catchable exceptions.
  - isRestricted
```
public boolean isRestricted()
```
    Description copied from interface: Function
    
    Whether or not a function needs to be checked against the permissions file, if there are possible security concerns with a user compiling, or running this function. If this function returns true, the permissions file will be checked for commandhelper.func.compile.<function name> upon compilation, and commandhelper.func.use.<function name> upon usage in game. Note that the config script is never barred from compiling any function.
    
    Returns:
  - since
```
public CHVersion since()
```
    Description copied from interface: Documentation
    
    Returns the version number of when this functionality was added. It should follow the format 0.0.0
    
    Returns:
  - runAsync
```
public Boolean runAsync()
```
    Description copied from interface: Function
    
    Whether or not to run this function asynchronously from the main server thread. If you return true, you may NOT have any interaction with the bukkit api, other than bukkit thread safe methods. Returning true WILL run this function in the CH thread, returning false WILL run this function in the main server thread, and returning null will run this function in whatever context the script is currently running in.
    
    Returns:
  - exec
```
public Construct exec(Target t,
             Environment environment,
             Construct... args)
               throws ConfigRuntimeException
```
    Description copied from interface: Function
    
    This function is invoked when the script is run. The line number is provided so that if there is an error, the function can provide a more specific error message for the user. If the function was canceled due to a fatal error in the syntax of the user input or some similar situation, it should throw a ConfigRuntimeException. All parameters sent to the function have already been resolved into an atomic value, so functions do not have to worry about resolving parameters. There is an explicit check made before calling exec to ensure that Construct ... args will only be one of the atomic Constructs. If a code tree is needed instead of a resolved construct, the function should indicate so, and execs will be called instead. If exec is needed, execs should return CVoid.
    
    args - An array of evaluated Constructs
    
    Returns:
    
    Throws:
    
    ConfigRuntimeException
  - examples
```
public ExampleScript[] examples()
                         throws ConfigCompileException
```
    Description copied from interface: Function
    
    Returns an array of example scripts, which are used for documentation purposes.
    
    Specified by:
    
    examples in interface Function
    
    Overrides:
    
    examples in class AbstractFunction
    
    Returns:
    
    Throws:
    
    ConfigCompileException

Class ArrayHandling.array_contains_ic

Nested Class Summary

Nested classes/interfaces inherited from interface com.laytonsmith.core.functions.Function

Constructor Summary

Method Summary

Methods inherited from class com.laytonsmith.core.functions.AbstractFunction

Methods inherited from class java.lang.Object

Constructor Detail

ArrayHandling.array_contains_ic

Method Detail

getName

numArgs

docs

thrown

isRestricted

since

runAsync

exec

examples