It is recommended to have read learning how to use emevd before using this reference.

This list is highly incomplete. You can help by expanding it. Also note that this reference does not include the different wordings for commands in MattScript since DarkScript 3 will tell you the alternative usages if you type in the name of a command listed here.

List of Commands

AwardItemLot

AwardItemLot(int itemLotId)

Summary

Causes the player to instantly receive the item lot associated with itemLotId (receiving the item lot may not involve receiving an item if the items in the lot have a random chance of dropping).

AwardItemsIncludingClients

AwardItemsIncludingClients(int itemLotId)

Summary

Causes all players (hosts, phantoms, and invaders) to receive the specified item lot associated with the itemLotId. In order to make certain types of players not receive the item, you will need to end the event early by checking their Character Type with IfCharacterType.

EndUnconditionally

EndUnconditionally(enum<EventEndType> executionEndType)

Summary

Immediately ends the event while passing in an EventEndType instruction that can either completely end the event or restart it. Commonly used to make events that loop whenever they complete.

EzstateInstructionRequest

EzstateInstructionRequest(int entityId, int command, byte slot)

Summary

Makes a certain chrESD command (known as GetCommandIDFromEvent(byte slot) in Zeditor) return the value of the command parameter for the ESD running on the entity with the given enitityId parameter.

HellkiteBreathControl

HellkiteBreathControl(int characterEntityId, int objectEntityId, int characterAnimationId)

Summary

Controls the height and length that the fire breath of the Hellkite drake covers. Essentially it sets the Y-level of where the ground fire appears to be the Y-level of the object with objectEntityId, and modulates the distance of the attack based on the animation used and the distance between the Hellkite and the object. The total amount of vfx spawned by the attack stays the same regardless of distance, making it look more condensed the closer the object is. There is still a smaller hurtbox for the fire breathing attacks that extends from the Hellkite's mouth that isn't effected by this command. Using this command will summon the proper fire breath attack even if the Hellkite isn't attacking, but it seems that it cannot summon the fire from any character other than the Hellkite. These were all impressions I got but I didn't test the command thoroughly enough and didn't have a great understanding of the systems at the time, take with a grain of salt.

IfCharacterHasSpEffect

IfCharacterHasSpEffect((enum<ConditionGroup> resultConditionGroup, int targetEntityId, int spEffectId, bool shouldHave)

Summary

Returns true to resultConditionGroup if the character (player or NPC/enemy) with the targetEntityId has (or if shouldHave = False, doesn't have) the specified Special Effect active on it.

IfEventFlag

IfEventFlag(enum<ConditionGroup> resultConditionGroup, enum<ONOFFCHANGE> desiredFlagState, enum<TargetEventType> targetEventFlagType, int targetEventFlagId)

Summary

Returns true to resultConditionGroup when the event flag state of the flag with ID of targetEventFlagId matches the desiredFlagState.

IfObjectHitBy

IfObjectHitBy(enum<ConditionGroup> resultConditionGroup, int targetEntityId, int attackerEntityId)

Summary

Returns true to resultConditionGroup the moment that the specified object is hit by any form of attack from the specified attacker. Note that the attack can be non-damaging and still cause this command to return true (such as from any kind of roll, or poison mist).

IfPlayerAttackingOnHit

IfPlayerAttackingOnHit(enum<ConditionGroup> resultConditionGroup, int hitboxEntityId)

Summary

Somewhat of a misnomer. Returns true to resultConditionGroup when the player is sprinting while standing on a piece of map collision with the ID of hitboxEntityId. The command only checks one piece of collision with the given hitboxEntityId, so it will fail if you try to give multiple collisions the same entity ID and try to check all of them at once.

IfPlayersCovenant

IfPlayersCovenant(enum<ConditionGroup> resultConditionGroup, byte covenantIndex)

Summary

Returns true to resultConditionGroup if the current covenant of the player matches the index of covenantIndex.

IncrementEventValue

IncrementEventValue(int baseEventFlagId, uint numberOfUsedFlagBits, uint maximumAllowedValue)

Summary

Increments the event value stored in the inclusive flag range of [baseEventFlagId, baseEventFlagId + numberOfUsedFlagBits - 1] by 1. Before the command increments the flag value it will read it and only increment if the value is less than or equal to maximumAllowedValue.

InitializeEvent

InitializeEvent(int eventSlotId, uint eventId, uint parameters)

Summary

Starts the event with the ID specified in eventId. This is required to make any event run. Once the event's completes an EventEndedFlag will be set, which is equal to the eventId + eventSlotId. After you specify the eventId parameter you can then specify several uint parameters to be passed into the event. If the event doesn't use any parameters then 0 should be specified.

IssueShortWarpRequest

IssueShortWarpRequest(int entityId, enum<TargetEntityType> warpType, int warpDestinationEntityId, int dummypolyId)

Summary

Warps a character (including the player) to a given point on the same map the character is already in. Does not specify a collision to copy Draw Groups from, which means that the character could potentially not be drawn when it is warped since they will keep their original draw parent. Very useful as a shorthand to the other Warp commands since you do not need to specify a map collision to copy Draw Groups from or a character to copy from.

PlaySE

PlaySE(int entityId, enum<SoundType> soundType, int soundId)

Summary

Plays a one shot sound effect originating at the location of the entity with entityId. Sounds cannot be played unless they are loaded in to the current map by being in either one of the main or smain .fsb's, or the .fsb that corresponds to the map the sound is playing in.

SetEventFlag

SetEventFlag(int eventFlagId, enum<ONOFF> flagState)

Summary

Changes the ON/OFF state of the specified event flag to flagState.

SetSpEffect

SetSpEffect(int entityId, int spEffectId)

Summary

Instantly tries to apply a Special Effect to an entity specified by the entity ID.

SkipIfConditionGroupStateCompiled

SkipIfConditionGroupStateCompiled(byte numberOfSkippedLines, enum<ConditionState> desiredConditionGroupState, enum<ConditionGroup> targetConditionGroup)

Summary

Skips the specified amount of lines of code in the event if the targetConditionGroup's state matches the desiredConditionGroupState. This version differs from SkipIfConditionGroupStateUncompiled in that it doesn't evaluate the conditions going in to targetConditionGroup, it only checks its current state. The state of a condition group normally gets evaluated ONLY when it is used in a command that includes the MAIN condition group.

SkipIfConditionGroupStateUncompiled

SkipIfConditionGroupStateUncompiled(byte numberOfSkippedLines, enum<ConditionState> desiredConditionGroupState, enum<ConditionGroup> targetConditionGroup)

Summary

Skips the specified amount of lines of code in the event if the targetConditionGroup's state matches the desiredConditionGroupState. This version differs from SkipIfConditionGroupStateCompiled in that it will evaluate the conditions in targetCondition group, similar to when a condition group is being used in a command which includes the MAIN condition group.

SkipUnconditionally

SkipUnconditionally(byte numberOfSkippedLines)

Summary

Skips the specified amount of lines of code in the event.

WaitFixedTimeFrames

WaitFixedTimeFrames(int numberOfFrames)

Summary

Pauses the execution of an event for a set number of frames. Using DSFix to increase the game's framerate does not change the speed in which frames for the event scripts are counted (always 30Hz). DS1R testing needed.

WaitFixedTimeSeconds

WaitFixedTimeSeconds(float numberOfSeconds)

Summary

Pauses the execution of an event for a set number of seconds. You can specify a floating point decimal number as numberOfSeconds inside of an event, but if numberOfSeconds is an event parameter then it must be converted to hex, and then that hex value needs to be represented as an integer. This link is a converter that can help you do that.

WarpPlayer

WarpPlayer(byte areaID, byte blockID, int initialAreaID))

Summary

Allows warping the player between different maps. Initiates a loading screen.
Note: Requires using a "Player" map object as the destination target to function properly.