Skip to main content

Interface: PlayerParameter

Metadata for a controller method parameter that receives the player instance associated with the event.

Extends​

Properties​

data?​

optional data: string

Optional extra data for the decorator, such as the payload property key when type is MethodParamType.PARAM.

Inherited from​

BaseParameter.data


defaultValue?​

optional defaultValue: any

Inherited from​

BaseParameter.defaultValue


index​

index: number

The zero-based position of this parameter in the method signature.

Inherited from​

BaseParameter.index


isOptional?​

optional isOptional: boolean

Inherited from​

BaseParameter.isOptional


metatype?​

optional metatype: Function

Inherited from​

BaseParameter.metatype


method?​

optional method: string

Inherited from​

BaseParameter.method


type​

type: PLAYER

The parameter kind: inject the player object.

Overrides​

BaseParameter.type