msw-ai-tf/maplestory-worlds-creator-docs huggingface dataset:
TransitionType

Specifies the transition effect for the button. You can specify different effects depending on the state.

# Members

[{"Name":"nan","Value":"0","Desc":"No button transition effect."},{"Name":"ColorTint","Value":"1","Desc":"Changes to the specified color when the button state changes."},{"Name":"SpriteSwap","Value":"2","Desc":"Changes to the specified button image when the button state changes."}]

# Methods

[{"index":"TransitionType CastFrom(number value) (Static)","0":"Converts numbers to the applicable type."}]

[{"index":"TransitionType CastFrom(string value) (Static)","0":"Converts strings to the applicable type."}]
GradientModes

Applies gradation.

# Members

[{"Name":"Single","Value":"0","Desc":"Applies a single color."},{"Name":"Horizontal","Value":"1","Desc":"Applies gradation left to right."},{"Name":"Vertical","Value":"2","Desc":"Applies gradation top to bottom."},{"Name":"FourCorners","Value":"3","Desc":"Applies gradation in all four directions."}]

# Methods

[{"index":"GradientModes CastFrom(number value) (Static)","0":"Converts numbers to the applicable type."}]

[{"index":"GradientModes CastFrom(string value) (Static)","0":"Converts strings to the applicable type."}]
BTNode

The primary node for AI.

# Properties

[{"index":"boolean ExclusiveExecutionWhenRunning (Deprecated)","0":"This property is deprecated."}]

[{"index":"func InitFunction","0":"Initialization calls this function."}]

[{"index":"string Name","0":"The name of the node."}]

[{"index":"AIComponent ParentAI (ReadOnly) (HideFromInspector)","0":"AIComponent to have the node."}]

# Methods

[{"index":"BehaviourTreeStatus Behave(float deltaTime)","0":"Executes the node. The deltaTime refers to the duration between the previous frame and the current frame. Defined in seconds."}]

# SeeAlso

  * AIComponent
OverflowType

Specifies how text outside the horizontal width is handled.

# Members

[{"Name":"Overflow","Value":"0","Desc":"Displays text outside of the horizontal width."},{"Name":"Truncate","Value":"1","Desc":"Displays characters beyond the horizontal width with cropping."},{"Name":"ellipsis","Value":"2","Desc":"Cuts out characters that are beyond the horizontal width. Replaces the cut back part with an ellipsis."}]

# Methods

[{"index":"OverflowType CastFrom(number value) (Static)","0":"Converts numbers to the applicable type."}]

[{"index":"OverflowType CastFrom(string value) (Static)","0":"Converts strings to the applicable type."}]
RigidbodyAttachEvent

The event occurs when the Entity attaches to another Entity using RigidbodyComponent:AttachTo(string, Vector3). Players occur on the client, other entities occur on the server.  
  
This event is triggered by the API below.

  * RigidbodyComponent (Space;Server,Client)



# Properties

[{"index":"Entity AttachedEntity","0":"This is the base entity to which other entities are attached."}]

[{"index":"Vector2 Offset","0":"Sets the offset of the attached entity relative to the AttachedEntity."}]

# Constructors

[{"index":"RigidbodyAttachEvent(Entity attachedEntity = nil, Vector2 offset = nil)","0":"Initializes RigidbodyAttachEvent to the specified value."}]
ScreenTouchHoldEvent

This event occurs while touching the screen or clicking.  
  
This event is triggered by the API below.

  * InputService (Space;Client)



# Properties

[{"index":"int32 TouchId","0":"The identifier that uniquely represents a specific input type. For example, left mouse click is 1. Touch inputs on mobile devices are incremented starting from 1."}]

[{"index":"Vector2 TouchPoint","0":"The screen coordinates where the touch occurred."}]

# Constructors

[{"index":"ScreenTouchHoldEvent(Vector2 touchPoint = Vector2(0, 0), int32 touchId = 1)","0":"Initializes ScreenTouchHoldEvent to the specified value."}]
SpriteAnimPlayerState

Indicates the playback state of the animation.

# Members

[{"Name":"Invalid","Value":"0","Desc":"Invalid state."},{"Name":"Idle","Value":"1","Desc":"Valid state."},{"Name":"Playing","Value":"2","Desc":"Play state."},{"Name":"Paused","Value":"3","Desc":"Stop state."},{"Name":"Disabled","Value":"4","Desc":"Inactivated state."}]

# Methods

[{"index":"SpriteAnimPlayerState CastFrom(number value) (Static)","0":"Converts numbers to the applicable type."}]

[{"index":"SpriteAnimPlayerState CastFrom(string value) (Static)","0":"Converts strings to the applicable type."}]
InputLineType

Specifies how to enter.

# Members

[{"Name":"SingleLine","Value":"0","Desc":"Enter in a single line."},{"Name":"MultiLineSubmit","Value":"1","Desc":"You can enter multiple lines, and it stops when the Enter key is pressed."},{"Name":"MultiLineNewline","Value":"2","Desc":"You can enter multiple lines, and insert line breaks by pressing the Enter key."}]

# Methods

[{"index":"InputLineType CastFrom(number value) (Static)","0":"Converts numbers to the applicable type."}]

[{"index":"InputLineType CastFrom(string value) (Static)","0":"Converts strings to the applicable type."}]
MatchResultType

Displays the win or loss state after a match is over.

# Members

[{"Name":"Unknown","Value":"-1","Desc":"An unknown error has occurred during the inquiry."},{"Name":"Win","Value":"0","Desc":"You won the match."},{"Name":"Loss","Value":"1","Desc":"You lost the match."},{"Name":"Draw","Value":"2","Desc":"The match was a tie."}]

# Methods

[{"index":"MatchResultType CastFrom(number value) (Static)","0":"Converts numbers to the applicable type."}]

[{"index":"MatchResultType CastFrom(string value) (Static)","0":"Converts strings to the applicable type."}]
TweenState

Indicates the current state of the TweenComponent Tweener.

# Members

[{"Name":"Idle","Value":"0","Desc":"Default state."},{"Name":"Playing","Value":"1","Desc":"The tween is running."},{"Name":"Pausing","Value":"2","Desc":"The Tween is paused."},{"Name":"Destroying","Value":"3","Desc":"The tween is either in a destroyed state or about to be destroyed."}]

# Methods

[{"index":"TweenState CastFrom(number value) (Static)","0":"Converts numbers to the applicable type."}]

[{"index":"TweenState CastFrom(string value) (Static)","0":"Converts strings to the applicable type."}]
EntityWorldChangedEvent

This event occurs when changing the world where an entity belongs.  
  
This event is triggered by the API below.

  * MODEntity (Space;Server,Client)



# Properties

[{"index":"Entity NewWorld","0":"The world entity to which the entity now belongs."}]

[{"index":"Entity OldWorld","0":"The world entity to which the entity previously belonged."}]

##### inherited from EntityEventType:

[{"index":"Entity Entity","0":"Entity which made an event occur."}]

# Constructors

[{"index":"EntityWorldChangedEvent(Entity entity = nil, Entity oldWorld = nil, Entity newWorld = nil)","0":"Initializes EntityWorldChangedEvent to the specified value."}]
WorldInstanceInfo

Inquires about the World instance list searched from WorldInstanceService.

# Properties

[{"index":"int32 CurrentUserCount (ReadOnly)","0":"The number of users currently in the World instance."}]

[{"index":"string Id (ReadOnly)","0":"The Id of the World instance."}]

[{"index":"int32 MaxUserCount (ReadOnly)","0":"The maximum number of users that can access World instance."}]

[{"index":"string ShortCode (ReadOnly)","0":"A short string that can be used as a world instance identifier or name. The uniqueness is guaranteed in the same world, but there can be duplicates between multiple worlds."}]

# SeeAlso

  * WorldInstanceService
TweenLinearStopType

Indicates the stop method of TweenLineComponent.

# Members

[{"Name":"Oneway","Value":"0","Desc":"Exit the tween after reaching the destination."},{"Name":"OneRoundTrip","Value":"1","Desc":"After reaching the destination, return to the starting point."},{"Name":"RepeatRoundTrip","Value":"2","Desc":"After reaching the destination, repeat the round trip back to the starting point."}]

# Methods

[{"index":"TweenLinearStopType CastFrom(number value) (Static)","0":"Converts numbers to the applicable type."}]

[{"index":"TweenLinearStopType CastFrom(string value) (Static)","0":"Converts strings to the applicable type."}]
PurchaseLogPages

Looks up the recorded information list searched in LogStorageService by pages. Using the feature is not recommended, since it is a provisional feature.

# Properties

[{"index":"boolean IsLastPage (ReadOnly)","0":"Checks whether the current page is the last page in the search results."}]

# Methods

[{"index":"table GetCurrentPageDatas() (ServerOnly)","0":"Retrieves the list of recorded information of the current page among the search results. Up to 1000 search results per page."}]

[{"index":"void MoveToNextPageAndWait() (ServerOnly) (Yield)","0":"Moves to the next page of search results. Script Executions are suspended during the operation."}]
RigidbodyMovementOptionType

Sets options to apply to the RigidbodyComponent above the foothold.

# Members

[{"Name":"RelativeX","Value":"0","Desc":"Apply inertia on the x axis, not the y axis. If the player moves in the opposite direction of the foothold, speed decreases. If it moves in the same direction, speed increases."},{"Name":"Absolute","Value":"1","Desc":"Constant speed regardless of direction."}]

# Methods

[{"index":"RigidbodyMovementOptionType CastFrom(number value) (Static)","0":"Converts numbers to the applicable type."}]

[{"index":"RigidbodyMovementOptionType CastFrom(string value) (Static)","0":"Converts strings to the applicable type."}]
ScreenTouchReleaseEvent

This event occurs while touching/holding the screen or clicking/holding.  
  
This event is triggered by the API below.

  * InputService (Space;Client)



# Properties

[{"index":"int32 TouchId","0":"The identifier that uniquely represents a specific input type. For example, left mouse click is 1. Touch inputs on mobile devices are incremented starting from 1."}]

[{"index":"Vector2 TouchPoint","0":"The screen coordinates where the touch occurred."}]

# Constructors

[{"index":"ScreenTouchReleaseEvent(Vector2 touchPoint = Vector2(0, 0), int32 touchId = 1)","0":"Initializes ScreenTouchReleaseEvent to the specified value."}]
EntityMapChangedEvent

This event occurs when changing the map the entity belongs to.  
  
This event is triggered by the API below.

  * MODEntity (Space;Server,Client)



# Properties

[{"index":"Entity NewMap","0":"This is the new map entity the entity belongs to."}]

[{"index":"Entity OldMap","0":"This is the previous map entity the entity belonged to."}]

##### inherited from EntityEventType:

[{"index":"Entity Entity","0":"Entity which made an event occur."}]

# Constructors

[{"index":"EntityMapChangedEvent(Entity entity = nil, Entity oldMap = nil, Entity newMap = nil)","0":"Initializes EntityMapChangedEvent to the specified value."}]
ParticleEmitEndEvent

This event is raised by BaseParticleComponent when emission of the particle has been completed.  
  
This event is triggered by the API below.

  * AreaParticleComponent (Space;Server,Client)
  * BasicParticleComponent (Space;Server,Client)
  * SpriteParticleComponent (Space;Server,Client)
  * UIAreaParticleComponent (Space;Client)
  * UIBasicParticleComponent (Space;Client)
  * UISpriteParticleComponent (Space;Client)



# Properties

[{"index":"Entity ParticleEntity (ReadOnly)","0":"The entity affected by the event."}]

# Constructors

[{"index":"ParticleEmitEndEvent()","0":"Initializes ParticleEmitEndEvent to the default value."}]
AxisType

This is the control key type used in JoystickComponent.

# Members

[{"Name":"Axis_4","Value":"0","Desc":"It can be operated in 4 directions. The four directions are up, down, left, and right."},{"Name":"Axis_8","Value":"1","Desc":"It can be operated in 8 directions. The 8 directions are up, down, left, right, and diagonally in 4 directions."}]

# Methods

[{"index":"AxisType CastFrom(number value) (Static)","0":"Converts numbers to the applicable type."}]

[{"index":"AxisType CastFrom(string value) (Static)","0":"Converts strings to the applicable type."}]
ComponentEnabledInHierarchyChangedEvent

An event that triggers when a component's EnableInHierarchy is changed.  
  
This event is triggered by the API below.

  * MODEntity (Space;Server,Client)



# Properties

[{"index":"string ComponentName","0":"The name of a component with a triggered event."}]

[{"index":"boolean EnabledInHierarchy","0":"The component's EnabledInHierarchy value."}]

##### inherited from EntityEventType:

[{"index":"Entity Entity","0":"Entity which made an event occur."}]

# Constructors

[{"index":"ComponentEnabledInHierarchyChangedEvent(Entity entity = nil, boolean enabledInHierarchy = false, string componentName = nil)","0":"Reset ComponentEnabledInHierarchyChangedEvent to a set value."}]
ParticleLoopEvent

If the Loop property is enabled, this event is fired when the particle's emission cycle returns and the emission repeats.  
  
This event is triggered by the API below.

  * AreaParticleComponent (Space;Server,Client)
  * BasicParticleComponent (Space;Server,Client)
  * SpriteParticleComponent (Space;Server,Client)
  * UIAreaParticleComponent (Space;Client)
  * UIBasicParticleComponent (Space;Client)
  * UISpriteParticleComponent (Space;Client)



# Properties

[{"index":"Entity ParticleEntity (ReadOnly)","0":"The Entity affected by the event."}]

# Constructors

[{"index":"ParticleLoopEvent()","0":"Initializes ParticleLoopEvent to the default value."}]
DayOfWeekType

Shows the day of the week.

# Members

[{"Name":"Sunday","Value":"0","Desc":"Sunday"},{"Name":"Monday","Value":"1","Desc":"Monday"},{"Name":"Tuesday","Value":"2","Desc":"Tuesday"},{"Name":"Wednesday","Value":"3","Desc":"Wednesday"},{"Name":"Thursday","Value":"4","Desc":"Thursday"},{"Name":"Friday","Value":"5","Desc":"Friday"},{"Name":"Saturday","Value":"6","Desc":"Saturday"}]

# Methods

[{"index":"DayOfWeekType CastFrom(number value) (Static)","0":"Convert numbers to the applicable type."}]

[{"index":"DayOfWeekType CastFrom(string value) (Static)","0":"Convert strings to the applicable type."}]
Component

The parent component of all Components. Provides basic functions of Components.

# Properties

[{"index":"boolean Enable (Sync)","0":"Checks whether Component is activated or not."}]

[{"index":"boolean EnableInHierarchy (ReadOnly) (HideFromInspector)","0":"Displays whether this Component is Enable in the hierarchy. If Entity Enable is false regardless of Component Enable, returns false."}]

[{"index":"Entity Entity (ReadOnly)","0":"The Entity that owns this component."}]

# Methods

[{"index":"boolean IsClient()","0":"Returns whether the current execution environment is a client or not."}]

[{"index":"boolean IsServer()","0":"Returns whether the current execution environment is a server or not."}]
LeaderboardRankingStrategy

How tie rankings will be set.

# Members

[{"Name":"Unknown","Value":"-1","Desc":"An unknown error has occurred during the inquiry."},{"Name":"FirstHigh","Value":"0","Desc":"If the scores are equal, the user that registered first will have a higher ranking."},{"Name":"LastHigh","Value":"1","Desc":"If the scores are equal, the user that registered later will have a higher ranking."}]

# Methods

[{"index":"LeaderboardRankingStrategy CastFrom(number value) (Static)","0":"Converts numbers to the applicable type."}]

[{"index":"LeaderboardRankingStrategy CastFrom(string value) (Static)","0":"Converts strings to the applicable type."}]
TouchEvent

This event occurs when an entity is touched. The entity must have a TouchReceiveComponent for the event to occur.  
  
This event is triggered by the API below.

  * TouchReceiveComponent (Space;Client)



# Properties

[{"index":"int32 TouchId","0":"The Id that uniquely represents a specific input type. For example, left mouse click is 1. Touch inputs on mobile devices are incremented starting from 1."}]

[{"index":"Vector2 TouchPoint","0":"The screen coordinates where the touch occurred."}]

# Constructors

[{"index":"TouchEvent(Vector2 touchPoint = Vector2(0, 0), int32 touchId = 1)","0":"Initializes TouchEvent to the specified value."}]
Translator

Provides LocaleDataSet inquiry function for translation.

# Properties

[{"index":"string LocaleId (ReadOnly)","0":"This is the language code. Used to find translation strings in the LocaleDataSet created for translation."}]

# Methods

[{"index":"string GetText(string key) (ClientOnly)","0":"Finds and returns the text of the cell whose row name is key and column name is LocaleId in the translation table."}]

[{"index":"string GetTextFormat(string key, any... args) (ClientOnly)","0":"In the translation table, finds the text of the cell whose row name is key and whose column name is LocaleId; and returns the result of filling in the values passed as args according to the format."}]
AnimationClip

This class includes the metadata and Sprite for the animation output of MSW.

# Properties

[{"index":"ReadOnlyList Frames (ReadOnly)","0":"This list contains each frame."}]

[{"index":"float PlayRate (ReadOnly)","0":"Play speed. If it is 1, it is 1x speed."}]

##### inherited from ResourceObject:

[{"index":"boolean IsLoadComplete (ReadOnly)","0":"A flag to check whether the resource has successfully loaded. All resources in MSW can be used only after loading is completed."}]

[{"index":"string RUID (ReadOnly)","0":"The RUID of the resource."}]

[{"index":"ResourceType Type (ReadOnly)","0":"The type of the resource."}]
SliderDirection

The scroll direction of SliderComponent.

# Members

[{"Name":"LeftToRight","Value":"0","Desc":"The scroll bar moves from left to right."},{"Name":"RightToLeft","Value":"1","Desc":"The scroll bar moves from right to left."},{"Name":"BottomToTop","Value":"2","Desc":"The scroll bar moves from bottom to top."},{"Name":"TopToBottom","Value":"3","Desc":"The scroll bar moves from top to bottom."}]

# Methods

[{"index":"SliderDirection CastFrom(number value) (Static)","0":"Converts numbers to the applicable type."}]

[{"index":"SliderDirection CastFrom(string value) (Static)","0":"Converts strings to the applicable type."}]
ScreenRecordMode

It indicates the screen recording method.

# Members

[{"Name":"ScreenOnly","Value":"0","Desc":"Records the screen."},{"Name":"ScreenAndGameAudio","Value":"1","Desc":"Records the screen and world sounds."},{"Name":"ScreenAndMic","Value":"2","Desc":"Records the screen and mic sounds."},{"Name":"ScreenAndGameAudioAndMic","Value":"3","Desc":"Records the screen, world sounds, and mic sounds."}]

# Methods

[{"index":"ScreenRecordMode CastFrom(number value) (Static)","0":"Converts a number to the applicable type."}]

[{"index":"ScreenRecordMode CastFrom(string value) (Static)","0":"Converts strings to the applicable type."}]
PreserveSpriteType

Defines how the image is scaled, sized, and pivoted.

# Members

[{"Name":"nan","Value":"0","Desc":"No retention is set. The size is set according to the RectSize of UITransformComponent."},{"Name":"AspectOnly","Value":"1","Desc":"Resizes and positions the original image while maintaining its proportions."},{"Name":"NativeSize","Value":"2","Desc":"Sets the position using the original image size as it is."}]

# Methods

[{"index":"PreserveSpriteType CastFrom(number value) (Static)","0":"Converts numbers to the applicable type."}]

[{"index":"PreserveSpriteType CastFrom(string value) (Static)","0":"Converts strings to the applicable type."}]
ActionNode

This is the leaf node that executes the AI's actual actions and returns the results.

# Properties

##### inherited from BTNode:

[{"index":"boolean ExclusiveExecutionWhenRunning (Deprecated)","0":"This property is deprecated."}]

[{"index":"func InitFunction","0":"Initialization calls this function."}]

[{"index":"string Name","0":"The name of the node."}]

[{"index":"AIComponent ParentAI (ReadOnly) (HideFromInspector)","0":"AIComponent to have the node."}]

# Methods

##### inherited from BTNode:

[{"index":"BehaviourTreeStatus Behave(float deltaTime)","0":"Executes the node. The deltaTime refers to the duration between the previous frame and the current frame. Defined in seconds."}]
SpriteGUIAnimPlayerStartEvent

This event is raised when starting the sprite animation's playback.  
  
This event is triggered by the API below.

  * SpriteGUIRendererComponent (Space;Client)



# Properties

[{"index":"float ClipPlayRate (ReadOnly)","0":"Clip playback speed."}]

[{"index":"SpriteAnimClipPlayType ClipPlayType (ReadOnly)","0":"How to play a clip."}]

[{"index":"Entity Entity","0":"The entity affected by the event."}]

# Constructors

[{"index":"SpriteGUIAnimPlayerStartEvent(Entity entity = nil, SpriteAnimClipPlayType clipPlayType = SpriteAnimClipPlayType.Onetime, float clipPlayRate = 1)","0":"Initializes SpriteGUIAnimPlayerStartEvent to the specified value."}]
GridLayoutConstraint

The alignment direction of the child UI Entity relative to the parent Entity. You can set if ScrollLayoutGroupComponent is GridType.

# Members

[{"Name":"Flexible","Value":"0","Desc":"Automatically sets the number of rows and columns when sorting child entities."},{"Name":"FixedColumnCount","Value":"1","Desc":"The number of columns is frozen when sorting child entities."},{"Name":"FixedRowCount","Value":"2","Desc":"The number of rows is frozen when sorting child entities."}]

# Methods

[{"index":"GridLayoutConstraint CastFrom(number value) (Static)","0":"Converts numbers to the applicable type."}]

[{"index":"GridLayoutConstraint CastFrom(string value) (Static)","0":"Converts strings to the applicable type."}]
InteractType

Sets the interaction method.

# Members

[{"Name":"KeyDown","Value":"0","Desc":"When pressing a key of the keyboard."},{"Name":"KeyUp","Value":"1","Desc":"When pressing and releasing a keyboard key."},{"Name":"KeyHoldingDuration","Value":"2","Desc":"When pressing the keyboard key over the set HoldingDuration."},{"Name":"KeyUpAfterHoldingDuration","Value":"3","Desc":"When pressing and releasing the keyboard key over the set HoldingDuration."}]

# Methods

[{"index":"InteractType CastFrom(number value) (Static)","0":"Converts numbers to the applicable type."}]

[{"index":"InteractType CastFrom(string value) (Static)","0":"Converts strings to the applicable type."}]
WorldShopProductStatus

Indicates the sales state of the product.

# Members

[{"Name":"Register","Value":"0","Desc":"Product registration in progress."},{"Name":"Ing","Value":"1","Desc":"The product is on sale."},{"Name":"Waiting","Value":"2","Desc":"The product is waiting for sale."},{"Name":"End","Value":"3","Desc":"The product is sold out."},{"Name":"Deleted","Value":"4","Desc":"The product has been deleted."}]

# Methods

[{"index":"WorldShopProductStatus CastFrom(number value) (Static)","0":"Converts numbers to the applicable type."}]

[{"index":"WorldShopProductStatus CastFrom(string value) (Static)","0":"Converts strings to the applicable type."}]
ReadOnlyList<V>

An array of dynamic size. It's possible to access elements with a 1-based index and provide functions to add, remove, and search data. V represents a data type that can be added to an array.

# Properties

[{"index":"number Count (ReadOnly)","0":"Loads the number of elements in the List."}]

# Methods

[{"index":"boolean Contains(V item)","0":"Checks whether the List contains an element."}]

[{"index":"number IndexOf(V item)","0":"Searches for the element from the beginning of the List and returns the index of the first element found. Returns 0 if not found."}]

[{"index":"table ToTable()","0":"Returns a duplicate of the List as a lua table type."}]
SharedVariableKeyInfo

This information is used to identify the shared variable.

# Properties

[{"index":"string ETag","0":"Whenever you update a variable, it only performs an update if it equals the value saved in the database. It prevents simultaneous updates when multiple places are updated at once. An update is performed unconditionally if a nil or empty string is given. When the variable is updated, a new ETag is created."}]

[{"index":"string Name","0":"The variable name."}]

# Constructors

[{"index":"SharedVariableKeyInfo()","0":"Creates SharedVariableKeyInfo by default."}]

[{"index":"SharedVariableKeyInfo(string name, string eTag)","0":"Creates a SharedVariableKeyInfo with the given name, ETag."}]